Preview Payout Mapping Change
GET/api/ledger/payout-mapping-periods/impact
Previews what saving a payout mapping change from a date would do, before you save it: how many payouts dated on or after that date would be rebuilt with the new mapping, and how many of those already posted to the books. Payouts dated earlier keep the accounts they posted with. Nothing is changed.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the accounting scope.
Query parameters:
- kind (required): the kind of mapping row being changed.
- integration_instance_id (optional): limit the count to one store.
- effective_from (optional, Y-m-d): the date the change would apply from. Defaults to today; must be after the accounting lock date.
Response (under data.payout_mapping_impact):
- effective_from: the date the change would apply from.
- reenqueue_from: the first payout date that would be rebuilt (never inside the locked period), or null for every payout.
- lock_date: the accounting lock date, or null when nothing is locked.
- payouts: how many payouts dated on or after reenqueue_from would be rebuilt.
- posted: how many of those already have accounting entries.
Payout dates: eBay payout date; Shopify accounting date (else payout date); Walmart settlement date; Amazon settlement end date (in the account's timezone).
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.