Skip to main content

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.

Required scope: accounting:read

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

OK

Response Headers
    Content-Type