API Documentation

Write off regular loan

post
https://apim.demo01.my.fivedegrees.cloud/lending/regular-loans//write-off

API endpoint to write off a regular loan

Path Params
uuid
required

Format - uuid. Loan Identifier

Body Params

WriteOff dto

Model for WriteOff endpoints.

date
required

Date when the loan is written off. A write-off date should be after the last payment and on or before today.

string
required
length ≥ 1

Currency of the disbursement. In the reference data endpoint 'currency' a user can get the full list of available values.

double
required

The amount that is written off.

string
required
length ≥ 1

Write-off type code. In the loan configuration endpoint 'write-off-types' a user can get the full list of available values.

string | null

A comment (text) can be entered here.

boolean
required

Indication whether this write-off is a normal write-off on a loan, or for an overpayment. If set to true, then it will result in a negative write-off up of the amount specified (cannot exceed overpaid amount on the loan).

Headers
string
uuid
required

Format - uuid. Correlates HTTP requests between a client and server

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?