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 next attachments types:
bill,invoice,customer,vendor, 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 filterable | string | Identifier for the attachment, unique to the business in the accounting service provider. |
| url | string | The file download URL. |
| fileName | string | The file name of the attachment. |
| contentType | string | File type of the attachment, represented by appending the file type to the IETF standard file naming requirements. For example, for a jpeg file the output is image/jpeg. |
| uploadDate | string See Date | Date the attachment was uploaded and attached in the accounting service provider. |
| fileSize | integer | File size in bytes. For example, if this reads 10000, then the file size is 10KB. |
| link | object | Invoice or Bill link the attachment is linked to. |
| sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting service provider. |
Invoice and Bill Link
| Field | Type | Description |
|---|---|---|
| id filterable | string | Identifier for the invoice or bill, unique to the business in the accounting service provider. |
| type filterable | string | The type of attachment transaction link. Can be:invoicebillcustomervendordeposit |
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.