Skip to main content

Update Storefront Payout Type Mappings

PUT 

/api/storefront/payout-mappings/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 payouts not yet posted are rebuilt (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:

  • provider (required): stripe.
  • integration_instance_id (required integer).
  • mappings (required array, at least one): each item has id (required mapping ID), nominal_code_id (nullable account ID; null clears it) and storefront_payout_mapping_group_id (nullable group ID; null ungroups it).
  • effective_from (optional, nullable, string, Y-m-d): payouts arriving on or after this date (by arrival 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 payouts arriving on or after effective_from, so payouts already in your books before that date keep the accounts they posted with. GET /api/ledger/payout-mapping-periods (List Payout Mapping Periods, kind storefront_payout_type_mapping or storefront_payout_fallback_setting) returns a row's dated history and scheduled changes, and GET /api/ledger/payout-mapping-periods/impact (Preview Payout Mapping Change) counts the payouts a change would rebuild.

skipped_posted_count in the response is the number of payouts already posted that the change makes out of date; they are flagged for review rather than rebuilt.

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