Attachments
TheAccountingAttachment object is used to represent a company's attachments.The AccountingAttachment object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
file_nameStringOptional
The attachment's name.
file_urlStringOptional
The attachment's url.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted on the third-party.
The AccountingAttachment object
JSON
{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","remote_was_deleted": true}
GET
/attachments
Returns a list of AccountingAttachment objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was deleted in the third-party service.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","remote_was_deleted": true}]}
Field support by platform
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfile_nameStringremote_idString
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_nameStringremote_idString
Quickbooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfile_nameStringremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/attachments/{id}
Returns an AccountingAttachment object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","remote_was_deleted": true}
Field support by platform
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfile_nameStringremote_idStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_nameStringremote_idStringQuickbooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfile_nameStringremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.