Bill Attachments
The Attachment Object
A Rutter Bill Attachment represents a file that can be attached to a bill. In general we provide attachments data only for attachments that have been created through our POST endpoint. However, there are some platform specific differences.
Platform Differences
Xero:
- We provide historical attachments that were created outside of our API.
Properties
idstringThe Rutter ID of the attachment. This can be the same as the Platform ID. This ID is not guaranteed to be unique across all attachment objects for a connection.
platform_idstringThe platform specific ID of the attachment.
attached_to_idstringnullableThe Rutter ID of the entity linked to the attachment.
file_namestringThe file name of the attachment.
file_urlstringThe Rutter generated URL containing a downloadable version of the attachment.
attached_to_typestringnullableThe type of entity linked to the attachment.
created_atstringThe ISO 8601 timestamp that the attachment was created.
Note: The following platforms dont't support this field, and may return an empty string:
- Xero
List Bill Attachments
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
attached_to_idstringqueryOptionalThe ID of the entity that the attachment is attached to.
cursorstringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.
limitintegerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
expandenumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
updated_at_maxintegerqueryOptionalUsed to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_minintegerqueryOptionalUsed to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- NetSuite
- Zoho Books
1{
2 "attachments": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "attached_to_id": "00000000-0000-0000-0000-000000000000",
7 "file_name": "receipt.jpg",
8 "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",
9 "attached_to_type": "EXPENSE",
10 "created_at": "2023-01-02T02:34:56.000Z"
11 }
12 ],
13 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
14}
Fetch a Bill Attachment metadata
Request Parameters
idstringpathRequiredThe Rutter generated unique ID of the attachment.
access_tokenstringqueryRequiredThe access token of the connection.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- NetSuite
- Zoho Books
List Attachments for Bill
Request Parameters
idstringpathRequiredThe Rutter generated unique ID of the object that has the attachment.
access_tokenstringqueryRequiredThe access token of the connection.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- NetSuite
- Zoho Books
1{
2 "attachments": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "attached_to_id": "00000000-0000-0000-0000-000000000000",
7 "file_name": "attachment.pdf",
8 "file_url": "/accounting/bills/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file",
9 "attached_to_type": "BILL",
10 "created_at": "2023-01-02T02:34:56.000Z"
11 }
12 ]
13}
Download a Bill Attachment
Request Parameters
idstringpathRequiredThe Rutter generated unique ID of the object that has the attachment.
attachmentIdstringpathRequiredThe platform unique ID of the attachment.
access_tokenstringqueryRequiredThe access token of the connection.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- NetSuite
- Zoho Books
Create a Bill Attachment
For this endpoint, the request body is not application/json, it is multipart/form-data.
Request Parameters
idstringpathRequiredThe Rutter generated unique ID of the underlying entity type.
access_tokenstringqueryRequiredThe access token of the connection.
Request Body
filestringThe file content (PDF, JPG, CSV, TXT, etc).
file_namestringThe file name of the attachment.
response_modeenumOptionalThe response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.
Response Body
- QuickBooks
- Xero
- NetSuite
- Zoho Books
1{
2 "file": "multipart/form-data",
3 "file_name": "T-shirt Receipt"
4}
1{
2 "attachment": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "attached_to_id": "00000000-0000-0000-0000-000000000000",
6 "file_name": "receipt.jpg",
7 "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",
8 "attached_to_type": "EXPENSE",
9 "created_at": "2023-01-02T02:34:56.000Z"
10 }
11}
Have questions?
Contact support for personalized guidance.