List Payments
GET/api/ledger/payments
SKU-side payments (App\Models\Payment) paginated, each with its source document and the linked accounting-provider payment (Xero/QBO) cross-link. Backs the Accounting v2 Payments tab. provider_payment is null when the payment has not been synced to a provider; status is synced / error / not_synced.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authenticate with a Personal Access Token (PAT).
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.