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 Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy 
POST <host_address>/ftosapi/automation-processors/actions/FTOS_CB_AddContractDisbursement
Content-Type: application/json

{
    "contractNo": "<contract_number>",
    "contractID": "<contract_id>",
    "eventValue": <disbursement_event_value>,
    "externalIdentifier": "<external_identifier_of_the_transaction>"
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the FintechOS Platform server.
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.

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/ftosapi/automation-processors/actions/FTOS_CB_AddContractDisbursement
Content-Type: application/json
            
{
    "contractNo": "8640",
    "contractID": "",
    "eventValue": 1000.00,
    "externalIdentifier": ""
}

Response

Copy 
{
    "IsSuccess": true,
    "ContractDisbursementIdentifier": "ECB6990"
}