Firefly III

App · 14 actions

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.

Actions

ActionWhat it does
Add accountAdd an account: one of yours, someone you pay, or someone who pays you.
Add transactionRecord an expense, income or a transfer between your accounts.
Delete accountDelete one of your accounts, with every transaction on it.
Delete transactionDelete a transaction.
Get current userWho the connection acts as, and the server's Firefly III version.
Get summaryGet a period's money in and out, balance, bills to pay and net worth.
Get transactionGet a transaction, with its accounts, category, budget and tags.
List accountsList accounts of one kind, with their balances.
List billsList bills and subscriptions, with how much and when each is next due.
List budgetsList budgets with what was spent from each in a period.
List categoriesList every category.
List transactionsList transactions in a period, newest first.
Search transactionsFind transactions by words, or Firefly III's search terms such as amount_more:50 or category_is:Groceries.
Update transactionChange a transaction's description, amount, date, category, budget, tags or notes.

Add account

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

Inputs

NamenametextRequired
What to call it, such as Savings.
Kindaccount_typetext
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 roleroletext
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.
Currencycurrency_codetext
Its currency, such as EUR. Defaults to your main currency.
Opening balanceopening_balancenumber
For one of yours, what's in it today.

Outputs

activetrue/false
Whether it's in use
balancenumber
Its balance now
currency_codetext
Its currency
ibantext
Its IBAN, if set
idtext
The account's ID
linktext
A link to it in Firefly III
nametext
Its name
roletext
For your accounts: default, shared, savings, credit card or cash
typetext
asset, expense, revenue or a liability
Example output
{
  "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

Kindtransaction_typetext
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.
AmountamounttextRequired
How much, such as 42.50, without a minus sign.
DescriptiondescriptiontextRequired
What it was for, such as Weekly groceries.
Your accountaccounttextRequired
The account it's paid from, paid into, or for a transfer, moved from.
Paid to or received fromother_partytext
Who was paid, or who paid you, such as a shop. For a transfer, your account it moves to. Blank leaves it as cash.
Datetransaction_datedate
When it happened. Defaults to today.
Categorycategorytext
A category, such as Groceries. A new name makes a new category.
Budgetbudgettext
For an expense, the budget it comes out of.
Tagstagslist
Tags, such as holiday-2026.
Notesnotestext
Notes kept with it.

Outputs

amountnumber
How much
budgettext
The budget it came out of
categorytext
Its category
currency_codetext
The currency, such as EUR
datetext
Its date (YYYY-MM-DD)
descriptiontext
What it was for
destinationtext
Where it went
idtext
The transaction's number
journal_idtext
Its journal number, inside Firefly III
linktext
A link to it in Firefly III
notestext
Its notes
sourcetext
Where the money came from
splitsnumber
How many parts it's split in; usually 1
tagslist
Its tags
typetext
withdrawal, deposit or transfer
Example output
{
  "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

AccountaccounttextRequired
The account.

Outputs

deletedtrue/false
True once deleted
idtext
The account's ID
Example output
{
  "deleted": true,
  "id": "7"
}

Delete transaction

Delete a transaction.

Inputs

TransactiontransactiontextRequired
The transaction's number, from 'Add transaction' or a list, or its link.

Outputs

deletedtrue/false
True once deleted
idtext
The transaction's number
Example output
{
  "deleted": true,
  "id": "1842"
}

Get current user

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

Inputs

None.

Outputs

emailtext
Their email address
idtext
The user's ID
roletext
Their role, such as owner
versiontext
The server's Firefly III version
Example output
{
  "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

Fromstart_datedate
The first day. Defaults to the start of this month.
Toend_datedate
The last day. Defaults to today.

Outputs

countnumber
How many rows
fromtext
The first day (YYYY-MM-DD)
itemslist
One row per figure and currency
totext
The last day
Example output
{
  "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

TransactiontransactiontextRequired
The transaction's number, from 'Add transaction' or a list, or its link.

Outputs

amountnumber
How much
budgettext
The budget it came out of
categorytext
Its category
currency_codetext
The currency, such as EUR
datetext
Its date (YYYY-MM-DD)
descriptiontext
What it was for
destinationtext
Where it went
idtext
The transaction's number
journal_idtext
Its journal number, inside Firefly III
linktext
A link to it in Firefly III
notestext
Its notes
sourcetext
Where the money came from
splitsnumber
How many parts it's split in; usually 1
tagslist
Its tags
typetext
withdrawal, deposit or transfer
Example output
{
  "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

Kindaccount_typetext
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

accountslist
The accounts
countnumber
How many
Example output
{
  "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

billslist
The bills
countnumber
How many
Example output
{
  "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

Fromstart_datedate
The first day. Defaults to the start of this month.
Toend_datedate
The last day. Defaults to today.

Outputs

budgetslist
The budgets
countnumber
How many
fromtext
The first day (YYYY-MM-DD)
totext
The last day
Example output
{
  "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

categorieslist
The categories
countnumber
How many
Example output
{
  "categories": [
    {
      "id": "3",
      "name": "Groceries"
    }
  ],
  "count": 1
}

List transactions

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

Inputs

Kindtransaction_typetext
Only expenses, income or transfers. Defaults to all.One of: all, withdrawal (Expense), deposit (Income), transfer (Transfer between your accounts). Default: all.
Fromstart_datedate
The first day. Defaults to the start of this month.
Toend_datedate
The last day. Defaults to today.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many
fromtext
The first day (YYYY-MM-DD)
totext
The last day
transactionslist
The transactions
Example output
{
  "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

SearchquerytextRequired
Words or search terms, as in Firefly III's search box.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many
transactionslist
The transactions
Example output
{
  "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

TransactiontransactiontextRequired
The transaction's number, from 'Add transaction' or a list, or its link.
Descriptiondescriptiontext
A new description. Leave blank to keep it.
Amountamounttext
A new amount. Leave blank to keep it.
Datetransaction_datedate
A new date. Leave blank to keep it.
Categorycategorytext
A category, such as Groceries. A new name makes a new category. Leave blank to keep it.
Budgetbudgettext
For an expense, the budget it comes out of. Leave blank to keep it.
Tagstagslist
Tags, such as holiday-2026. Leave blank to keep it.
Notesnotestext
Notes kept with it. Leave blank to keep it.

Outputs

amountnumber
How much
budgettext
The budget it came out of
categorytext
Its category
currency_codetext
The currency, such as EUR
datetext
Its date (YYYY-MM-DD)
descriptiontext
What it was for
destinationtext
Where it went
idtext
The transaction's number
journal_idtext
Its journal number, inside Firefly III
linktext
A link to it in Firefly III
notestext
Its notes
sourcetext
Where the money came from
splitsnumber
How many parts it's split in; usually 1
tagslist
Its tags
typetext
withdrawal, deposit or transfer
Example output
{
  "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"
}

On this page