Attachments
The
AccountingAttachment object is used to represent a company's attachments.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
file_nameStringThe attachment's name.
file_urlStringThe attachment's url.
companyUUIDThe company the accounting attachment belongs to.
remote_was_deletedBooleanIndicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/attachments
https://api.merge.dev/api/accounting/v1/attachments
US
EU
APAC
Returns a list of AccountingAttachment objects.
Query & path parameters
company_idStringOptional
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.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringfile_urlStringremote_dataRemoteData[]pathstringdatastringremote_idString
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringfile_urlStringremote_dataRemoteData[]pathstringdatastringremote_idStringPOST
/attachments
https://api.merge.dev/api/accounting/v1/attachments
US
EU
APAC
Creates an AccountingAttachment object with the given values. To run asynchronously, see our guide.
Query & path parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.file_nameStringThe attachment's name.
file_urlStringThe attachment's url.
companyUUIDThe 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_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
file_typeStringRequired
transaction_merge_idStringRequired
transaction_typeStringRequired
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
file_typeStringRequired
transaction_merge_idStringRequired
transaction_typeStringRequired
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
folder_nameStringRequired
supdocidStringRequired
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
transactionStringRequired
transaction_idStringRequired
transaction_nameStringRequired
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
APAC
Returns an AccountingAttachment object with the given id.
Query & path parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringfile_urlStringremote_dataRemoteData[]pathstringdatastringremote_idStringSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
file_nameStringfile_urlStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/attachments/meta/post
https://api.merge.dev/api/accounting/v1/attachments/meta/post
US
EU
APAC
Returns metadata for AccountingAttachment POSTs.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
file_typeStringRequired
transaction_merge_idStringRequired
transaction_typeStringRequired
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
file_typeStringRequired
transaction_merge_idStringRequired
transaction_typeStringRequired
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
folder_nameStringRequired
supdocidStringRequired
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
file_nameStringRequired
file_urlStringRequired
remote_idStringOptional
Additional POST Parameters
integration_paramsObjectRequired
transactionStringRequired
transaction_idStringRequired
transaction_nameStringRequired