# Firefly III

> Keep your money in Firefly III up to date: record expenses, income and transfers, find and tidy transactions, and read balances, budgets, bills and monthly summaries. Start a workflow when a transaction is recorded.

App · 14 actions. Web page: https://docs.lodol.com/docs/integrations/firefly-iii

## Actions

### Add account

Add an account: one of yours, someone you pay, or someone who pays you.

**Inputs**

- Name (`name`, text, required): What to call it, such as Savings.
- Kind (`account_type`, text): One of yours, someone you pay, or someone who pays you. Defaults to yours. One of: `asset` (Your accounts), `expense` (Expense accounts (who you pay)), `revenue` (Revenue accounts (who pays you)). Default: `asset`.
- Account role (`role`, text): For one of yours, what it's for. Defaults to a default account. One of: `defaultAsset` (Default account), `sharedAsset` (Shared account), `savingAsset` (Savings account), `ccAsset` (Credit card), `cashWalletAsset` (Cash wallet). Default: `defaultAsset`.
- Currency (`currency_code`, text): Its currency, such as EUR. Defaults to your main currency.
- Opening balance (`opening_balance`, number): For one of yours, what's in it today.

**Outputs**

- `active` (true/false): Whether it's in use
- `balance` (number): Its balance now
- `currency_code` (text): Its currency
- `iban` (text): Its IBAN, if set
- `id` (text): The account's ID
- `link` (text): A link to it in Firefly III
- `name` (text): Its name
- `role` (text): For your accounts: default, shared, savings, credit card or cash
- `type` (text): asset, expense, revenue or a liability

**Example output**

```json
{
  "active": true,
  "balance": 2310.42,
  "currency_code": "EUR",
  "iban": "NL02ABNA0123456789",
  "id": "1",
  "link": "https://firefly.example.com/accounts/show/1",
  "name": "Checking account",
  "role": "defaultAsset",
  "type": "asset"
}
```

### Add transaction

Record an expense, income or a transfer between your accounts.

**Inputs**

- Kind (`transaction_type`, text): An expense, income, or a transfer between your accounts. Defaults to an expense. One of: `withdrawal` (Expense), `deposit` (Income), `transfer` (Transfer between your accounts). Default: `withdrawal`.
- Amount (`amount`, text, required): How much, such as 42.50, without a minus sign.
- Description (`description`, text, required): What it was for, such as Weekly groceries.
- Your account (`account`, text, required): The account it's paid from, paid into, or for a transfer, moved from.
- Paid to or received from (`other_party`, text): Who was paid, or who paid you, such as a shop. For a transfer, your account it moves to. Blank leaves it as cash.
- Date (`transaction_date`, date): When it happened. Defaults to today.
- Category (`category`, text): A category, such as Groceries. A new name makes a new category.
- Budget (`budget`, text): For an expense, the budget it comes out of.
- Tags (`tags`, list): Tags, such as holiday-2026.
- Notes (`notes`, text): Notes kept with it.

**Outputs**

- `amount` (number): How much
- `budget` (text): The budget it came out of
- `category` (text): Its category
- `currency_code` (text): The currency, such as EUR
- `date` (text): Its date (YYYY-MM-DD)
- `description` (text): What it was for
- `destination` (text): Where it went
- `id` (text): The transaction's number
- `journal_id` (text): Its journal number, inside Firefly III
- `link` (text): A link to it in Firefly III
- `notes` (text): Its notes
- `source` (text): Where the money came from
- `splits` (number): How many parts it's split in; usually 1
- `tags` (list): Its tags
- `type` (text): withdrawal, deposit or transfer

**Example output**

```json
{
  "amount": 42.5,
  "budget": "Food",
  "category": "Groceries",
  "currency_code": "EUR",
  "date": "2026-10-28",
  "description": "Weekly groceries",
  "destination": "Albert Heijn",
  "id": "1842",
  "journal_id": "1903",
  "link": "https://firefly.example.com/transactions/show/1842",
  "notes": "",
  "source": "Checking account",
  "splits": 1,
  "tags": [
    "family"
  ],
  "type": "withdrawal"
}
```

### Delete account

Delete one of your accounts, with every transaction on it.

**Inputs**

- Account (`account`, text, required): The account.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The account's ID

**Example output**

```json
{
  "deleted": true,
  "id": "7"
}
```

### Delete transaction

Delete a transaction.

**Inputs**

- Transaction (`transaction`, text, required): The transaction's number, from 'Add transaction' or a list, or its link.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The transaction's number

