Start free trial

Write off a loan

POST/api/v1/loans/{instrument_id}/write-off

Write off all (default) or part of a loan's balance.

Request Body:

  • principal_cents: Principal to write off (optional; omit for the full remaining balance).
  • write_off_date: Effective date (optional, defaults to today).
  • memo: Optional journal-entry memo.

Effect:

  • Loans we made post to Bad Debt Expense; debt we owe posts to Debt Forgiveness Income.
  • A full write-off also clears accrued unpaid interest and marks the loan written_off.
Operation ID: write_off_loan_api_v1_loans__instrument_id__write_off_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

instrument_idstringrequired

Request body

Schema: LoanWriteOffRequest

write_off_datestring · date
principal_centsinteger

Principal to write off; omit for the full remaining balance.

memostring

Responses

201Successful Response

Schema: SuccessEnvelope_LoanWriteOffResponse_

successboolean
messagestring
codestring
dataLoanWriteOffResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

409Conflict - Resource already exists

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject