Skip to main content
GET
/
receipts
List receipts
curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/receipts \
  --header 'x-token: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "venue_id": 123,
      "cid": "<string>",
      "user_id": 123,
      "terminal_id": 123,
      "source": "<string>",
      "customer_id": 123,
      "sale_type_id": 123,
      "guests": 123,
      "status": 123,
      "lock": true,
      "total": 123,
      "subtotal": 123,
      "payment_methods": [
        {
          "id": 123,
          "name": "<string>",
          "amount": 123
        }
      ],
      "fiscal_id": "<string>",
      "discount_type": 123,
      "discount_value": 123,
      "service_charge": 123,
      "delivery_fee": 123,
      "order_status": "<string>",
      "order_number": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "closed_at": "<string>",
      "deleted_at": "<string>"
    }
  ],
  "total": 123,
  "time": 123,
  "timestamp": "<string>",
  "unix": 123
}

Documentation Index

Fetch the complete documentation index at: https://developer.clopos.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-token
string
header
required

JWT access token obtained from /v2/auth endpoint

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:50

Number of receipts to return per page (1-200)

Required range: 1 <= x <= 200
​
sort[0]
string
default:created_at

Primary sort field

​
sort[1]
enum<integer>
default:-1

Primary sort direction (1 = ascending, -1 = descending)

Available options:
1,
-1
​
date[0]
string<date>

Start date (inclusive) in YYYY-MM-DD format

​
date[1]
string<date>

End date (inclusive) in YYYY-MM-DD format

Response

200 - application/json

Receipts retrieved successfully

​
success
boolean
​
data
object[]
​
total
integer
​
time
integer
​
timestamp
string
​
unix
integer