Capture Provider Trial Balances
POST/api/ledger/close/periods/:period/capture-provider-balances
Capture the accounting provider's trial balance as of the period end (period key format YYYY-MM), for every connected accounting integration. This is the one metered provider pull behind the Trial Balance Reconciliation report and the trial_balance_reconciled close check — both read only the cached snapshot this produces. Synchronous: one trial-balance call per connection; connections whose provider exposes no trial-balance report are skipped, not failed. Re-running re-captures in place so provider-side edits are picked up.
Authentication: Bearer token. Requires the accounting sync permission.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.