Skip to content

Recorded end-of-day Safe to Spend for the last 90 days, by pay period (KAN-4040)

GET
/dashboard/safe-to-spend/report
curl --request GET \
--url https://api.tovarifinancial.com/dashboard/safe-to-spend/report \
--header 'Authorization: Bearer <token>'

The report. All four summary figures are over the counted days: recorded closed days plus today when today is non-null; coverage.daysCounted is their denominator.

Media typeapplication/json
object
data
required
object
stateBasis
string
today
object
date

Calendar date, ‘YYYY-MM-DD’

string
safeToSpendCents

Integer minor units (cents)

integer format: int64
tightThresholdCents

Integer minor units (cents)

integer format: int64
state
string
Allowed values: healthy tight negative
isProvisional
boolean
summary
object
lowCents

Integer minor units (cents)

integer format: int64
nullable
lowDate

Calendar date, ‘YYYY-MM-DD’

string
nullable
daysHealthy
integer
daysBelowZero
integer
coverage
object
windowDays
integer
daysRecorded
integer
daysCounted
integer
firstRecordedDate

Calendar date, ‘YYYY-MM-DD’

string
nullable
recordingComplete
boolean
series
Array<object>
object
date

Calendar date, ‘YYYY-MM-DD’

string
safeToSpendCents

Integer minor units (cents)

integer format: int64
nullable
tightThresholdCents

Integer minor units (cents)

integer format: int64
nullable
state
string
nullable
Allowed values: healthy tight negative
isToday
boolean
periods
Array<object>
object
start
required

Calendar date, ‘YYYY-MM-DD’

string
end
required

Calendar date, ‘YYYY-MM-DD’

string
basis
required
string
Allowed values: paycheck calendar-month
lowCents
required

Integer minor units (cents)

integer format: int64
lowDate
required

Calendar date, ‘YYYY-MM-DD’

string
state
required
string
Allowed values: healthy tight negative
isCurrent
required
boolean
daysRecorded
required
integer
daysInPeriod
required
integer
message
string
requestId
required
string
timestamp
required
string format: date-time
Example
{
"data": {
"today": {
"state": "healthy"
},
"series": [
{
"state": "healthy"
}
],
"periods": [
{
"basis": "paycheck",
"state": "healthy"
}
]
}
}

Missing, invalid, or expired bearer token

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
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.

Media typeapplication/json
object
errorCode
required

Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.

string
Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED
message
required
string
details
object
outstanding
required

Active policy versions the user has not yet accepted.

Array<object>
object
id
required
string format: uuid
policyType
required
string
version
required
integer
title
required
string
firstAcceptance
required

True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.

boolean
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "EMAIL_NOT_VERIFIED"
}

Internal error (no internal detail leaked)

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
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.

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}