Attachments

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

The AccountingAttachment object

Properties


idString
Optional

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

remote_dataRemoteData[]
Optional

file_nameString
Optional
The attachment's name.

file_urlString
Optional
The attachment's url.

The AccountingAttachment 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"
}

GET

/attachments

Returns a list of AccountingAttachment objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

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

Response

{
  "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"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

file_nameString

file_urlString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

file_nameString

remote_idString
GET

/attachments/{id}

Returns an AccountingAttachment object with the given id.


Query & Path Parameters


idString
Required

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

Response

{
  "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"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

file_nameString

file_urlString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

file_nameString

remote_idString