Retrieve POS invoice history

GET

/api/method/public/invoice-history/get-pos-invoices

Think of this call as retrieving the cash register tape. It lists every submitted POS Invoice that belongs to the restaurant branch or brand attached to the access token. Use it to feed accounting systems or analytics tools. Provide a start and end datetime so the export is limited to the window you care about.

Request

Authorization

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Query Params

Responses

🟢200OK

application/json

Array of summarized POS invoices. Each invoice lists whether it is a return, the net and gross totals, and a breakdown of every tax collected.

Body

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/method/public/invoice-history/get-pos-invoices?from_date&to_date' \
--header 'X-Access-Token: <api-key>'

Response Example

200 - Example 1

{
    "message": [
        {
            "id": "string",
            "is_return": 0,
            "discount": 0,
            "timestamp": "2019-08-24T14:15:22.123Z",
            "sub_total": 0,
            "total": 0,
            "taxes_and_charges": [
                {
                    "title": "string",
                    "tax_amount": 0,
                    "tax_amount_after_discount_amount": 0
                }
            ]
        }
    ]
}

⚠️ Disclaimer

List menu categories