FIfirefly-iii
bills

List all bills.

This endpoint will list all the user's bills.

get/v1/bills

Request

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

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-11-01

A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.

endstring date
Example:2025-11-01

A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.

Headers

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

Unique identifier associated with this request.

Response

A list of bills

Example response

{
  "data": [
    {
      "type": "bills",
      "id": "2",
      "attributes": {
        "created_at": "2025-11-01T00:00:00+00:00",
        "updated_at": "2025-11-01T00:00:00+00:00",
        "name": "Rent",
        "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_min": "123.45",
        "pc_amount_min": "123.45",
        "amount_max": "123.45",
        "pc_amount_max": "123.45",
        "amount_avg": "123.45",
        "pc_amount_avg": "123.45",
        "date": "2025-11-01T00:00:00+00:00",
        "end_date": "2025-11-30T23:59:59+00:00",
        "extension_date": "2025-11-30T23:59:59+00:00",
        "repeat_freq": "monthly",
        "active": true,
        "order": 1,
        "notes": "Some example notes",
        "object_group_id": "5",
        "object_group_order": 5,
        "object_group_title": "Example Group",
        "paid_dates": [
          {
            "transaction_group_id": "123",
            "transaction_journal_id": "123",
            "date": "2025-11-01T00:00:00+00:00",
            "subscription_id": "123",
            "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",
            "foreign_amount": "123.45",
            "pc_foreign_amount": "123.45"
          }
        ],
        "pay_dates": [
          "2025-11-01T00:00:00+00:00"
        ],
        "next_expected_match": "2025-11-01T00:00:00+00:00",
        "next_expected_match_diff": "today"
      }
    }
  ],
  "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.