Skip to main content

Get Settlement

GET 

/api/walmart/:integrationInstance/settlements/:settlement

Returns one settlement with every reconciliation-report line in report order, its readiness checks, the ledger entries it posted (one sales invoice and one fee bill by default) and its deposit status. Returns 404 when the settlement belongs to another store.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.

accounting_readiness lists what holds the settlement back from posting: has_transactions (the report is fully imported), report_balances (its lines add up to the deposit), per_payout_mode_enabled (the store books Walmart sales per settlement), after_accounting_start_date, mappings_configured (every line type has an account, or a fallback account covers it) and currency_conversion_configured. In the list it is a summary (status ready/blocked/done, blockers); in the detail it is the full list of checks.

deposit_status is the accounting provider's view of the settlement's deposit, read from SKU.io's local copy of Xero / QuickBooks (null until the settlement has posted documents). state is one of reconciled, paid, awaiting_deposit_match, not_posted or unavailable; difference is the settlement amount minus what the provider deposited. The same block is available for many settlements at once from GET /api/ledger/settlement-deposits?source_type=walmart_settlement.

Request​

Responses​

OK

Response Headers
    Content-Type