payments list
GET {{baseUrl}}/payments
Returns a list of Payment objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
account_id | string | If provided, will only return payments for this account. | |
contact_id | string | If provided, will only return payments for this contact. | |
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
company_id | string | If provided, will only return payments for this company. | |
transaction_date_after | string | ||
transaction_date_before | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"b26fd49a-cbae-470a-a8f8-bcbc119e0390","remote_id":"987300","created_at":"2021-09-15T00:00:00Z","modified_at":"2021-10-16T00:00:00Z","transaction_date":"2020-03-31T00:00:00Z","contact":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","account":"d6e687d6-0c36-48a1-8114-35324b5cb38f","currency":"FKP","exchange_rate":"2.9","company":"595c8f97-2ac4-45b7-b000-41bdf43240b5","total_amount":50,"type":"ACCOUNTS_PAYABLE","tracking_categories":["40fef189-8fed-639b-b294-870f4c6457e5","urn:uuid:0bb19309-454e-01a2-c6a1-2e537ee42fb8"],"accounting_period":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","applied_to_lines":[{"id":"ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id":"234","created_at":"2021-09-15T00:00:00Z","modified_at":"2021-10-16T00:00:00Z","applied_amount":"-6920804065849.834598864050469","applied_date":"2020-03-31T00:00:00Z","related_object_id":"92e8a369-fffe-430d-b93a-f7e8a16563f1","related_object_type":"INVOICE"},{"id":"ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id":"234","created_at":"2021-09-15T00:00:00Z","modified_at":"2021-10-16T00:00:00Z","applied_amount":"-535742224397171.203458161","applied_date":"2020-03-31T00:00:00Z","related_object_id":"92e8a369-fffe-430d-b93a-f7e8a16563f1","related_object_type":"INVOICE"}],"remote_updated_at":"2020-03-31T00:00:00Z","remote_was_deleted":true,"field_mappings":{"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},"remote_data":[{"path":"/actions","data":["Varies by platform"]}]}]}