Skip to main content
GET
Get budget status

Authorizations

Authorization
string
header
required

A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as Authorization: Bearer <token>.

Query Parameters

plan
string

Plan name or id. Defaults to the default plan.

Required string length: 1 - 100
period
string
default:current

current (in the user's timezone) or a month as YYYY-MM

Response

Budget status for the month

planId
string<uuid> | null
required
plan
object | null
required
period
object
required
currency
string | null
required

The plan's currency code. USD when the plan stores none.

totals
object
required

A category budget inside a budgeted group counts once, through the group.

readyToAssign
number | null
required

Depository balances minus totals.available minus every payment envelope's available, plus spentOutsideEnvelopes, minus assignedInFuture, over the plan's accounts. Negative when over-assigned. Null unless this is an envelope plan's current month.

readyToAssignBreakdown
object | null
required

The five terms of readyToAssign, each signed the way it moves it, so they add up to readyToAssign. Null whenever readyToAssign is.

assignedInFuture
number | null
required

Every assignment to a later month, payment envelopes included. It comes off readyToAssign now and moves into available when that month is current. Null whenever readyToAssign is.

spentOutsideEnvelopes
number | null
required

This month's unbudgeted and uncategorized spend from depository accounts, added back to readyToAssign like an overspent envelope, so budgeting the category later doesn't raise it. Null whenever readyToAssign is.

balancesAsOf
string<date-time> | null
required

Time of the oldest balance behind readyToAssign

budgets
object[]
required
unbudgeted
object[]
required
paymentEnvelopes
object[]
required

One per credit card in an envelope plan's accounts. Otherwise empty.

unrecognizedCardInflows
object | null
required

This month's inflows on a card in an income category or with no category. Null for standard plans.

meta
object
required

True when the totals include accounts this key was not granted

freshness
object
required

How current the plan's spending is. Destination syncs don't count.