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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authenticate with a Personal Access Token (PAT).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.