Skip to main content

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.

​
Purpose

Fetch the final state of a single receipt, including payment breakdowns and line items.

​
HTTP Request

GET https://integrations.clopos.com/open-api/v2/receipts/{id}
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.

​
Path Parameters

ParameterTypeDescription
idnumberUnique identifier of the receipt you want to inspect.

​
Query Parameters

​
with[]
string
Include related resources in the response. Supported values:
  • receipt_products — line items on the receipt
  • receipt_products.modificators — modifiers applied to each line item

​
Request Example

# Basic request
curl --location "https://integrations.clopos.com/open-api/v2/receipts/1" \
  -H "x-token: oauth_example_token"

# With products and modifiers (note: --globoff to avoid shell globbing)
curl --location --globoff "https://integrations.clopos.com/open-api/v2/receipts/1?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 — Receipt

{
  "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": 30000,
    "subtotal": 30000,
    "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": 30000
      }
    ],
    "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",
    "receipt_products": [
      {
        "id": 1,
        "cid": "0fd784b1-ee5a-4745-a130-a849b4e5db2f",
        "product_id": 51,
        "count": 1,
        "portion_size": 1,
        "total": 10,
        "price": 10,
        "subtotal": 10,
        "is_gift": false,
        "discount_type": 0,
        "discount_value": 0,
        "discount_rate": 0,
        "total_discount": 0,
        "receipt_discount": 0,
        "loyalty_type": null,
        "loyalty_value": null,
        "meta": {
          "product": {
            "name": "Test_Margherita Pizza",
            "type": "DISH",
            "price": 10,
            "barcode": null
          }
        },
        "modificators": [],
        "created_at": "2026-01-19 14:51:34",
        "updated_at": "2026-01-19 15:07:53"
      }
    ]
  }
}

​
404 Not Found — Invalid ID

{
  "success": false,
  "error": "not_found",
  "message": "Receipt not found"
}

​
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.

​
receipt_products[]

Included when with[]=receipt_products is passed. Each item represents one line on the receipt.
FieldTypeDescription
idintegerLine item identifier.
cidstringClient-generated UUID for the line item.
product_idintegerProduct ID from your catalog.
countintegerQuantity ordered.
portion_sizeintegerPortion size multiplier (usually 1).
totalnumberLine total after adjustments.
pricenumberUnit price at the time of sale.
subtotalnumberSubtotal before receipt-level discounts.
is_giftbooleanWhether this item was given as a complimentary gift.
discount_typeintegerDiscount type on this line item (0 = none).
discount_valuenumberDiscount amount or percentage.
discount_ratenumberEffective discount rate.
total_discountnumberTotal discount on this line item.
receipt_discountnumberPortion of the receipt-level discount allocated to this item.
loyalty_typestring (nullable)Loyalty program type applied to this item.
loyalty_valuenumber (nullable)Loyalty points or discount value.
meta.product.namestringProduct name at the time of sale.
meta.product.typestringProduct type (DISH, GOODS, etc.).
meta.product.pricenumberProduct’s catalog price at the time of sale.
meta.product.barcodestring (nullable)Product barcode.
modificatorsarrayModifiers applied to this item. Included when with[]=receipt_products.modificators is passed. Empty array if none.
created_atstringWhen the line item was added (YYYY-MM-DD HH:mm:ss).
updated_atstringLast update time (YYYY-MM-DD HH:mm:ss).

​
Notes

  • Closed receipts store the final totals; quantities and amounts cannot be edited through this endpoint.
  • Use receipt_products for reconciliation with inventory or accounting systems.
  • The response also includes time, timestamp, and unix fields for diagnostics; these are omitted from the example for brevity.
  • Combine with the list endpoint when you need to cross-check totals before exporting reports.