FIfirefly-iii
links

Create a new link between transactions

Store a new link between two transactions. For this end point you need the journal_id from a transaction.

post/v1/transaction-links

Request

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

link_type_idstring string required

The link type ID to use. You can also use the link_type_name field.

link_type_namestring string

The link type name to use. You can also use the link_type_id field.

inward_idstring string required

The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set.

outward_idstring string required

The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set.

notesstring string nullable

Optional. Some notes.

Example request

{
  "link_type_id": "5",
  "link_type_name": "Is paid by",
  "inward_id": "131",
  "outward_id": "131",
  "notes": "Some example notes"
}

Response

New transaction link stored, result in response.

Example response

{
  "data": {
    "type": "transactionLinks",
    "id": "2",
    "attributes": {
      "created_at": "2026-03-01T00:00:00+00:00",
      "updated_at": "2026-03-01T00:00:00+00:00",
      "link_type_id": "5",
      "link_type_name": "Is paid by",
      "inward_id": "131",
      "outward_id": "131",
      "notes": "Some example notes"
    },
    "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.