Capture Provider Inventory Balances
POST/api/ledger/reconciliation/inventory/capture-provider
Capture the provider's GL balance for the earmarked inventory accounts as-of a day onto the daily series — the metered counterpart to the (free) SKU-side rebuild. Makes one live Xero Trial Balance call (needs accounting.reports.read), so callers drive the cadence; the provider series is intentionally sparse (only captured days get a row). Days/accounts with no matching provider account are skipped.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token + accounting.sync permission.
Request body:
connection_id(integer, required): accounting connection id.to(date, optional): as-of day for the Trial Balance. Defaults to now.
Returns { captured: <number of accounts written> }.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Content
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.