FTOS_CB_AddContractDisbursement

Adds a new record to the FTOS_CB_ContractEvent entity representing a contract disbursement event.

Syntax

The FTOS_CB_AddContractDisbursement 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_AddContractDisbursement",
        "Data": "{ "ContractDisbursement": { "contractNo":"<contract_number>","contractID":null,"eventValue":<disbursement_event_value>},"externalIdentifier":"<the_external_identifier_of_the_transaction>" }"
    },
    "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\".
contractNo Mandatory if contractId is not filled. The number of the contract.
contractId Mandatory if contractNo is not filled. The identifier of the contract.
eventValue Mandatory. The value of the disbursement event.
externalIdentifier Optional, string. The external identifier of the transaction. This parameter is available starting with version 3.2.

Response

The response indicates the result of the code execution, specifically the result of creating a record in the FTOS_CB_ContractEvent entity . If the record is created successfully, its ContractDisbursementIdentifier is returned.

Example

To create a new record, fill the eventValue parameter and one of the contractNo or contractId parameters.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddContractDisbursement",
        "Data": "{ "ContractDisbursement": { "contractNo":"2252 TL_EUR","contractID":null,"eventValue":900.00,"externalIdentifier":"TR99990077663"} }"
    },
    "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": "{\"ContractDisbursementIdentifier\":\"ECB 1436\"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}