FTOS_CB_ImportContractEventRepaymentPlan

Imports a file converted in base64, representing a custom schedule, on a contract event which is not approved yet. It creates records in the FTOS_CB_ContractRepaymentScheduleDisb and FTOS_CB_ContractRepaymentScheduleDisbDet entities.

This endpoint is available starting with Core Banking v3.1.

Syntax

The FTOS_CB_ImportContractEventRepaymentPlan 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_ImportContractEventRepaymentPlan",
        "Data": "{"ContractEventName":"<contract_name>", "File":"<schedule_file_converted_to_base64>"}"
    },
    "ApiInfo":{
        "UserName":"{{auth.username}}",
        "Token":"{{ftos.auth.accessToken}}"
    }
}

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\".
ContractEventName Mandatory. The name of the contract event.
File Mandatory. The file that contains the custom schedule, converted into base64 format.

Response

The response indicates the result of the code execution, specifically the result of uploading the file that contains the custom schedule for a contract event.

Example

To import a file converted in base64, representing a custom schedule, on a contract event which is not approved yet, send the following request, changing the parameter values with your desired values.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_ImportContractEventRepaymentPlan",
        "Data": "{"ContractEventName":"ECB3301", "File":"UEsDBBQABgAIAAAAIQB7ksghegEAAIEFAAATAAgCW0NvbnRpscEr0JjsTiLEG2yFk3ZqAAAAAA3J0ctqEd+hzce1cOxqZpkmbS"}"
    },
    "ApiInfo":{
        "UserName":"{{auth.username}}",
        "Token":"{{ftos.auth.accessToken}}"
    }
}

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": ""File successfully uploaded!"",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}