Attachments
The AccountingAttachment object is used to represent a company's attachments.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

file_nameString
Optional
The attachment's name.

file_urlString
Optional
The attachment's url.

companyUUID
Optional
The company the accounting attachment belongs to.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/attachments

https://api.merge.dev/api/accounting/v1/attachments

US
EU

Returns a list of AccountingAttachment objects.


Query & Path Parameters

company_idString
Optional
If provided, will only return accounting attachments for this company.

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Xero
Xero
Not seeing an integration that you're looking for? Submit a request for it.
POST
/attachments

https://api.merge.dev/api/accounting/v1/attachments

US
EU

Creates an AccountingAttachment object with the given values.


Query & Path Parameters

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

file_nameString
The attachment's name.

file_urlString
The attachment's url.

companyUUID
The company the accounting attachment belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Company object.

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
QuickBooks Online
Xero
Xero
FreshBooks
FreshBooks
Coming soon
NetSuite
NetSuite
Coming soon
To include the correct model fields when making POST requests, use the GET /attachments/meta/post endpoint. Learn more in our /meta guide.
GET
/attachments/{id}

https://api.merge.dev/api/accounting/v1/attachments/{id}

US
EU

Returns an AccountingAttachment object with the given id.


Query & Path Parameters

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Xero
Xero
Not seeing an integration that you're looking for? Submit a request for it.
GET
/attachments/meta/post

https://api.merge.dev/api/accounting/v1/attachments/meta/post

US
EU

Returns metadata for AccountingAttachment POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
QuickBooks Online
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Xero
Xero
Not seeing an integration that you're looking for? Submit a request for it.