FTOS_CB_AddUpdateContractTranche

Adds or updates a record in the FTOS_CB_ContractDisbursementTranche entity representing a contract disbursement tranche. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

The FTOS_CB_AddUpdateContractTranche 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_AddUpdateContractTranche",
        "Data": "{ \"ContractTrancheInfo\": { \"contractNo\":\"<contract_number>\",\"trancheDate\":\"<tranche_date>\",\"trancheAmount\": <tranche_amount>,\"interestPercent\":\"\",\"unusageCommissionPercent\": \"\",\"submittedDocument\":\"\"} }"
    },
    "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\".
contractTrancheIdentifier 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.
trancheDate Mandatory. The date of the disbursement tranche.
trancheAmount Mandatory. The amount of the disbursement tranche.
interestPercent The interest percent.
unusageCommissionPercent The unused amount commission percent.
submittedDocument The submitted document.

Response

The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_CB_ContractDisbursementTranche entity . If the record is created or updated successfully, its contractTrancheIdentifier is returned.

Example

To create a new record, do not fill or send the contractTrancheIdentifier parameter.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractTranche",
        "Data": "{ \"ContractTrancheInfo\": { \"contractNo\":\"2074 FiscoLine\",\"trancheDate\":\"2021-04-30\",\"trancheAmount\": 2000,\"interestPercent\":\"\",\"unusageCommissionPercent\": \"\",\"submittedDocument\":\"\"} }"
    },
    "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": "{\"contractTrancheIdentifier\":\"CT000000008\"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}

To update an existing record, fill and send the contractTrancheIdentifier parameter with the desired value.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractTranche",
        "Data": "{ \"ContractTrancheInfo\": { \"contractTrancheIdentifier\":\"CT000000006\",\"contractID\":\"SomeIntern20\",\"trancheDate\":\"2021-04-27\",\"trancheAmount\": 1000,\"interestPercent\":\"\",\"unusageCommissionPercent\": \"\",\"submittedDocument\":\"\"} }"
    },
    "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": "{\"contractTrancheIdentifier\":\"CT000000006\"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}