Models

AttachmentSingle

object

dataAttachmentReadrequired

Show child attributes

typestringrequired

Immutable value

Example

attachments

idstringrequired

Example

attributesAttachmentPropertiesrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

attachable_typeAttachableTypeAccountBudgetBillTransactionJournalPiggyBankTag

The object class to which the attachment must be linked.

Example

Bill

attachable_idstring

ID of the model this attachment is linked to.

Example

hashstring

Hash of the file for basic duplicate detection.

Example

0c3f95f34370baa88f9fd9a671fea305

filenamestring

Example

file.pdf

download_urlstring

Example

https://demo.firefly-iii.org/api/v1/attachments/191/download

upload_urlstring

Example

https://demo.firefly-iii.org/api/v1/attachments/191/download

titlestring | null

Example

Some PDF file

notesstring | null

Example

Some notes

mimestringread only

Example

application/pdf

sizeinteger<int32>read only

Example

linksObjectLinkrequired

Show child attributes

0object

Show child attributes

relstring

Example

self

uristring

Example

/OBJECTS/1

selfstring<uri>

Example

https://demo.firefly-iii.org/api/v1/OBJECTS/1

Example

{
  "data": {
    "type": "attachments",
    "id": "2",
    "attributes": {
      "created_at": "2026-10-01T00:00:00+00:00",
      "updated_at": "2026-10-01T00:00:00+00:00",
      "attachable_type": "Bill",
      "attachable_id": "134",
      "hash": "0c3f95f34370baa88f9fd9a671fea305",
      "filename": "file.pdf",
      "download_url": "https://demo.firefly-iii.org/api/v1/attachments/191/download",
      "upload_url": "https://demo.firefly-iii.org/api/v1/attachments/191/download",
      "title": "Some PDF file",
      "notes": "Some notes",
      "mime": "application/pdf",
      "size": 48211
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}