FTOS_CB_ApproveWriteOff
Changes the business status of a record from the Contract Event entity representing a contract write-off event to Approved.
This endpoint is available starting with Loan Management v4.1.
Syntax
The FTOS_CB_ApproveWriteOff 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/FTOS_CB_ApproveWriteOff
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, string. The number of the contract from the Contract entity (attribute: FTOS_CB_ContractId). |
| eventName | Mandatory. The number of the write-off event. |
Response
The response indicates the result of the code execution, specifically the result of approving a contract write-off event. If the record is updated successfully, its eventNo is returned.
{
"IsSuccess": <true_or_false>
"EventNo": "<event_number>"
}
Example
To approve a write-off transaction, send the following request, changing the parameter values with your desired values.
Request
POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_CB_ApproveWriteOff
Content-Type: application/json
{
"contractName": "14752",
"eventNo": "ECB11144"
}
Response
{
"IsSuccess": true,
"EventNo": "ECB11144"
}
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 an event number; -
Mismatch between contract and event. Please check that event belongs to specified contract.- the event number within the request doesn't point to the requested contract number; -
Event is null or there are multiple events for event name:- the event number couldn't be identified; -
Contract is null or there are multiple contracts for contract name:- the contract number couldn't be identified.