Payments
ThePayment
object is used to represent a invoice's payment.The Payment object
Properties
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
remote_data
RemoteData[]Optional
transaction_date
StringOptional
The payment's transaction date.
contact
StringOptional
account
StringOptional
total_amount
NumberOptional
The payment's total amount.
remote_updated_at
StringOptional
When the third party's payment entry was updated.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
The Payment object
JSON
{"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","remote_was_deleted": true}
GET
/payments
Returns a list of Payment
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
account_id
StringOptional
If provided, will only return payments for this account.
contact_id
StringOptional
If provided, will only return payments for this contact.
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, will only return objects modified after this datetime.
modified_before
StringOptional
If provided, will only return objects modified before this datetime.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Response
JSON
{"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","remote_was_deleted": true}]}
Field support by platform

FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
StringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/payments/{id}
Returns a Payment
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"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","remote_was_deleted": true}
Field support by platform

FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
contact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringcontact
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringtotal_amount
Numbertransaction_date
StringHint: Use the /linked-accounts endpoint to pull platform support information.