Models

AvailableBudgetProperties

object

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

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

amountstring<amount>

The amount of this available budget in the currency of this available budget.

Example

123.45

pc_amountstring<amount>

The amount of this available budget in the primary currency (pc) of this administration.

Example

123.45

startstring<date-time>

Start date of the available budget.

Example

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

endstring<date-time>

End date of the available budget.

Example

2026-10-31T23:59:59+00:00

spent_in_budgetsArray<ArrayEntryWithCurrencyAndSum>read only

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_spent_in_budgetsArray<ArrayEntryWithCurrencyAndSum>read only

The amount spent in budgets in the primary currency (pc) of this 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

spent_outside_budgetsArray<ArrayEntryWithCurrencyAndSum>read only

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_spent_outside_budgetsArray<ArrayEntryWithCurrencyAndSum>read only

The amount spent outside of budgets in the primary currency (pc) of this 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

Example

{
  "created_at": "2026-10-01T00:00:00+00:00",
  "updated_at": "2026-10-01T00:00:00+00:00",
  "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,
  "amount": "123.45",
  "pc_amount": "123.45",
  "start": "2026-10-01T00:00:00+00:00",
  "end": "2026-10-31T23:59:59+00:00",
  "spent_in_budgets": [
    {
      "currency_id": "5",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "sum": "123.45"
    }
  ],
  "pc_spent_in_budgets": [
    {
      "currency_id": "5",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "sum": "123.45"
    }
  ],
  "spent_outside_budgets": [
    {
      "currency_id": "5",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "sum": "123.45"
    }
  ],
  "pc_spent_outside_budgets": [
    {
      "currency_id": "5",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "sum": "123.45"
    }
  ]
}