One account's actual and projected daily balance with threshold facts
const url = 'https://api.tovarifinancial.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/balance-projection';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.tovarifinancial.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/balance-projection \ --header 'Authorization: Bearer <token>'READ-ONLY (KAN-3658): no idempotency key. One account, any type. The ACTUAL line is the reconstructed end-of-day working balance from windowStartIso to today; the PROJECTED line runs from today to today + 30 and IS the GET /bills/scheduled?includeMirrors=true ledger walk for this account — so its line includes the bills scheduled into it from another account: a card’s or loan’s payments (KAN-3670), a savings or checking account’s incoming transfers (KAN-3683) (skipped and pending-matched occurrences step by zero; ambiguous and payment-found ones still step), so it equals the Balance column at every occurrence date: an overdue, due-today or moved-into-the-past occurrence steps on today + 1, one moved past the horizon on the horizon. At most 400 points: every day from dailyFromIso (max(windowStartIso, today - 89)) to the horizon, and before it one END-OF-DAY point every sampleStrideDays days plus windowStartIso itself. Liabilities (credit card, loan) stay signed negative everywhere. projectionStatus: ok; snapshot_sourced (a Plaid-linked investment account valued by snapshots — every projectedCents and thresholds is null); account_closed (points [] and thresholds null). A missing or another org’s account is the identical 404.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Account id
Query Parameters
Section titled “Query Parameters”Calendar date, ‘YYYY-MM-DD’
Optional window start ‘YYYY-MM-DD’ (the View period start). Absent means the account’s existence start; an earlier date is clamped up to it (echoed as windowStartIso). Malformed or after today is a 400 on start with a fixed message that never echoes the value.
Responses
Section titled “Responses”Balance projection
object
object
True for credit_card and loan.
The credit limit, or null when none is set (NULL or 0).
Calendar date, ‘YYYY-MM-DD’
Calendar date, ‘YYYY-MM-DD’
Today + 30 — fixed, not a request parameter.
Calendar date, ‘YYYY-MM-DD’
Days between sampled points before dailyFromIso; null when fully daily.
The projection seed — equal to GET /bills/scheduled?accountId workingBalanceCents.
object
Calendar date, ‘YYYY-MM-DD’
The month of dateIso, ‘YYYY-MM’.
True on today’s point ONLY — the actual/projected boundary.
The reconstructed END-OF-DAY working balance; non-null for every date <= today. It may differ from the register’s tiered posted Balance column on days with uncleared rows (KAN-584), and from today’s projected point when future-dated rows exist. Liabilities are signed negative.
The Scheduled ledger walk; non-null for every date >= today when projectionStatus is ok, else null. Equals the Balance column of GET /bills/scheduled?accountId at every date carrying an occurrence.
object
The minimum; the EARLIEST day on a tie.
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
The first day (today included) below zero, or null.
object
The most-negative point (signed negative), or null when the line never owes.
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
The first day the balance is strictly below -creditLimitCents; null with no limit.
The first day after today the balance reaches zero or above — only when today’s balance is below zero.
Example
{ "data": { "accountType": "checking", "balanceSource": "ledger", "projectionStatus": "ok", "thresholds": { "kind": "asset" } }}Validation failed — see errorCode / fieldErrors
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Missing, invalid, or expired bearer token
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.
object
Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.
object
Active policy versions the user has not yet accepted.
object
True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.
Example
{ "errorCode": "EMAIL_NOT_VERIFIED"}Resource not found or not owned by the caller org
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Internal error (no internal detail leaked)
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}