Payments

The Payment object is used to represent a invoice's payment.

The Payment object

Properties


idString
Optional

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

remote_dataRemoteData[]
Optional

transaction_dateString
Optional
The payment's transaction date.

contactString
Optional
The payment's contact.

accountString
Optional
The payment's account.

total_amountNumber
Optional
The payment's total amount.

remote_updated_atString
Optional
When the third party's payment entry was updated.

The Payment object

{
  "id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
  "remote_id": "987300",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "transaction_date": "2020-03-31T00:00:00Z",
  "contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "account": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
  "total_amount": 50,
  "remote_updated_at": "2020-03-31T00:00:00Z"
}

GET

/payments

Returns a list of Payment objects.


Query & Path Parameters


account_idString
Optional
If provided, will only return payments for this account.

contact_idString
Optional
If provided, will only return payments for this contact.

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": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
      "remote_id": "987300",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "transaction_date": "2020-03-31T00:00:00Z",
      "contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
      "account": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
      "total_amount": 50,
      "remote_updated_at": "2020-03-31T00:00:00Z"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


transaction_dateString

remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

accountString

contactString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


transaction_dateString

remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

accountString

contactString

remote_idString
GET

/payments/{id}

Returns a Payment 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": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
  "remote_id": "987300",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "transaction_date": "2020-03-31T00:00:00Z",
  "contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "account": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
  "total_amount": 50,
  "remote_updated_at": "2020-03-31T00:00:00Z"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


transaction_dateString

remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

accountString

contactString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


transaction_dateString

remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

accountString

contactString

remote_idString