Skip to main content
POST
Write off an active advance's remainder

Description

Write off advance active → written_off. Only active advances can be written off. If outstandingUsd is greater than zero, posts a write-off ledger entry for the remainder, then zeroes outstandingUsd and stamps writtenOffAt/writtenOffUsd. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Body

application/json
reason
string

Recorded on the write-off ledger entry. Defaults to "manual write-off" when omitted.

Response

Advance written off — remainder posted to the ledger.

Every /advance JSON response wraps its payload in { status, message, data }.

status
enum<string>
Available options:
success,
error
message
string
data
object