LendEasy/DocsLMS + Servicing·v1
Start integrating
Guides›Loans›Administrative

Write off a balance

Remove the eligible outstanding balance from receivable accounting with component allocation, reason, period controls, recovery policy, and a dedicated undo command.

A write-off is an accounting and loan-balance action. It removes the loan’s eligible outstanding balance from the receivable under accounting policy. It is not a generic “close bad loan” command.

On screen. Write Off, in the Administrative column of the loan actions menu.

The caller never chooses the ledger accounts

curl -X POST "$BASE/v1/loans/7204/transactions?command=writeoff" \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: demo-lender" \
  -H "LendEasy-Case: case_HBR_LOSS_18" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: hbr-writeoff-2028-01-31" \
  -d '{
    "transactionDate": "2028-01-31",
    "note": "Loss review approved; uncollectible balance.",
    "dateFormat": "yyyy-MM-dd",
    "locale": "en"
  }'
{
  "officeId": 1,
  "clientId": 412,
  "loanId": 7204,
  "resourceId": 30461,
  "changes": {
    "transactionDate": "2028-01-31"
  }
}

Read the posted transaction—GET /v1/loans/7204/transactions/30461—for the written-off portions, and the loan for its resulting status. The caller never chooses the ledger accounts in the request.

Write-off versus charge-off

Charge-off classifies; write-off removes.

Approval and period controls

The flagged command parks, and a different user holding the checker permission decides through GET /v1/makercheckers and POST /v1/makercheckers/{auditId}?command=approve|reject. Every execution—parked or direct—writes a governance record readable at GET /v1/loans/7204/governance-records.

Recovery after write-off

Never post a later recovery as if the write-off did not occur—use recovery payment when applicable.

undowriteoff restores; it does not delete

undowriteoff restores the written-off component amounts and accounting entries, then replays later activity. It requires an open accounting period or an approved correction path and is rejected when dependent transactions make replay unsafe. History retains both commands, their governance records, and their reasons.

Unified search across guides, recipes & the API referenceEsc