sale/credit_note/get - Equotix One API

This returns the list of credit notes available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

credit_note_id

integer

optional

The credit note ID to search for specifically.

filter_order_id

integer

optional

Filter the list based on order ID.

filter_customer_id

integer

optional

Filter the list based on customer ID.

filter_channel_id

integer

optional

Filter the list based on channel ID.

filter_name

string

optional

Filter the list based on name.

filter_email

string

optional

Filter the list based on email.

filter_telephone

string

optional

Filter the list based on the telephone.

filter_credit_note_status

string

optional

Filter the list based on the credit note status ID, comma separated.

filter_payment_method

string

optional

Filter the list based on the credit note payment method.

filter_date_start

string

optional

Filter the list by records after the specified date time based on the filter date type key.

filter_date_end

string

optional

Filter the list by records before the specified date time based on the filter date type key.

filter_date_type

string

optional

The key for the date start and date end filter. Accepts "date_added", "date_modified".

filter_deleted

integer

optional

Filter the list of credit notes to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "credit_note_id", "order_id", "name", "telephone", "total", "date_added", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "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

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

boolean

optional

The total number of results available.

credit_notes

array [object {27}]

optional

The list of credit notes available.

credit_note_id

integer

required

The credit note ID.

order_id

integer

required

The related order ID.

imported_order_id

string

required

The channel credit note ID.

location_id

integer

required

The location ID.

channel_id

integer

required

The channel ID.

channel

string

required

The channel name.

payment_method

string

required

The payment method.

customer_id

integer

required

The customer ID.

firstname

string

required

The credit note first name.

lastname

string

required

The credit note last name.

string

required

The credit note email.

name

string

required

The credit note first name and last name merged.

company

string

required

The credit note company.

telephone

string

required

The credit note telephone.

telephone_2

string

required

The credit note telephone 2.

credit_note_status

string

required

The credit note status.

credit_note_status_id

integer

required

The credit note status ID.

currency

string

required

The credit note currency code.

currency_value

number

required

The credit note currency value.

total

number

required

The credit note total.

cost

number

optional

The credit note cost if user has view permission.

date_added

string

required

The credit note date time added.

date_modified

string

required

The credit note date time modified.

comment

string

required

The credit note comment.

locked

boolean

required

Indicates if the credit note is locked from editing.

products

array [object {12}]

required

The credit note products.

deleted

boolean

optional

Indicates if the credit note has been deleted. Only returned if filter_deleted is "1".

Example

{
  "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
    }
  ]
}