Record House Account Payment

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

Record a payment against the customer's house account, reducing the balance owed. Writes a payment 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, > 0) — the payment amount. Error message when not > 0: "The payment amount must be greater than zero."
• notes (string, nullable, max 2000) — internal note.
• reference (string, nullable, max 255) — external reference (e.g. a cheque or payment reference).

Returns 201 with { data: <ledger entry>, balance: <float>, message: "Payment recorded." }.

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.