credit notes list
GET {{baseUrl}}/credit-notes
Returns a list of CreditNote objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 objects for this company. | |
transaction_date_before | string | ||
transaction_date_after | 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":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id":"123877","transaction_date":"2020-03-31T00:00:00Z","status":"SUBMITTED","total_amount":50,"remaining_credit":20,"currency":"IMP","remote_created_at":"2020-03-31T00:00:00Z","remote_updated_at":"2020-03-31T00:00:00Z","payments":["b26fd49a-cbae-470a-a8f8-bcbc119e0390"]},{"id":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","remote_id":"123877","transaction_date":"2020-03-31T00:00:00Z","status":"AUTHORIZED","total_amount":50,"remaining_credit":20,"currency":"TRY","remote_created_at":"2020-03-31T00:00:00Z","remote_updated_at":"2020-03-31T00:00:00Z","payments":["b26fd49a-cbae-470a-a8f8-bcbc119e0390"]}]}