FIfirefly-iii
currencies

List all budget limits with this currency

List all budget limits with this currency

get/v1/currencies/{code}/budget-limits

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/currencies/{code}/budget-limits
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

codestring string required
Example:USD

The currency code.

Query parameters

limitinteger
Example:10

Number of items per page. The default pagination is per 50 items.

pageinteger
Example:1

Page number. The default pagination is per 50 items.

startstring date
Example:2025-12-01

Start date for the budget limit list.

endstring date
Example:2025-12-31

End date for the budget limit list.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of budget limits.

Example response

{
  "data": [
    {
      "type": "budget_limits",
      "id": "2",
      "attributes": {
        "created_at": "2025-12-01T00:00:00+00:00",
        "updated_at": "2025-12-01T00:00:00+00:00",
        "start": "2025-12-01T00:00:00+00:00",
        "end": "2025-12-31T23:59:59+00:00",
        "budget_id": "23",
        "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",
        "period": "monthly",
        "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"
          }
        ],
        "notes": "Some example notes"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.