Skip to main content
GET
Retrieve a budget

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

id
string<uuid>
required

Budget ID

Response

budget retrieved

id
string<uuid>
required
start_date
string<date>
required
end_date
string<date>
required
name
string
required
currency
string
required
initialized
boolean
required
current
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
budgeted_spending
string | null
budgeted_spending_cents
integer | null
expected_income
string | null
expected_income_cents
integer | null
allocated_spending
string
allocated_spending_cents
integer
actual_spending
string
actual_spending_cents
integer
actual_income
string
actual_income_cents
integer
available_to_spend
string
available_to_spend_cents
integer
available_to_allocate
string
available_to_allocate_cents
integer