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.
accounting:readGrant 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
- 200
- 401
- 403
- 404
- 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
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.