Contract Endpoints

The contract-related custom endpoints allow data manipulation operations on contract records such as creating or updating a contract, contract participants, tranches, covenants, fees, collaterals, disbursements, approval of contracts, tranches, and disbursements, and retrieval of contract repayment schedule.

NOTE
Innovation Studio differentiates between adding and updating a record through the parameter set sent via request data within the API call.

Method	Description
`FTOS_CB_AddUpdateContract`	Adds a new contract record representing a customer's contract. If the `contractNo` is specified or `contractId` already exists in Innovation Studio, the existing record is updated.
`FTOS_CB_ApproveContract`	Changes the business status of a contract record to Approved.
`FTOS_CB_UpdateContractAfterApproval`	Updates the contract's information (the direct debit settlement account behavior, for now) after the contract was approved. The update is not performed if the contract has any contract versions in Draft status. This endpoint is available starting with version 3.3.
`FTOS_CB_NewContractVersion`	Adds a contract record entity representing a new version of an existing contract. If the `contractNo` is specified or `contractId` already exists in Innovation Studio, the existing record is updated. The result returns the recalculated repayment schedule. NOTE You can only create new versions for contracts with the Approved status.
`FTOS_CB_AddUpdateContractParticipant`	Adds a new contract participant record representing a contract participant. If the `contractParticipantIdentifier` is specified, the existing record is updated.
`FTOS_CB_AddUpdateContractTranche`	Adds a new record representing a contract disbursement tranche. If the `contractTrancheIdentifier` is specified, the existing record is updated.
`FTOS_CB_ApproveContractTranche`	Changes the business status of a contract disbursement tranche record to Approved.
`FTOS_CB_AddUpdateContractCovenant`	Adds a new record representing a contract covenant. If the `covenantName` is added for `contractNo`, the existing record is updated.
`FTOS_CB_AddUpdateContractFee`	Adds or updates a record representing a contract fee, depending on the parameters received from the API call.
`FTOS_CB_AddContractGuarantor`	Adds a new record representing a guarantor for a contract.
`FTOS_CB_AddUpdateContractCollateral`	Adds a new record representing a contract collateral. If the `contractNo`, `guarantorNo`, or `collateralRegisterNo` identify a contract collateral, the existing record is updated.
`FTOS_CB_AddContractDisbursement`	Adds a new record representing a contract disbursement event.
`FTOS_CB_ApproveContractDisbursement`	Changes the business status of a contract disbursement event record to Approved.
`FTOS_CB_AddContractTopUp`	Adds a new record representing a contract top-up event.
`FTOS_CB_ApproveContractTopUp`	Changes the business status of a contract top-up event record to Approved.
`FTOS_CB_AddContractWithdraw`	Adds a new record representing a contract withdraw event.
`FTOS_CB_ApproveContractWithdraw`	Changes the business status of a contract withdraw event record to Approved.
`FTOS_CB_AddContractTransfer`	Adds a new record representing a contract transfer event.
`FTOS_CB_ApproveContractTransfer`	Changes the business status of a contract transfer event record to Approved.
`FTOS_CB_AddUpdateContractPaymentHoliday`	Adds a new record representing a payment holiday request event for a contract. If the `eventNo` is specified, the existing record is updated.
`FTOS_CB_ApproveContractPaymentHoliday`	Changes the business status of a payment holiday request event record to Approved.
`FTOS_CB_AddUpdateRescheduleOverdues`	Adds a record representing an event to reschedule a loan contract repayment notification that is overdue. The entire repayment schedule is recalculated considering this event. If the `eventNo` is filled in, the existing record is updated.
`FTOS_CB_ApproveRescheduleOverduesEvent`	Changes the business status of a reschedule overdue event record to Approved.
`FTOS_CB_AddUpdateEarlyRepayment`	Adds a record representing an event for an early repayment of a contract. The entire repayment schedule is recalculated considering this event. If the `eventName` is filled in, the existing record is updated.
`FTOS_CB_ApproveEarlyRepayment`	Changes the business status of an early repayment event record to Approved.
`FTOS_CB_AddUpdateReturnedAmountOrGoods`	Adds a record representing an event for a returned amount or goods for a contract. The entire repayment schedule is recalculated considering this event. If the `eventName` is filled in, the existing record is updated. This endpoint is available starting with version 3.2.
`FTOS_CB_ApproveReturnedAmountOrGoods`	Changes the business status of an event for a returned amount or goods record to Approved. This endpoint is available starting with version 3.2.
`FTOS_CB_UpdateContractDelayCategory_Filtered`	Updates the loan classification based on the contract's days past due (DPD) number, thus changing the contract's delay category, by updating a contract classification record. This endpoint can be run after the last due amount for the contract was paid, instead of waiting for the `End Of Day` and `Start Of Day` scheduled jobs.
`FTOS_CB_ImportContractRepaymentPlan`	Imports a file converted in `base64`, representing a custom schedule, on a contract which is not approved or closed yet. It creates contract repayment schedule and contract repayment schedule detail records. This endpoint is available starting with Core Banking v3.1.
`FTOS_CB_ImportContractEventRepaymentPlan`	Imports a file converted in `base64`, representing a custom schedule, on a contract event which is not approved yet. It creates contract repayment schedule disbursement and contract repayment schedule disbursement detail records. This endpoint is available starting with Core Banking v3.1.
`FTOS_CB_AddUpdateContractDocument`	Adds or updates a contract document record, depending on the parameters received from the API call. This endpoint is available starting with Core Banking v3.2.
`FTOS_CB_ApproveContractDocument`	Changes the business status of a contract document record to Signed. This endpoint is available starting with Core Banking v3.2.