The Attachment Object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
The Railz API allows customers to pull and push attachments to invoices and bills.
Pushing Attachments
Railz currently supports the pushing of the next attachments types:
bill,invoice,inventory,billPayment,invoicePayment,expense,customer,vendor,journalEntry, anddeposit.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.
| Field | Type | Description |
|---|---|---|
| id sortable, _filterable | string | Identifier for the attachment, unique to the business in the accounting service provider. |
| url | string | Short-lived download URL for the attachment generated by Railz. |
| fileName | string | Attachment file name. |
| contentType | string | File 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, jpegFor 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 | integer | The file size in bytes. |
| links | object | The 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
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | The transaction records id to which this attachment is uploaded to. |
| type sortable, filterable | string | The 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.