Skip to main content

Get Customer AR Summary

GET 
/api/customers/:customer/ar-summary

Returns the customer's accounts-receivable summary in one call: outstanding and overdue totals, aging buckets, open credits, net receivable, credit headroom, informational wallet balances, the most recent payment, and the head of the overdue worklist.

Required scope: customers:read

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

All amounts are in the account's base currency (currency).

Response fields:

  • outstanding_total — sum of balance due across the customer's open sales orders.
  • overdue — amount, count, and oldest_due_date of orders past their due date.
  • aging — outstanding amount bucketed by days past due: current (not yet due), d1_30, d31_60, d61_90, d90_plus.
  • open_credits — amount and count of open sales credits with an unallocated balance.
  • net_receivable — outstanding_total minus open_credits.amount. Negative means you owe the customer.
  • credit_limit / available_credit — available_credit is credit_limit minus exposure; both null when no credit limit is set.
  • house_account_balance / store_credit_balance — informational wallet balances. Store credit is a prepaid liability and is never netted into net_receivable.
  • last_payment — date, amount, and id of the most recent payment against the customer's orders (a convenience hint, not an accounting figure); null when the customer has never paid.
  • last_statement_sent_at — when a statement email was last sent to this customer (ISO 8601, or null).
  • overdue_items — up to 5 overdue receivable rows, oldest due date first (same row shape as the receivables list).
  • open_count — number of open receivable rows.
  • payment_terms_days — payment terms used to derive due dates (customer override, else the account default).
  • exposure — outstanding_total minus open_credits.amount: the amount measured against the credit limit.
  • credit_hold — true while the customer is under a manual credit hold; every new unpaid order is held in Reserved until released.
  • payment_term — id and name of the customer's default payment term for sales orders, or null when the customer has none.
  • credit_enforcement_mode — how credit limits are enforced for new orders: off, warn, or hold.

Due dates are derived as order date + payment terms.

Authentication: Requires Bearer token (PAT). Requires permissions customers.show and sales_orders.index, and a token with the orders scope.

Request​

Responses​

OK

Response Headers
    Content-Type