Models
TransactionLinkArray
objectShow child attributes
typestringrequiredImmutable value
Example
transactionLinksCopy
idstringrequiredExample
2Copy
Show child attributes
created_atstring<date-time>read onlyExample
2026-10-01T00:00:00+00:00Copy
updated_atstring<date-time>read onlyExample
2026-10-01T00:00:00+00:00Copy
link_type_idstringrequiredwrite onlyThe link type ID to use. You can also use the link_type_name field.
Example
5Copy
link_type_namestringwrite onlyThe link type name to use. You can also use the link_type_id field.
Example
Is paid byCopy
inward_idstringrequiredThe inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set.
Example
131Copy
outward_idstringrequiredThe outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set.
Example
131Copy
notesstring | nullOptional. Some notes.
Example
Some example notesCopy
Show child attributes
0objectShow child attributes
relstringExample
selfCopy
uristringExample
/OBJECTS/1Copy
selfstring<uri>Example
https://demo.firefly-iii.org/api/v1/OBJECTS/1Copy
Show child attributes
paginationobjectShow child attributes
totalintegerExample
3Copy
countintegerExample
20Copy
per_pageintegerExample
100Copy
current_pageintegerExample
1Copy
total_pagesintegerExample
1Copy
Show child attributes
selfstring<uri>Example
https://demo.firefly-iii.org/api/v1/OBJECT?&page=4Copy
firststring<uri>Example
https://demo.firefly-iii.org/api/v1/OBJECT?&page=1Copy
nextstring<uri> | nullExample
https://demo.firefly-iii.org/api/v1/OBJECT?&page=3Copy
prevstring<uri> | nullExample
https://demo.firefly-iii.org/api/v1/OBJECT?&page=2Copy
laststring<uri>Example
https://demo.firefly-iii.org/api/v1/OBJECT?&page=12Copy
© James Cole, licensed under Attribution-ShareAlike 4.0 International.Docs by Sourcey
