Skip to main content

​
Purpose

Speeds up your reconciliation flows by listing sales receipts by date, amount, or status.

​
HTTP Request

GET https://integrations.clopos.com/open-api/v2/receipts

​
Authorization

The following headers are mandatory:
  • x-token

​
Request Example

curl --location --globoff "https://integrations.clopos.com/open-api/v2/receipts?page=1&sort[0]=created_at&sort[1]=-1&limit=50&date[0]=2025-08-12&date[1]=2025-08-18" \
  -H "x-token: oauth_example_token" \

​
Response

​
200 OK — List of receipts

{
  "success": true,
  "data": [
    {
      "id": 1,
      "venue_id": 1,
      "cid": "43025959-0e82-4fbd-bcc7-1bc0101183b7",
      "user_id": 1,
      "terminal_id": 1,
      "source": "web",
      "sale_type_id": 1000,
      "guests": 1,
      "status": 2,
      "lock": false,
      "inventory_status": 0,
      "report_status": 3,
      "meta": {
        "preprint_count": 0,
        "sale_type": {
          "name": "Satis usulu 1"
        },
        "user": {
          "name": "Clopos"
        },
        "terminal_updated_at": 1755524813947,
        "availiableDeposit": 30000,
        "check_close_event": {
          "checked": true,
          "operated_at": "2025-08-19 16:01:16",
          "fails": []
        }
      },
      "printed": false,
      "total": 30000,
      "subtotal": 30000,
      "original_subtotal": 30000,
      "gift_total": 0,
      "payment_methods": [
        {
          "id": 1,
          "name": "Cash",
          "amount": 30000
        }
      ],
      "by_cash": 30000,
      "by_card": 0,
      "remaining": 0,
      "discount_type": 0,
      "discount_value": 0,
      "discount_rate": 0,
      "service_charge": 0,
      "service_charge_value": 0,
      "delivery_fee": 0,
      "total_tax": 0,
      "created_at": "2025-08-18 13:45:16",
      "updated_at": "2025-08-19 16:54:15",
      "closed_at": "2025-08-18 14:47:05",
      "shift_date": "2025-08-18",
      "deleted_at": null,
      "properties": {
        "daily_id": 1,
        "monthly_id": 1
      }
    }
  ],
  "total": 1,
  "time": 142,
  "timestamp": "2025-10-06 09:19:49",
  "unix": 1759742389,
  "sorts": [
    "id",
    "cid",
    "user_id",
    "terminal_id",
    "table_id",
    "hall_id",
    "customer_id",
    "status",
    "guests",
    "total",
    "subtotal",
    "totalCost",
    "gift_total",
    "remaining",
    "suspicion",
    "discount_type",
    "discount_value",
    "discount_rate",
    "service_charge",
    "created_at",
    "updated_at",
    "closed_at",
    "deleted_at",
    "products.status",
    "products.type",
    "delivery_fee",
    "loyalty_value",
    "total_tax"
  ]
}

​
400 Bad Request — Parameter error

{
  "success": false,
  "error": "invalid_parameter",
  "message": "sort[1] must be 1 or -1"
}

​
401 Unauthorized — Missing header

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing authentication headers"
}

​
Field Reference

​
Top-level fields

FieldTypeDescription
successbooleanIndicates the result of the request.
dataarrayList of receipt objects.
totalnumberTotal number of receipts matching filters.
timenumberResponse time in milliseconds.
timestampstringServer timestamp (YYYY-MM-DD HH:mm:ss).
unixnumberUnix timestamp in seconds.
sortsarrayAvailable sort fields.

​
Receipt object (selected fields)

FieldTypeDescription
idnumberUnique receipt identifier.
cidstringTransaction UUID.
statusnumberReceipt status code.
sale_type_idnumberSale type identifier.
totalnumberTotal amount collected.
subtotalnumberSubtotal before adjustments.
by_cashnumberAmount paid in cash.
by_cardnumberAmount paid by card.
payment_methodsarrayDetailed payment method breakdown.
metaobjectAdditional metadata such as sale type and user.
created_atstringReceipt creation time (YYYY-MM-DD HH:mm:ss).
closed_atstringReceipt close time (YYYY-MM-DD HH:mm:ss).
shift_datestringShift date associated with the receipt.
propertiesobjectOther derived identifiers (e.g., daily_id).

​
payment_methods[]

FieldTypeDescription
idnumberPayment method ID.
namestringPayment method name.
amountnumberAmount paid using this method.

​
Notes

  • Use the date[0] and date[1] filters to restrict receipts to a date range (inclusive, YYYY-MM-DD).
  • Sorting accepts multiple fields (sort[0], sort[1], etc.); directions must be 1 (ascending) or -1 (descending).
  • Pagination uses classic page and limit semantics; the default limit is 50.
  • Combine status, sale_type_id, and terminal_id filters via the OpenAPI explorer when you need more granular reporting.
  • Inspect sorts in the response to discover additional sortable fields supported by the API.
  • Directly created receipts do not trigger POS notifications or external updates; they are saved closed for reconciliation.