Skip to main content

Bulk Assign Settlement Type Mappings

PUT 

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

Assigns one account and/or mapping group to many of this store's own type-mapping rows at once (global rows are left alone). The group must be global or this store's.

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: ids (required array of mapping IDs), nominal_code_id (optional, nullable account ID), walmart_settlement_mapping_group_id (optional, 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