FTOS_CB_ApproveContractPaymentHoliday

Changes the business status of a record from the FTOS_RequestContractEvent entity representing a contract payment holiday event to Approved.

Syntax

The FTOS_CB_ApproveContractPaymentHoliday 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_ApproveContractPaymentHoliday",
        "Data": "{ \"ContractPaymentHoliday\": { \"contractNo\":\"<contract_number>\",\"eventDate\":\"<yyyy-mm-dd>\",\"gracePeriod\":<grace_period>,\"graceTypeId\":\"<grace_type>\",\"decreaseInstallment\":<decrease_installment>,\"eventNo\":\"<event_number>\",\"eventReason\":\"<event_reason>\",\"holidayFee\":<holiday_fee_value>} }"
    },
    "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\".
contractNo	Mandatory if `contractId` is not filled. The number of the contract.
contractId	Mandatory if `contractNo` is not filled. The identifier of the contract.
eventDate	Mandatory. The date of the contract payment holiday event.
gracePeriod	Mandatory. The number of grace periods requested by the event.
graceTypeId	Mandatory. The type of grace periods requested by the event. Check the Dependencies page for possible values.
decreaseInstallment	The number of periods that will decrease the installments number.
eventNo	Mandatory only for update operations. The number of the payment holiday event.
eventReason	Mandatory. Check the Dependencies page for possible values.
holidayFee	The payment holiday fee value.

Response

The response indicates the result of the code execution, specifically the result of approving a contract event.

Example

Approving a Contract Payment Holiday Event

To approve a contract payment holiday event, 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_ApproveContractPaymentHoliday",
        "Data": "{ \"ContractPaymentHoliday\": { \"contractNo\":\"2766 TL_EUR\",\"eventDate\":\"2021-07-05\",\"gracePeriod\":1,\"graceTypeId\":\"Both\",\"decreaseInstallment\":1,\"eventNo\":\"ECB 1826\",\"eventReason\":\"activitySuspended\",\"holidayFee\":150.00} }"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"5b445502-f776-4e11-8b9b-8562b23b01aa"
    }
}

Response

Copy

{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": true,
        "Data": "{
  "Records": [
    {
      "success": "ok",
      "bankAccountRecoverDebtId": "c6739fd0-7688-4917-9b9d-d3efe9053ab1",
      "paymentId": "b4c8a365-63ef-48a6-af74-976ea3d9244e",
      "newPayment_BusinessStatus": "Allocated",
      "newBankAccountRecoverDebt_BusinessStatus": "Processed"
    }
  ],
  "ReturnValue": 0
}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}