FTOS_BP_GetCommissionListDetail

Returns the details of a specific commission list based on its name or id.

Syntax

The FTOS_BP_GetCommissionListDetail custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy

POST <host_address>/ftosapi/automation-processors/actions/FTOS_BP_GetCommissionListDetail
Content-Type: application/json
            
{
  "commissionListName": "<name_of_commission_list>",
  "commissionListId": "<id_of_commission_list>"
}

Here's a list of the available parameters:

Parameter	Description
host_address	URL of the FintechOS Platform server.
commissionListName	Mandatory when `commissionListId` is not sent, string. The name of the commission list.
commissionListId	Mandatory when `commissionListName` is not sent, string. The id of the commission list.

Response

The response is an object with details about all the commissions in the commission list from the FTOS_BP_Commission and FTOS_BP_CommissionValue entities. If use Banking Formula is selected, then commission value or commission percent is equal to the formula result.

Example

Getting a Commission List's Details Based on its Name

To view the details of a specific commission list, send the following request, changing the name of the commission list with the one you need.

Request

Copy

POST https://your_FintechOS_server/ftosapi/automation-processors/actions/FTOS_BP_GetCommissionListDetail
Content-Type: application/json
            
{
  "commissionListName": "CommList"
 }

Response

Copy

{
    "CommissionListName": "CommList",
    "Commisions": [
        {
            "CommissionName": "CommT",
            "CommissionType": "Administration Fee",
            "Currency": "Euro",
            "PeriodicityType": "Monthly",
            "CommissionStatus": "Active",
            "IsForUnusage": false,
            "ValueIsPercent": false,
            "PercentAppliesTo": null,
            "IncludedInRepaymentSchedule": true,
            "AutomaticLoadOnContract": false,
            "MandatoryForApplicant": false,
            "MandatoryForDebtor": false,
            "UseBankingFormula": false,
            "FormulaType": null,
            "IsForContractVersion": false,
            "CommissionValueStatus": "Active",
            "ValidFrom": "2022-02-04",
            "ValidTo": "2022-02-11",
            "CommissionPercent": null,
            "CommissionValue": 3.00
        }
    ]
}

Getting a Commission List's Details Based on its ID

To view the details of a specific commission list, send the following request, changing the id of the commission list with the one you need.

Request

Copy

POST https://your_FintechOS_server/ftosapi/automation-processors/actions/FTOS_BP_GetCommissionListDetail
Content-Type: application/json
            
{
  "commissionListId": "001AB4E4-3A6A-4972-8F77-162746154D88"
}

Response

Copy

{
    "CommissionListName": "CommList",
    "Commisions": [
        {
            "CommissionName": "CommT",
            "CommissionType": "Administration Fee",
            "Currency": "Euro",
            "PeriodicityType": "Monthly",
            "CommissionStatus": "Active",
            "IsForUnusage": false,
            "ValueIsPercent": false,
            "PercentAppliesTo": null,
            "IncludedInRepaymentSchedule": true,
            "AutomaticLoadOnContract": false,
            "MandatoryForApplicant": false,
            "MandatoryForDebtor": false,
            "UseBankingFormula": false,
            "FormulaType": null,
            "IsForContractVersion": false,
            "CommissionValueStatus": "Active",
            "ValidFrom": "2022-02-04",
            "ValidTo": "2022-02-11",
            "CommissionPercent": null,
            "CommissionValue": 3.00
        }
    ]
}