Read Accounting Book Balance
POST/api/cash-buying/position/read
Read the book balance of the selected bank accounts (and the mapped credit-line accounts) from the connected QuickBooks Online or Xero trial balance as of today (the tenant's local day). Returns an UNCONFIRMED snapshot: it is not used until confirmed, and nothing is refreshed automatically. This is the book balance, not the live bank balance — items still awaiting review in the accounting system are not included.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Every bank account is listed in account_breakdown (kind bank) with included telling whether it counts. Every liability account except accounts payable is listed too (kind credit_line): the ones mapped in credit_line_account_ids have included true and set credit_line_drawn; the others are included false, listed so they can be picked as the credit line. Overdrawn accounts count as negative cash. A book kept in another currency (book_currency setting) is converted at that day's rate, shown as fx_rate.
On failure (no connection, provider unreachable, provider error, no exchange rate) the response is 422 with the last confirmed position, which stays in force.
Permissions: cash_buying.sync AND accounting.index. Token scope: accounting:write.
Balance fields: without cash_buying.view_balances the returned snapshot (and last_confirmed on a 422) omits cash_on_hand, credit_line_drawn and account_breakdown.
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
Response Headers
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.