List Customer AR Communications
GET/api/customers/:customer/ar-communications
Paginated log of outbound receivables emails sent to this customer, newest first. Entries are created by the send-statement and request-payment actions (both the account-level actions here and the per-order request-payment action in the Orders collection).
Entry fields: type (statement or payment_request), scope (account, or order with sales_order_id / sales_order_number set), statement_type (open_item or activity for statement sends, null otherwise), params (send parameters and amounts captured at send time, e.g. total_due, amount_due, days_overdue, as_at, attach_statement, attach_invoice), recipient, subject, sent_by / sender_name (the user who sent it), and created_at.
Pagination: page (default 1) and per_page (default 10).
Authentication: Requires Bearer token (PAT). Requires permissions customers.show and sales_orders.index, and a token with the orders scope.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
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.
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.