links

Update an existing link between transactions.

Used to update a single existing link.

put/v1/transaction-links/{id}

Path parameters

idstring required
Example:123

The ID of the transaction link.

Headers

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

Unique identifier associated with this request.

Request body

link_type_idstring string

The link type ID to use. Use this field OR use the link_type_name field.

link_type_namestring string

The link type name to use. Use this field OR use the link_type_id field.

inward_idstring string

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

outward_idstring string

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

notesstring string nullable

Optional. Some notes. If you submit an empty string the current notes will be removed

Example request

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

Response

Updated link type stored, result in response

Changes

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