Skip to main content

Update Settlement Finance Settings

PUT 

/api/walmart/:integrationInstance/settlement-finance-settings

Changes how the store books Walmart sales. Omitted fields are left unchanged. Changing the mode or the start date re-evaluates every settlement and every per-order invoice and credit of the store; documents already sent to the accounting provider are not voided.

Required scope: accounting:write

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

Authentication: Requires Bearer token and the integrations.update permission. Open to API tokens with the accounting:write scope.

Body (all optional): accounting_sync_mode (per_order or per_payout), payout_accounting_start_date (nullable date, Y-m-d), fallback_revenue_nominal_code_id (nullable account ID), fallback_expense_nominal_code_id (nullable account ID), invoiced_order_payout_nominal_code_id (nullable account ID: where the sale and refund lines of orders already booked by their own invoices post instead of revenue; null = they post as mapped). effective_from (optional, nullable, Y-m-d): settlements dated on or after this date use the new fallback accounts and are rebuilt; earlier ones keep the accounts they posted with. Defaults to today. Must be after the accounting lock date.

Mapping changes are dated. Each change applies to settlements dated on or after effective_from, so settlements already in your books before that date keep their accounts. GET /api/ledger/payout-mapping-periods (List Payout Mapping Periods) returns a row's dated history and scheduled changes, and GET /api/ledger/payout-mapping-periods/impact (Preview Payout Mapping Change) counts the settlements a date would rebuild before you save.

skipped_posted_count: how many settlements a fallback-account change did NOT re-generate because they had already posted and carry an unmapped financial code (re-running them would reverse and replace documents already in the accounting provider). Each one is flagged in the ledger's Needs Attention inbox: "Mapping changed after this settlement posted — use Rebuild to restate it." 0 when nothing was skipped.

Request​

Responses​

OK

Response Headers
    Content-Type