Skip to main content

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.

Required scope: accounting:write

Grant 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​

OK

Response Headers
    Content-Type