Update Settlement Month-End Split Setting
PUT/api/ledger/settlement-split/settings/:integrationInstance
Switches month-end splitting on or off for a channel store and sets the date it applies from. Settlements dated on or after that date are rebuilt. Settlements already sent to the accounting provider keep the shape they were sent with, so this never voids a provider document.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the accounting.manage_settings permission.
Body:
- enabled (required, boolean).
- from (optional, Y-m-d or null): when omitted while switching on, the first day of next month is used, so months already posted do not move. A date before the first open day (after the lock date) is moved to the first open day.
Response: the saved setting, as in Get Settlement Month-End Split Setting.
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.