Skip to main content

Get Settlement Month-End Parts

GET 

/api/ledger/settlement-split/parts

Returns the months one settlement posts to: each part's month, the date its documents carry, its line count and net, and the ledger documents it posted.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token and the accounting scope.

Response (under data.settlement_parts):

  • split_enabled: whether the store splits settlements at month end.
  • frozen: true when the settlement is already in the accounting provider, so it keeps the shape it was sent with.
  • floor (Y-m-d or null): lines posted before this day ride its month (the later of the split-from date and the first open day).
  • lines_before_floor: true when some of the settlement's lines are dated before floor (so they post in the floor's month).
  • is_split: true when the settlement posts to more than one month.
  • parts: in month order. key, kind (month_end for earlier months, final for the last), month (Y-m), date (Y-m-d), line_count, net (settlement currency), entries.
  • entries: id, type, document_number, reference, effective_date (Y-m-d), total, synced (in the accounting provider).
  • other_entries: documents that belong to no part (revenue-recognition journals under fulfillment-date revenue).

Request​

Responses​

OK

Response Headers
    Content-Type