sale/credit_note/add - Equotix One API

This adds a credit note to 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.

channel_id

integer

required

The channel ID to allocate this credit note to. Only accepts Equotix POS channel ID.

imported_order_id

string

required

The ID to be used from external channel.

customer_id

integer

required

The credit note customer ID. Use "0" to create a new customer.

firstname

string

required

The credit note first name.

lastname

string

required

The credit note last name.

company

string

required

The credit note company.

string

required

The credit note email.

telephone

string

required

The credit note telephone.

telephone_2

string

required

The credit note telephone 2.

currency

string

required

The credit note currency code. Must be already added into the account.

currency_value

number

required

The credit note currency value. Enter 0 for auto value.

payment_method

string

required

The credit note payment method.

total

number

required

The credit note total amount.

comment

string

required

The credit note comment.

products

array [object {7}]

required

The items in the credit note.

item_id

integer

required

The item ID.

name

string

required

The item name.

model

string

required

The item model code.

sku

string

required

The item sku code.

quantity

integer

required

The item quantity.

price

number

required

The item price.

cost

number

optional

The item cost. Only if API has view cost permission.

credit_note_status_id

integer

required

Set the default credit note status ID.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "channel_id": 0,
    "imported_order_id": "string",
    "customer_id": 0,
    "firstname": "string",
    "lastname": "string",
    "company": "string",
    "email": "string",
    "telephone": "string",
    "telephone_2": "string",
    "currency": "string",
    "currency_value": 0,
    "payment_method": "string",
    "total": 0,
    "comment": "string",
    "products": [
        {
            "item_id": 0,
            "name": "string",
            "model": "string",
            "sku": "string",
            "quantity": 0,
            "price": 0,
            "cost": 0
        }
    ],
    "credit_note_status_id": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

credit_note

object

optional

The credit note added.

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.

Example

{
    "error": [
        "string"
    ],
    "success": true,
    "credit_note": {
        "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
            }
        ]
    }
}