List Payout-Channel Order AR Entries
GET/api/ledger/reports/payout-channel-order-ar/:salesChannel/entries
The order invoice and credit entries behind one channel's row of the payout-channel order AR summary, paginated.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (accounting:read scope for tokens).
Filters:
filter[period_state]:open,lockedorpre_settlement(the summary bucket; current entries only).filter[sync_state]:orphaned(withdrawn here, still in the accounting system; the documents the Void action covers),needs_update(a batch invoice / credit whose accounting-system document still includes orders that left the batch, or a consolidated invoice withdrawn in part whose document still includes the lines of orders a payout now books),internal(no accounting-system document) orsynced(a live accounting-system document).filter[search]: matches the sales order number, the channel's own order number (e.g. the Amazon order id), the invoice / credit number and the ledger entry reference or id. Narrow it withsearch_columns(id,ledger_entry_reference,sales_order_number,channel_order_number,document_number) and make columns exact withsearch_strict_columns; the id is always an exact match. At most 255 characters. Without filters it lists every bucketed entry plus every document still in the accounting system.
Sort: sort = entry_id, effective_at, ar_amount or sales_order_number; prefix - for descending. Default -effective_at.
Pagination: page, per_page (default 10, max 200).
Row fields: document_type is sales_invoice, sales_credit or ledger_batch (a batch / summary invoice or credit: document_id is the batch id, and the order and document-number fields are null); update_entry_id is, for a needs_update row, the entry where a sync updates the accounting-system document: the batch's current entry, or the partly withdrawn invoice's own current entry (null otherwise); ar_amount is the entry's net debit on Accounts Receivable (credits are negative); period_state is the bucket (null for a withdrawn document listed only because it is still in the accounting system); period_locked whether the entry's date is in a locked period; document_date is the document's own date (tenant time zone); channel_order_number is the channel's own id of the order (null when the order was not imported from the channel); provider_document_number is the accounting system's number for the document the entry is synced to (null when there is none, or it has not been read back yet) and provider_link is that document's link (label, link_type_label, document_number, link_route to its page in the app when one exists, remote_url to the accounting system). 422 when the channel is not on the summary (its revenue is not booked by payouts, and it has no kept accounting-system documents or earlier payout-mode windows).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Content
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.