FTOS_CB_AddUpdateContractFee

Adds or updates a record in the FTOS_CB_ContractFee entity representing a contract fee, depending on the parameters received from the API call. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

The FTOS_CB_AddUpdateContractFee custom endpoint is called from within the callAction endpoint. Visit the callAction page for more details.

Copy 
POST <host_address>/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractFee",
        "Data": "{\"ContractFeeInfo\" : {\"contractNo\":\"<contract_number>\",\"contractID\": \"\",\"feeName\" : \"<fee_name>\",\"feeValue\" : \"<fee_value>\",\"feePercent\" : \"<fee_percent>\",\"feeDate\" : \"<fee_date>\",}}"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the High Productivity Fintech Infrastructure server.
access_token Access token used to connect to the API endpoint. For details, see GetToken.
user_name The username of an existing user account on the High Productivity Fintech Infrastructure, previously used to get the access token.
Data Key-value pairs of any input parameters to be passed to the internal endpoint in JSON format. Double quotes that enclose string parameter values must be escaped with backslash characters, eg.: \"string value\".
  The id of the contract participant.

To create a new record, do NOT send this parameter. To update an existing record, fill and send this parameter in the ContractParticipantInfo section of the request.
contractNo Mandatory if contractId is not filled. The number of the contract.
contractId Mandatory if contractNo is not filled. The identifier of the contract.
feeName Mandatory. The name of the fee.
Check the Dependencies page for more information.
feeValue Mandatory only when the commission definition is marked as Value commission. The value of the fee.
feePercent Mandatory only when the commission definition is marked as Percentage commission. The percent of the fee.
feeDate Mandatory only when the commission is marked as One Time Payment (the commission's periodicityType = Once). The date of the fee.

Response

The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_CB_ContractFee entity.

Example

To create a new fee for a specified contractNo:

  • send a feeName that does not exist already on the same feeDate for one time payment commissions (commissions with periodicityType = Once);
    OR

  • send a feeName that does not exist already for a commission included in the repayment schedule.

To update an existing fee for a specified contractNo:

  • send a feeName that already exists on the same feeDate for one time payment commissions (commissions with periodicityType = Once);
    OR

  • send a feeName that already exists for a commission included in the repayment schedule.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractFee",
        "Data": "{\"ContractFeeInfo\" : {\"contractNo\":\"2253 TL_EUR\",\"contractID\": \"\",\"feeName\" : \"Corporate Loan Term Front-End Fee EUR\",\"feeValue\" : \"567\",\"feePercent\" : \"5\",\"feeDate\" : \"2021-05-12\",}}"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"e4fa9110-4cd4-46e0-a6bb-86e6de919590"
    }
}

Response

Copy 
{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": false,
        "Data": "{\"contractFee\":true}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}