vendor credits list
GET {{baseUrl}}/vendor-credits
Returns a list of VendorCredit objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
company_id | string | If provided, will only return vendor credits for this company. | |
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 marked as deleted by third party webhooks. | |
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. | |
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":"ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id":"088899","remote_data":[{"path":"cupidatat aute dolor non","data":{"veniam9":{},"minima8f":{}}},{"path":"magna cupidatat nulla Ut","data":{"laborum7":{}}}],"number":"6","transaction_date":"2020-03-31T00:00:00Z","vendor":"3d263469-51a1-4766-9205-f6c997826be1","total_amount":10000,"currency":"PEI","exchange_rate":"2.9","company":"595c8f97-2ac4-45b7-b000-41bdf43240b5","lines":[{"remote_id":"121222","net_amount":25.54,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","description":"Gifted Merge Credit","account":"9d892439-5fab-4dbb-8bd8-34f7f96c7912"},{"remote_id":"121223","net_amount":10,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","description":"Refund for overpayment","account":"9d892439-5fab-4dbb-8bd8-34f7f96c7912"}],"remote_was_deleted":true},{"id":"ecbe05ac-62a3-46c5-ab31-4b478b37d1b4","remote_id":"088899","remote_data":[{"path":"ea c","data":{"do_1_6":{},"adipisicingc67":{},"aliquip_f0":{}}},{"path":"sunt Lorem enim et","data":{"sint_654":{}}}],"number":"6","transaction_date":"2020-03-31T00:00:00Z","vendor":"3d263469-51a1-4766-9205-f6c997826be1","total_amount":10000,"currency":"EEK","exchange_rate":"2.9","company":"595c8f97-2ac4-45b7-b000-41bdf43240b5","lines":[{"remote_id":"121222","net_amount":25.54,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","description":"Gifted Merge Credit","account":"9d892439-5fab-4dbb-8bd8-34f7f96c7912"},{"remote_id":"121223","net_amount":10,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","description":"Refund for overpayment","account":"9d892439-5fab-4dbb-8bd8-34f7f96c7912"}],"remote_was_deleted":false}]}