Get Granularity Matrix
GET/api/ledger/settings/granularity
Read the type × channel posting granularity matrix stored on the accounting connection (— the Cin7-style settings matrix), consumed by BatchGranularityResolver.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Matrix shape: { "<type>": { "default": "<granularity>", "channels": { "<integration instance id>": "<granularity>" } } } where granularity is one of:
off— the type generates no synced accounting output for the channelper_document— every source document syncs as its own journal entrydaily— documents aggregate into one batch per local daymonthly— documents aggregate into one batch per local month
An empty object means no overrides are stored — legacy per-type defaults apply. Also returns connection_id — the accounting connection the matrix lives on.
Returns 404 when no accounting connection is configured.
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.