Write off revolving credit

post https://apim.demo01.my.fivedegrees.cloud/sbx/lending/revolving-credits/{loanId}/write-off

API endpoint to write off a revolving credit

Path Params

loanId

uuid

required

Format - uuid. Loan Identifier

Body Params

WriteOff dto

referenceDate

date

required

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

currencyCode

string

required

length ≥ 1

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

writeOffAmount

double

required

The amount that is written off.

writeOffTypeCode

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.

comment

string | null

A comment (text) can be entered here.

overpaymentWriteOff

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

Accept-version

string

x-request-id

uuid

required

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

Responses

202

Accepted

500

Server Error

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://apim.demo01.my.fivedegrees.cloud/sbx/lending/revolving-credits/loanId/write-off \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "overpaymentWriteOff": true
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Client Error