Get Settlement Deposit Status
GET/api/ledger/settlement-deposits
For each channel payout — an Amazon settlement, an eBay payout or a Shopify payout — whether its deposit is paid and reconciled in the connected accounting provider (Xero or QuickBooks). Reads SKU.io's local copy of the provider; it never calls the provider, so it is safe to poll from a scheduled job. Requires the accounting:read scope.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each row is { source_type, source_id, deposit_status }. deposit_status is null when the payout has no posted documents yet.
Fields — the accounting provider's view of this payout's deposit, read from SKU.io's local copy of Xero / QuickBooks (null until the payout has posted documents). state is one of: reconciled (every document paid and every payment reconciled to the bank), paid (every document paid, but reconciliation cannot be confirmed: QuickBooks, or SKU.io only has the payment embedded on the Xero document), awaiting_deposit_match (a document unpaid, paid but not reconciled, or not sent to the provider while the provider's deposit does not cover the payout), not_posted (documents not sent to the provider yet), unavailable (the provider's copy is not downloaded yet). difference is the payout amount minus what the provider deposited; difference_settled is true when the provider reconciled the deposit and the gap is 0.05 or less (currency rounding), difference_needs_review when it reconciled a larger gap. unposted_document_count is how many of the payout's documents (for example an Amazon landed-cost bill) have no current entry synced to the provider; the deposit can still be reconciled when the provider's deposit covers the payout. deposited_amount counts a Xero batch payment at its batch total. deposits lists each bank-side movement (a batch payment or a single payment) with a link to it in the provider.
Request
Responses
- 200
- 401
- 403
- 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.
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.