Savings Rate Endpoint

GET

/api/v1/budget/savings-rate

curl --request GET \
  --url 'https://example.com/api/v1/budget/savings-rate?exclude_from_spending=false'

Monthly income, expenses, money moved to off-budget accounts and the savings rate, in the caller’s base currency. Transfers never count as income or expenses; money moved from an on-budget to an off-budget account counts as saved. date_from/date_to are inclusive, account_ids (repeatable, at most 100) narrows by account. exclude_from_spending=true leaves the transactions of categories flagged exclude_from_spending out of income and expenses. One bounded object, no pagination. Read-only.

Parameters

Query Parameters

date_from

Any of:

string

string format: date

null

null

date_to

Any of:

string

string format: date

null

null

account_ids

Any of:

Array<integer>

Array<integer>

<= 100 items

null

null

exclude_from_spending

Exclude From Spending

boolean

Responses

200

Successful Response

Media typeapplication/json

SavingsRateOut

object

currency

required

Currency

string

months

required

Months

Array<object>

SavingsRateMonthOut

object

month

required

Month

string

income

required

Income

string

expenses

required

Expenses

string

transferred

required

Transferred

string

rate

required

Any of:

string

string

null

null

missing_rate_currencies

Missing Rate Currencies

Array<string>

default:

Example

{
  "missing_rate_currencies": []
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}