Skip to main content

Adjust House Account

POST 
/api/customers/:customer/house-account/adjust

Manually adjust or write off the customer's house-account balance. Writes an adjustment or write_off ledger entry and returns it with the account's new balance.

Required scope: customers:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (PAT). Permission: customers.update.

Request body fields:

  • amount (numeric, required, non-zero) — signed for an adjustment (+ increases the balance owed, − decreases it); magnitude for a write-off (always reduces the balance). Error message when 0: "The adjustment amount must be non-zero."
  • type (string, nullable, one of adjustment, write_off) — defaults to adjustment when omitted. Error message on invalid value: "The type must be an adjustment or a write-off."
  • notes (string, nullable, max 2000) — internal note.

Returns 201 with { data: <ledger entry>, balance: <float>, message: "House account adjusted." }.

Requires permission: customers.manage_credit

Writing off or adjusting the balance needs customers.manage_credit on top of customers.update (charges and payments keep needing customers.update only).

Request​

Responses​

Created

Response Headers
    Content-Type