Models

BudgetArray

object

dataArray<BudgetRead>required

Show child attributes

typestringrequired

Immutable value

Example

budgets

idstringrequired

Example

attributesBudgetPropertiesrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

activeboolean

Example

false

namestringrequired

Example

Bills

orderinteger<int32>read only

Example

notesstring | null

Example

Some notes

auto_budget_typeAutoBudgetType | nullresetrollovernonenull

The type of auto-budget that Firefly III must create.

Example

reset

auto_budget_periodAutoBudgetPeriod | nulldailyweeklymonthlyquarterlyhalf-yearyearlynull

Period for the auto budget

Example

monthly

object_group_idstring | null

The group ID of the group this object is part of. NULL if no group.

Example

object_group_orderinteger<int32> | nullread only

The order of the group. At least 1, for the highest sorting.

Example

object_group_titlestring | null

The name of the group. NULL if no group.

Example

Example Group

object_has_currency_settingbooleanread only

Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.

Example

true

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

auto_budget_amountstring<amount> | null

The amount for the auto-budget, if set.

Example

-1012.12

pc_auto_budget_amountstring<amount> | null

The amount for the auto-budget, if set in the primary currency of the administration.

Example

-1012.12

spentArray<ArrayEntryWithCurrencyAndSum>read only

Information on how much was spent in this budget. Is only filled in when the start and end date are submitted.

Show child attributes

currency_idstring

Example

currency_codestring

Example

USD

currency_symbolstring

Example

currency_decimal_placesinteger<int32>

Number of decimals supported by the currency

Example

sumstring<amount>

The amount earned, spent or transferred.

Example

123.45

pc_spentArray<ArrayEntryWithCurrencyAndSum>read only

Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration.

Show child attributes

currency_idstring

Example

currency_codestring

Example

USD

currency_symbolstring

Example

currency_decimal_placesinteger<int32>

Number of decimals supported by the currency

Example

sumstring<amount>

The amount earned, spent or transferred.

Example

123.45

metaMetarequired

Show child attributes

paginationobject

Show child attributes

totalinteger

Example

countinteger

Example

per_pageinteger

Example

current_pageinteger

Example

total_pagesinteger

Example

{
  "data": [
    {
      "type": "budgets",
      "id": "2",
      "attributes": {
        "created_at": "2026-10-01T00:00:00+00:00",
        "updated_at": "2026-10-01T00:00:00+00:00",
        "active": false,
        "name": "Bills",
        "order": 5,
        "notes": "Some notes",
        "auto_budget_type": "reset",
        "auto_budget_period": "monthly",
        "object_group_id": "5",
        "object_group_order": 5,
        "object_group_title": "Example Group",
        "object_has_currency_setting": true,
        "currency_id": "5",
        "currency_name": "Euro",
        "currency_code": "EUR",
        "currency_symbol": "$",
        "currency_decimal_places": 2,
        "primary_currency_id": "5",
        "primary_currency_name": "Euro",
        "primary_currency_code": "EUR",
        "primary_currency_symbol": "$",
        "primary_currency_decimal_places": 2,
        "auto_budget_amount": "-1012.12",
        "pc_auto_budget_amount": "-1012.12",
        "spent": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ],
        "pc_spent": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}