Skip to main content

Update Global Settlement Mapping Group

PUT 

/api/walmart/settlement-mapping-groups/:settlementMappingGroup

Renames a group or changes its document type. Every settlement that maps lines into the group is re-evaluated for posting.

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: name (required string, max 255), document_type (required: invoice or bill), sort_order (optional integer ≥ 0). Returns 404 for a store-specific group.

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.

Request​

Responses​

OK

Response Headers
    Content-Type