**Example output**

```json
{
  "deleted": true,
  "id": "1842"
}
```

### Get current user

Who the connection acts as, and the server's Firefly III version.

**Inputs**: None.

**Outputs**

- `email` (text): Their email address
- `id` (text): The user's ID
- `role` (text): Their role, such as owner
- `version` (text): The server's Firefly III version

**Example output**

```json
{
  "email": "ada@example.com",
  "id": "1",
  "role": "owner",
  "version": "6.4.0"
}
```

### Get summary

Get a period's money in and out, balance, bills to pay and net worth. Defaults to this month so far.

**Inputs**

- From (`start_date`, date): The first day. Defaults to the start of this month.
- To (`end_date`, date): The last day. Defaults to today.

**Outputs**

- `count` (number): How many rows
- `from` (text): The first day (YYYY-MM-DD)
- `items` (list): One row per figure and currency
- `to` (text): The last day

**Example output**

```json
{
  "count": 1,
  "from": "2026-10-01",
  "items": [
    {
      "currency_code": "EUR",
      "key": "spent-in-EUR",
      "shown_as": "\u20ac-1,284.30",
      "title": "Spent (EUR)",
      "value": -1284.3
    }
  ],
  "to": "2026-10-28"
}
```

### Get transaction

Get a transaction, with its accounts, category, budget and tags.

**Inputs**

- Transaction (`transaction`, text, required): The transaction's number, from 'Add transaction' or a list, or its link.

**Outputs**

- `amount` (number): How much
- `budget` (text): The budget it came out of
- `category` (text): Its category
- `currency_code` (text): The currency, such as EUR
- `date` (text): Its date (YYYY-MM-DD)
- `description` (text): What it was for
- `destination` (text): Where it went
- `id` (text): The transaction's number
- `journal_id` (text): Its journal number, inside Firefly III
- `link` (text): A link to it in Firefly III
- `notes` (text): Its notes
- `source` (text): Where the money came from
- `splits` (number): How many parts it's split in; usually 1
- `tags` (list): Its tags
- `type` (text): withdrawal, deposit or transfer

**Example output**

```json
{
  "amount": 42.5,
  "budget": "Food",
  "category": "Groceries",
  "currency_code": "EUR",
  "date": "2026-10-28",
  "description": "Weekly groceries",
  "destination": "Albert Heijn",
  "id": "1842",
  "journal_id": "1903",
  "link": "https://firefly.example.com/transactions/show/1842",
  "notes": "",
  "source": "Checking account",
  "splits": 1,
  "tags": [
    "family"
  ],
  "type": "withdrawal"
}
```

### List accounts

List accounts of one kind, with their balances. Defaults to your own accounts.

**Inputs**

- Kind (`account_type`, text): Which accounts. Defaults to your own. One of: `asset` (Your accounts), `expense` (Expense accounts (who you pay)), `revenue` (Revenue accounts (who pays you)), `liabilities` (Loans, debts and mortgages). Default: `asset`.

**Outputs**

- `accounts` (list): The accounts
- `count` (number): How many

**Example output**

```json
{
  "accounts": [
    {
      "active": true,
      "balance": 2310.42,
      "currency_code": "EUR",
      "iban": "NL02ABNA0123456789",
      "id": "1",
      "link": "https://firefly.example.com/accounts/show/1",
      "name": "Checking account",
      "role": "defaultAsset",
      "type": "asset"
    }
  ],
  "count": 1
}
```

### List bills

List bills and subscriptions, with how much and when each is next due.

**Inputs**: None.

**Outputs**

- `bills` (list): The bills
- `count` (number): How many

**Example output**

```json
{
  "bills": [
    {
      "active": true,
      "amount_max": 950.0,
      "amount_min": 950.0,
      "currency_code": "EUR",
      "id": "4",
      "name": "Rent",
      "next_due": "2026-11-01",
      "repeats": "monthly"
    }
  ],
  "count": 1
}
```

### List budgets

List budgets with what was spent from each in a period. Defaults to this month so far.

**Inputs**

- From (`start_date`, date): The first day. Defaults to the start of this month.
- To (`end_date`, date): The last day. Defaults to today.

**Outputs**

- `budgets` (list): The budgets
- `count` (number): How many
- `from` (text): The first day (YYYY-MM-DD)
- `to` (text): The last day

**Example output**

