Reconciliation Report
GET/api/ledger/reconciliation/report
The period-comparison report for a connection over the (optional) document-date window: monthly SKU-ledger totals vs the provider-mirror, with per-period and grand-total variance highlighting. Read entirely off the local provider document cache — no provider API calls.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Shape: data.rows[] is one row per calendar month with activity, most-recent first. Each row carries sku_entry_count / sku_total_debit / sku_total_credit (the matched + SKU-only entries), provider_document_count / provider_total (the matched remotes + provider-only documents), and the deltas count_variance (sku − provider count) and amount_variance (sku debit − provider total, 4dp). has_variance is true when the counts differ or the amount delta exceeds the configured tolerance (ledger.sync.dedup.amount_tolerance, default 0.01).
data.summary rolls the same fields up across every period (period_count, periods_with_variance). data.currency is the dominant currency or null when the window is empty. from/to (Y-m-d) override the default window. 404 when connection_id is not a supported accounting connection.
Request
Responses
- 200
- 401
- 403
- 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.
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.