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
This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination (1-based).
​
limit
integer
default:"50"
Number of receipts per page.
​
date[0]
string
Start date of a created_at range, inclusive. Format: YYYY-MM-DD. Pair with date[1].
​
date[1]
string
End date of a created_at range, inclusive. Format: YYYY-MM-DD.
​
sort[0]
string
Field to sort by (e.g. created_at, updated_at, closed_at, total). Inspect the sorts array in the response to discover all sortable fields the API currently supports.
​
sort[1]
integer
Sort direction: 1 = ascending, -1 = descending.
​
with[]
array[string]
Related resources to include in each receipt. Repeat with indexed brackets (e.g. with[0]=receipt_products&with[1]=receipt_products.modificators). Common values:
  • receipt_products — line items on each receipt
  • receipt_products.modificators — modifiers applied to each line item
  • receipt_products.product.unit, receipt_products.product.station — product relations
​
filters[N]
array
Field-level filter tuples using PHP bracket notation: filters[N][0]=field_name&filters[N][1]=value. Stack filters by incrementing N (0-based). Commonly used with status, sale_type_id, terminal_id.

​
Request Example

# Basic request with filters
curl --location --globoff "https://integrations.clopos.com/open-api/v2/receipts?page=1&sort[0]=created_at&sort[1]=-1&limit=50&date[0]=2026-01-19&date[1]=2026-01-19" \
  -H "x-token: oauth_example_token"

# With products and modifiers
curl --location --globoff "https://integrations.clopos.com/open-api/v2/receipts?page=1&sort[0]=created_at&sort[1]=-1&limit=50&date[0]=2026-01-19&date[1]=2026-01-19&with[0]=receipt_products.product.unit&with[1]=receipt_products.product.station&with[2]=receipt_products.modificators.modificator_group" \
  -H "x-token: oauth_example_token"

​
Response

​
200 OK — List of receipts

{
  "success": true,
  "data": [
    {
      "id": 1,
      "venue_id": 1,
      "cid": "96ab5d26-d6bb-4976-a6f8-9e8806ef6aa5",
      "customer_id": null,
      "sale_type_id": 2,
      "source": "web",
      "guests": 1,
      "status": 2,
      "order_status": "IN_PROGRESS",
      "order_number": "006",
      "lock": false,
      "total": 33000,
      "subtotal": 33000,
      "discount_type": 0,
      "discount_value": 0,
      "discount_rate": 0,
      "total_discount": 0,
      "service_charge": 0,
      "service_charge_value": 0,
      "delivery_fee": 0,
      "remaining": 0,
      "i_tax": 0,
      "e_tax": 0,
      "total_tax": 0,
      "payment_methods": [
        {
          "id": 1,
          "name": "Cash",
          "amount": 33000
        }
      ],
      "fiscal_id": null,
      "loyalty_type": null,
      "loyalty_value": null,
      "address": null,
      "description": null,
      "created_at": "2026-01-19 14:51:33",
      "updated_at": "2026-01-19 15:07:49",
      "closed_at": "2026-01-19 15:07:49",
      "shift_date": "2026-01-19"
    }
  ],
  "total": 1
}

​
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

​
Receipt object

FieldTypeDescription
idnumberUnique receipt identifier.
cidstringClient-generated UUID for the receipt.
venue_idnumberVenue (location) the receipt belongs to.
customer_idnumber|nullCustomer associated with the receipt.
sale_type_idnumberSale type identifier (e.g., dine-in, delivery).
sourcestringOrigin of the receipt (e.g., "web", "pos").
guestsnumberNumber of guests on the receipt.
statusnumberReceipt status: 1 = open, 2 = closed.
order_statusstringOrder workflow status. One of: NEW, SCHEDULED, IN_PROGRESS, READY, PICKED_UP, COMPLETED, CANCELLED.
order_numberstring|nullExternal or display order number.
lockbooleanWhether the receipt is locked from further changes.
totalnumberTotal amount collected.
subtotalnumberSubtotal before discounts, taxes, and fees.
discount_typenumberDiscount type applied (0 = none).
discount_valuenumberDiscount amount or percentage value.
discount_ratenumberEffective discount rate.
total_discountnumberTotal discount applied to the receipt.
service_chargenumberService charge percentage.
service_charge_valuenumberCalculated service charge amount.
delivery_feenumberDelivery fee amount.
remainingnumberOutstanding balance (0 when fully paid).
i_taxnumberInclusive tax amount.
e_taxnumberExclusive tax amount.
total_taxnumberTotal tax amount (inclusive + exclusive).
payment_methodsarrayPayment breakdown. See Payment method.
fiscal_idstring|nullFiscal receipt identifier for tax reporting.
loyalty_typestring|nullLoyalty program type applied.
loyalty_valuenumber|nullLoyalty discount or points value.
addressstring|nullDelivery address.
descriptionstring|nullDelivery or order notes.
created_atstringReceipt creation time (YYYY-MM-DD HH:mm:ss).
updated_atstringLast update time (YYYY-MM-DD HH:mm:ss).
closed_atstring|nullReceipt close time (YYYY-MM-DD HH:mm:ss).
shift_datestringBusiness day the receipt belongs to (YYYY-MM-DD).
See Payment method for the payment_methods[] structure.

​
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 date filters via the OpenAPI explorer when you need more granular reporting.
  • The response also includes time, timestamp, unix, and sorts fields for diagnostics and discovering sortable fields; these are omitted from examples for brevity.