Attachments
TheAccountingAttachment
object is used to represent a company's attachments.The AccountingAttachment object
Properties
id
Stringremote_id
Stringremote_data
RemoteData[]file_name
Stringfile_url
Stringcompany
Stringremote_was_deleted
Booleanfield_mappings
Object{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/attachments
Returns a list of AccountingAttachment
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
company_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String/attachments
Creates an AccountingAttachment
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
file_name
Stringfile_url
Stringcompany
Stringid
field in the Company table.integration_params
Objectlinked_account_params
Object{"model": {"file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"}}
{"model": {"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

Xero
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
file_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
integration_params
Objecttransaction
Stringtransaction_name
String
FreshBooks

NetSuite

QuickBooks Online

Sage Intacct
/attachments/{id}
Returns an AccountingAttachment
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Boolean{"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id": "1018270","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"file_name": "invoice.png","file_url": "https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String/attachments/meta/post
Returns metadata for AccountingAttachment
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String