Skip to main content

Update Settlement Type Mappings

PUT 

/api/walmart/:integrationInstance/settlement-type-mappings

Sets the account and/or mapping group of one or more line types. Only global rows and this store's own rows can be changed; a global row may only use a global group. Affected settlements are re-evaluated for posting (every store's, when a global row changed).

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: mappings (required array): each item has id (required mapping ID), nominal_code_id (nullable account ID) and walmart_settlement_mapping_group_id (nullable group ID). effective_from (optional, nullable, Y-m-d): settlements dated on or after this date use the change 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 this change did NOT re-generate because they had already posted and their lines carry a changed 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.

An account that posts to a Xero system account (for example Xero's built-in Sales Tax / GST account) is rejected with a 422 while Xero is your connected accounting provider, because Xero refuses lines coded to system accounts.

Request​

Responses​

OK

Response Headers
    Content-Type