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

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

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