Get Settlement Month-End Split Setting
GET/api/ledger/settlement-split/settings/:integrationInstance
Returns whether a channel store splits its settlements (payouts) at month end. A split settlement posts one set of documents per calendar month of its lines' posted dates: earlier months on their last day, the settlement's own month on the settlement date. The parts together still add up to the deposit.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the accounting scope.
Fields:
- integration_instance_id: the channel instance.
- enabled: whether its settlements split at month end.
- from (Y-m-d or null): lines posted before this day are not split out; they stay in the settlement's first open month.
- resplit_synced: true only after a confirmed re-split of settlements already in the accounting provider.
- first_open_day: the day after the accounting lock date (null when nothing is locked). The split never starts before it.
- default_from: the date used when the split is switched on without one (the first day of next month, never before first_open_day).
Supported channels: Amazon, Walmart, eBay and TikTok Shop. Other channels return 422.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
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.