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.
customers:writeGrant 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 ofadjustment,write_off) — defaults toadjustmentwhen 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." }.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.