transactions

Store a new transaction

Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.

post/v1/transactions

Request

Base URL
https://demo.firefly-iii.org/api
URL
https://demo.firefly-iii.org/api/v1/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

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

error_if_duplicate_hashboolean

Break if the submitted transaction exists already.

apply_rulesboolean

Whether or not to apply rules when submitting transaction.

fire_webhooksboolean

Whether or not to fire the webhooks that are related to this event.

group_titlestring string nullable

Title of the transaction if it has been split in more than one piece. Empty otherwise.

Example request

{
  "fire_webhooks": true,
  "group_title": "Split transaction title.",
  "transactions": [
    {
      "type": "withdrawal",
      "date": "2025-08-01T00:00:00+00:00",
      "amount": "123.45",
      "description": "Vegetables",
      "currency_id": "12",
      "currency_code": "EUR",
      "foreign_amount": "123.45",
      "foreign_currency_id": "17",
      "foreign_currency_code": "USD",
      "budget_id": "4",
      "budget_name": "Groceries",
      "category_id": "43",
      "category_name": "Groceries",
      "source_id": "2",
      "source_name": "Checking account",
      "destination_id": "2",
      "destination_name": "Buy and Large",
      "bill_id": "112",
      "bill_name": "Monthly rent",
      "tags": [
        "Barbecue preparation"
      ],
      "notes": "Some example notes"
    }
  ]
}

Response

New transaction stored(s), result in response.

Example response

{
  "data": {
    "type": "transactions",
    "id": "2",
    "attributes": {
      "created_at": "2025-08-01T00:00:00+00:00",
      "updated_at": "2025-08-01T00:00:00+00:00",
      "user": "3",
      "group_title": "Split transaction title.",
      "transactions": [
        {
          "user": "3",
          "transaction_journal_id": "10421",
          "type": "withdrawal",
          "date": "2025-08-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"
    }
  }
}

Changes

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