Attachments

The Attachment Object

The Railz API allows customers to pull and push attachments to invoices and bills.

📘

Pushing Attachments

Railz currently supports the pushing of the following attachments types: bill, invoice, inventory, billPayment,invoicePayment,expense,customer, vendor, journalEntry, deposit, invoicecreditNote, billcreditNote, purchaseOrder, bankTransaction, and bankTransfer.

The Railz API doesn't support the upload of multiple attachments in a single API call.

🚧

Synchronizing Data for Attachments

Attachments are only retrieved on an Initial data synchronization. To get the latest attachments for a business connection you will need to use our On-demand sync.

FieldTypeDescription
id
sortable, _filterable
stringIdentifier for the attachment, unique to the business in the accounting service provider.
url stringShort-lived download URL for the attachment generated by Railz.
fileName stringAttachment file name.
contentType stringFile type of the attachment, represented by appending the file type to the IETF standard file naming requirements.

The types of files allowed are: pdf, doc, docx, xls, xlsx, png, jpeg

For example, for a jpeg file the output is image/jpeg.
uploadDate
sortable, filterable
string
See Date
Date the attachment was uploaded to the accounting service.
fileSize integerThe file size in bytes.
links objectThe transaction records to which this attachment is uploaded to.
sourceModifiedDate
sortable, filterable
string
See Date
The date on which this record was last modified in the accounting service.

Links

FieldTypeDescription
id
sortable, filterable
stringThe transaction records id to which this attachment is uploaded to.
type
sortable, filterable
stringThe transaction records type to which this attachment is uploaded to.

📘

When pushing attachments, you only need to provide the file and transaction link. Railz will detect the file name, type and size upon receiving the API request.

How to - User Guide

Step-by-step guide on utilizing this endpoint.