Skip to main content

Update Storefront Payout Mapping Group

PUT 

/api/storefront/payout-mappings/groups/:storefrontPayoutMappingGroup

Renames a group or changes its document type. The unposted payouts with lines in the group are rebuilt; skipped_posted_count is the number of posted payouts the change makes out of date (flagged for review, not rebuilt).

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 (both optional):

  • name (string, max 255).
  • document_type: invoice or bill.

Returns 404 when the group does not exist.

Request​

Responses​

OK

Response Headers
    Content-Type