sale/credit_note/get
POST/sale/credit_note/getThis returns the list of credit notes available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The credit note ID to search for specifically.
Filter the list based on order ID.
Filter the list based on customer ID.
Filter the list based on channel ID.
Filter the list based on name.
Filter the list based on email.
Filter the list based on the telephone.
Filter the list based on the credit note status ID, comma separated.
Filter the list based on the credit note payment method.
Filter the list by records after the specified date time based on the filter date type key.
Filter the list by records before the specified date time based on the filter date type key.
The key for the date start and date end filter. Accepts "date_added", "date_modified".
Filter the list of credit notes to include deleted records.
Page number of the results.
The key for the ordering of the results. Accepts "credit_note_id", "order_id", "name", "telephone", "total", "date_added", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"credit_note_id": 0,
"filter_order_id": 0,
"filter_customer_id": 0,
"filter_channel_id": 0,
"filter_name": "string",
"filter_email": "string",
"filter_telephone": "string",
"filter_credit_note_status": "string",
"filter_payment_method": "string",
"filter_date_start": "string",
"filter_date_end": "string",
"filter_date_type": "string",
"filter_deleted": 0,
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The total number of results available.
The list of credit notes available.
The credit note ID.
The related order ID.
The channel credit note ID.
The location ID.
The channel ID.
The channel name.
The payment method.
The customer ID.
The credit note first name.
The credit note last name.
The credit note email.
The credit note first name and last name merged.
The credit note company.
The credit note telephone.
The credit note telephone 2.
The credit note status.
The credit note status ID.
The credit note currency code.
The credit note currency value.
The credit note total.
The credit note cost if user has view permission.
The credit note date time added.
The credit note date time modified.
The credit note comment.
Indicates if the credit note is locked from editing.
The credit note products.
Indicates if the credit note has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"total": true,
"credit_notes": [
{
"credit_note_id": 0,
"order_id": 0,
"imported_order_id": "string",
"location_id": 0,
"channel_id": 0,
"channel": "string",
"payment_method": "string",
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"email": "string",
"name": "string",
"company": "string",
"telephone": "string",
"telephone_2": "string",
"credit_note_status": "string",
"credit_note_status_id": 0,
"currency": "string",
"currency_value": 0,
"total": 0,
"cost": 0,
"date_added": "string",
"date_modified": "string",
"comment": "string",
"locked": true,
"products": [
{
"credit_note_product_id": 0,
"imported_order_product_id": "string",
"item_id": 0,
"thumb": "string",
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"total": 0,
"cost": 0,
"restocked": true
}
],
"deleted": true
}
]
}