Dashboard balance projection + upcoming bills
const url = 'https://api.tovarifinancial.com/bills/projection?accountScope=all';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/bills/projection?accountScope=all' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Narrows the SERIES ONLY (net-worth base, day-net history, account openings, and the bill occurrences that step the projected line). Absent or empty => ‘all’, which is byte-identical to the unscoped response. ‘checking’ / ‘savings’ / ‘investment’ narrow by account type; ‘safe_to_spend’ narrows to the Safe-to-Spend POOL — the accounts matching is_active = TRUE AND include_in_safe_to_spend = TRUE, the same universe the Safe to Spend headline and the Cash Flow report default to (migration 014’s CHECK keeps investment / credit_card / loan accounts out of it). A pool with no members is a normal 200 carrying includedAccountCount 0, currentNetWorthCents 0 and lowestProjected null — never an error. An unknown value is rejected with 400 and is never coerced to ‘all’. remainingDueThisMonthCents, overdueDueCents and upcomingBills are deliberately NOT scoped under ANY value — they belong to the adjacent Upcoming Bills card, which shares this response.
Responses
Section titled “Responses”Projection
object
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
Integer minor units (cents)
object
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
ScheduledMark ? its scheduledPaymentDate : this row’s own dueDate.
SIGNED (income +, expense −), server-computed. Equals the schedule’s own signed amount when unmarked. Never re-derive a sign on the client.
The EFFECTIVE scope, echoed on every path so a param-dropping proxy is detectable client-side.
How many accounts the scope matched. Emitted on EVERY path including the default one, and 0 is a legitimate value (an accountScope that matched nothing — e.g. an empty Safe-to-Spend pool) that clients key their empty state on.
The lowest point of the PROJECTED series (ties resolve to the earliest date) — the projection footer figure, computed server-side. NULL when the scope matched no accounts or no point carries a projected value; never a fabricated $0.
object
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
Example
{ "data": { "upcomingBills": [ { "direction": "expense", "frequency": "once" } ], "accountScope": "all" }}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"}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"}