Skip to main content

Get Customer Statement

GET 
/api/customers/:customer/statement

Returns the customer's statement of account as JSON, in one of two views selected by type:

  • open_item (default) — every open sales order plus open sales credits with an unallocated balance, and a totals block (open, credits, net_receivable). as_at optionally limits the statement to documents dated on or before that date (balances remain current values).
  • activity — a chronological ledger for the from/to window (both required for this view): an opening balance carried from before the period, then every receivable-affecting event with a running balance — orders (debits), payments (credits), refunds (debits), and issued sales credits (credits) — satisfying opening + debits - credits = closing. Line type is one of order, payment, refund, credit_issued; each line links its source document via link.entity (sales_order or sales_credit) and link.id.

All amounts are in the account's base currency; foreign-currency documents are converted at each order's snapshot exchange rate. Both views also include the customer header, the aging buckets, and the account's configured payment_instructions.

Use the export endpoint for a PDF or CSV download of the same statement.

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