Payments
ThePayment object is used to represent a invoice's payment.The Payment object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
remote_dataRemoteData[]Optional
transaction_dateStringOptional
The payment's transaction date.
contactStringOptional
accountStringOptional
total_amountNumberOptional
The payment's total amount.
remote_updated_atStringOptional
When the third party's payment entry was updated.
remote_was_deletedBooleanRequired
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
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
account_idStringOptional
If provided, will only return payments for this account.
contact_idStringOptional
If provided, will only return payments for this contact.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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
contactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateString
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateString
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateString
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/payments/{id}
Returns a Payment object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
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
contactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateStringQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateStringXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringcontactStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtotal_amountNumbertransaction_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.