FTOS_CB_ApproveReturnedAmountOrGoods
Changes the business status of a contract event record representing a returned amount or goods event to Approved.
Syntax
The FTOS_CB_ApproveReturnedAmountOrGoods custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.
POST <host_address>/ftosapi/automation-processors/actions/
Content-Type: application/json
{
"contractName":"<contract_number>",
"eventName":"<event_number>"
}
Here's a list of the available parameters:
| Parameter | Description |
|---|---|
| host_address | URL of the FintechOS Platform server. |
| contractName | Mandatory. The number of the contract, from the FTOS_CB_Contract entity (attribute: FTOS_CB_ContractId). |
| eventName | Mandatory. The number of the event. |
Response
The response indicates the result of the code execution, specifically the result of approving a contract early repayment event.
Example
To approve a returned amount or goods contract event, send the following request, changing the parameter values with your desired values.
Request
POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_CB_ApproveReturnedAmountOrGoods
Content-Type: application/json
{
"contractName": "6586",
"eventName": "ECB5121"
}
Response
{
"IsSuccess": true,
"EventNo": "ECB5121"
}
Error Responses
-
Bad Request - Contract name is null- the request does not contain a contract number; -
Bad Request - Event name is null- the request does not contain a repayment amount; -
Mismatch between contract and event. Please check that event belongs to specified contract- the request contains aneventIdvalue which does not belong to the contract specified in thecontractNamevalue; -
Event is null or there are multiple events for event name- the request does not contain an event or the system contains more than one event with the same id; -
Contract is null or there are multiple contracts for contract name- the request does not contain a contract or the system contains more than one contracts with the same id.