```json
{
  "budgets": [
    {
      "active": true,
      "id": "2",
      "name": "Food",
      "spent": [
        {
          "amount": 312.4,
          "currency_code": "EUR"
        }
      ]
    }
  ],
  "count": 1,
  "from": "2026-10-01",
  "to": "2026-10-28"
}
```

### List categories

List every category.

**Inputs**: None.

**Outputs**

- `categories` (list): The categories
- `count` (number): How many

**Example output**

```json
{
  "categories": [
    {
      "id": "3",
      "name": "Groceries"
    }
  ],
  "count": 1
}
```

### List transactions

List transactions in a period, newest first. Defaults to this month so far.

**Inputs**

- Kind (`transaction_type`, text): Only expenses, income or transfers. Defaults to all. One of: `all`, `withdrawal` (Expense), `deposit` (Income), `transfer` (Transfer between your accounts). Default: `all`.
- From (`start_date`, date): The first day. Defaults to the start of this month.
- To (`end_date`, date): The last day. Defaults to today.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many
- `from` (text): The first day (YYYY-MM-DD)
- `to` (text): The last day
- `transactions` (list): The transactions

**Example output**

```json
{
  "count": 1,
  "from": "2026-10-01",
  "to": "2026-10-28",
  "transactions": [
    {
      "amount": 42.5,
      "budget": "Food",
      "category": "Groceries",
      "currency_code": "EUR",
      "date": "2026-10-28",
      "description": "Weekly groceries",
      "destination": "Albert Heijn",
      "id": "1842",
      "journal_id": "1903",
      "link": "https://firefly.example.com/transactions/show/1842",
      "notes": "",
      "source": "Checking account",
      "splits": 1,
      "tags": [
        "family"
      ],
      "type": "withdrawal"
    }
  ]
}
```

### Search transactions

Find transactions by words, or Firefly III's search terms such as amount_more:50 or category_is:Groceries.

**Inputs**

- Search (`query`, text, required): Words or search terms, as in Firefly III's search box.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many
- `transactions` (list): The transactions

**Example output**

```json
{
  "count": 1,
  "transactions": [
    {
      "amount": 42.5,
      "budget": "Food",
      "category": "Groceries",
      "currency_code": "EUR",
      "date": "2026-10-28",
      "description": "Weekly groceries",
      "destination": "Albert Heijn",
      "id": "1842",
      "journal_id": "1903",
      "link": "https://firefly.example.com/transactions/show/1842",
      "notes": "",
      "source": "Checking account",
      "splits": 1,
      "tags": [
        "family"
      ],
      "type": "withdrawal"
    }
  ]
}
```

### Update transaction

Change a transaction's description, amount, date, category, budget, tags or notes.

**Inputs**

- Transaction (`transaction`, text, required): The transaction's number, from 'Add transaction' or a list, or its link.
- Description (`description`, text): A new description. Leave blank to keep it.
- Amount (`amount`, text): A new amount. Leave blank to keep it.
- Date (`transaction_date`, date): A new date. Leave blank to keep it.
- Category (`category`, text): A category, such as Groceries. A new name makes a new category. Leave blank to keep it.
- Budget (`budget`, text): For an expense, the budget it comes out of. Leave blank to keep it.
- Tags (`tags`, list): Tags, such as holiday-2026. Leave blank to keep it.
- Notes (`notes`, text): Notes kept with it. Leave blank to keep it.

**Outputs**

- `amount` (number): How much
- `budget` (text): The budget it came out of
- `category` (text): Its category
- `currency_code` (text): The currency, such as EUR
- `date` (text): Its date (YYYY-MM-DD)
- `description` (text): What it was for
- `destination` (text): Where it went
- `id` (text): The transaction's number
- `journal_id` (text): Its journal number, inside Firefly III
- `link` (text): A link to it in Firefly III
- `notes` (text): Its notes
- `source` (text): Where the money came from
- `splits` (number): How many parts it's split in; usually 1
- `tags` (list): Its tags
- `type` (text): withdrawal, deposit or transfer

**Example output**

```json
{
  "amount": 42.5,
  "budget": "Food",
  "category": "Groceries",
  "currency_code": "EUR",
  "date": "2026-10-28",
  "description": "Weekly groceries",
  "destination": "Albert Heijn",
  "id": "1842",
  "journal_id": "1903",
  "link": "https://firefly.example.com/transactions/show/1842",
  "notes": "",
  "source": "Checking account",
  "splits": 1,
  "tags": [
    "family"
  ],
  "type": "withdrawal"
}
```
