List Payment Requests
GET/api/sales-payment-requests
List payment requests (pro formas): non-posting documents asking a customer to pay an amount before an invoice exists. They never post to the ledger and are never pushed to an accounting provider; money paid against them is recorded on the sales order and applied to invoices as they issue.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires permission sales_payment_requests.index.
Filters: filter[status] (comma-separated: draft, sent, partially_paid, paid, void, superseded), filter[customer_id], filter[sales_order_id], filter[overdue] (1 = open requests past their due date, 0 = everything else), filter[due_date_from] / filter[due_date_to] (Y-m-d), filter[search] (request number, sales order number or customer name).
Allowed sorts: id, number, amount, due_date, created_at, status (prefix with - for descending; default -id). Paginated, 10 per page by default (max 100).
Request
Responses
- 200
- 401
- 403
- 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.
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.