FIfirefly-iii
recurrences

List all transactions created by a recurring transaction.

List all transactions created by a recurring transaction, optionally limited to the date ranges specified.

get/v1/recurrences/{id}/transactions

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/recurrences/{id}/transactions
  • 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

idstring required
Example:123

The ID of the recurring transaction.

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. Both the start and end date must be present.

endstring date
Example:2025-11-30

A date formatted YYYY-MM-DD. Both the start and end date must be present.

type'all' | 'withdrawal' | 'withdrawals' | 'expense' | 'deposit' | 'deposits' | 'income' | 'transfer' | 'transfers' | 'opening_balance' | 'reconciliation' | 'special' | 'specials' | 'default'

Optional filter on the transaction type(s) returned

Headers

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

Unique identifier associated with this request.

Response

A list of transactions

Example response

{
  "data": [
    {
      "type": "transactions",
      "id": "2",
      "attributes": {
        "created_at": "2025-11-01T00:00:00+00:00",
        "updated_at": "2025-11-01T00:00:00+00:00",
        "user": "3",
        "group_title": "Split transaction title.",
        "transactions": [
          {
            "user": "3",
            "transaction_journal_id": "10421",
            "type": "withdrawal",
            "date": "2025-11-01T00:00:00+00:00",
            "object_has_currency_setting": true,
            "currency_id": "12",
            "currency_code": "EUR",
            "currency_symbol": "$",
            "currency_name": "Euro",
            "currency_decimal_places": 2,
            "foreign_currency_id": "17",
            "foreign_currency_code": "USD",
            "foreign_currency_symbol": "$",
            "foreign_currency_decimal_places": 2,
            "primary_currency_id": "12",
            "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",
            "source_balance_after": "123.45",
            "pc_source_balance_after": "123.45",
            "destination_balance_after": "123.45",
            "pc_destination_balance_after": "123.45",
            "description": "Vegetables",
            "source_id": "2",
            "source_name": "Checking account",
            "source_iban": "NL02ABNA0123456789",
            "source_type": "Asset account",
            "destination_id": "2",
            "destination_name": "Buy and Large",
            "destination_iban": "NL02ABNA0123456789",
            "destination_type": "Asset account",
            "budget_id": "4",
            "budget_name": "Groceries",
            "category_id": "43",
            "category_name": "Groceries",
            "bill_id": "111",
            "bill_name": "Monthly rent",
            "subscription_id": "111",
            "subscription_name": "Monthly rent",
            "notes": "Some example notes",
            "tags": [
              "Barbecue preparation"
            ],
            "recurrence_count": 12,
            "latitude": 51.983333,
            "longitude": 5.916667,
            "zoom_level": 6
          }
        ]
      },
      "links": {
        "0": {
          "rel": "self",
          "uri": "/OBJECTS/1"
        },
        "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "links": {
    "self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
    "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
    "next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
    "prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
    "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
  }
}

Changes

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