FTOS_CB_UpdateContract_AfterApproval

Updates the contract's information (the direct debit settlement account behavior, turning on or off the automated settlement functionality) after the contract was approved. The update is not performed if the contract has any contract versions in Draft status.

Syntax

The FTOS_CB_UpdateContract_AfterApproval 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_UpdateContract_AfterApproval
Content-Type: application/json
            
{
        "contractNo":"<contract_number>",
        "contractId": "<contract_id>",
        "directDebitSettlementAcc": "<true_or_false>"
}

Here's a list of the available parameters:

Parameter	Description
host_address	URL of the FintechOS Platform server.
contractNo	Mandatory if the value for `contractId` is not specified. The number of the contract.
contractId	Mandatory if the value for `contractNo` is not specified. The internal id of the contract.
contractNo	Mandatory. The number of the contract.

Response

The response indicates the result of the code execution, specifically the result of updating a contract record.

Example

Updating a Contract's Direct Debit Settlement Account After Contract Approval

To update an approved contract's direct debit settlement account's behavior, turning on or off the automated settlement functionality, send the desired contractNo or contractId, following this example:

Request

Copy

POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_CB_UpdateContract_AfterApproval
Content-Type: application/json
            
{
    "contractNo": "8604",
    "contractId": "",
    "directDebitSettlementAcc": true
}

Response

Copy

{
    "ContractIdentifier": {
        "Name": "8604",
        "Id": "d7cdc0ed-a3e5-426e-8356-1338402510ae"
    },
    "IsSuccess": true
}

Errors Messages

Bad Request - directDebitSettlementAcc value must be 'true' or 'false'! - The directDebitSettlementAcc parameter's value is incorrect, it must be either true or false.

Bad Request - contract has draft version. Update is not possible! - The update is not performed because the contract has a contract version in Draft status.