Light Mode

List Invoices

GET/orders/invoices

Last modified: 2 months ago

This endpoint allows you to fetch a list of order invoices.

`orders.read` - Orders Read Only

Request

Query Params

from_date

string

optional

Invoice Date Range (from)

to_date

string

optional

Invoice Date Range (to)

order_id

integer

optional

Order ID. List of Order ID can be found here.

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1479538730,
      "order_id": 1557892161,
      "type": "Credit Note",
      "sub_total": {
        "amount": "1000.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "151.50",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 1161.5,
        "currency": "SAR"
      },
      "date": "2021-12-03"
    },
    {
      "id": 1692688589,
      "order_id": 1557892161,
      "type": "Tax Invoice",
      "sub_total": {
        "amount": "29.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "5.85",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 44.85,
        "currency": "SAR"
      },
      "date": "2021-12-03"
    },
    {
      "id": 1219192926,
      "order_id": 1557892161,
      "type": "Tax Invoice",
      "sub_total": {
        "amount": "850.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "25.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "132.75",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 1017.75,
        "currency": "SAR"
      },
      "date": "2021-12-04"
    }
  ],
  "pagination": {
    "count": 3,
    "total": 3,
    "perPage": 3,
    "currentPage": 1,
    "totalPages": 1,
    "links": {
      "next": null
    }
  }
}

Last modified: 2 months ago