Get Receipt by ID

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

Parameter	Type	Description
`id`	number	Unique identifier of the receipt you want to inspect.

Query Parameters

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"

const receiptId = 1;
const headers = { 'x-token': 'oauth_example_token' };

// Basic request
const response = await fetch(
  `https://integrations.clopos.com/open-api/v2/receipts/${receiptId}`,
  { headers }
);
const receipt = await response.json();

// With products and modifiers
const params = new URLSearchParams({
  'with[0]': 'receipt_products.product.unit',
  'with[1]': 'receipt_products.product.station',
  'with[2]': 'receipt_products.modificators.modificator_group'
});

const responseWithProducts = await fetch(
  `https://integrations.clopos.com/open-api/v2/receipts/${receiptId}?${params}`,
  { headers }
);
const receiptWithProducts = await responseWithProducts.json();

import requests

receipt_id = 1
url = f"https://integrations.clopos.com/open-api/v2/receipts/{receipt_id}"
headers = {
    "x-token": "oauth_example_token",
}

# Basic request
response = requests.get(url, headers=headers)
receipt = response.json()

# With products and modifiers
params = {
    "with[0]": "receipt_products.product.unit",
    "with[1]": "receipt_products.product.station",
    "with[2]": "receipt_products.modificators.modificator_group"
}

response = requests.get(url, headers=headers, params=params)
receipt_with_products = response.json()

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

Field	Type	Description
`id`	number	Unique receipt identifier.
`cid`	string	Client-generated UUID for the receipt.
`venue_id`	number	Venue (location) the receipt belongs to.
`customer_id`	number\|null	Customer associated with the receipt.
`sale_type_id`	number	Sale type identifier (e.g., dine-in, delivery).
`source`	string	Origin of the receipt (e.g., `"web"`, `"pos"`).
`guests`	number	Number of guests on the receipt.
`status`	number	Receipt status: `1` = open, `2` = closed.
`order_status`	string	Order workflow status. One of: `NEW`, `SCHEDULED`, `IN_PROGRESS`, `READY`, `PICKED_UP`, `COMPLETED`, `CANCELLED`.
`order_number`	string\|null	External or display order number.
`lock`	boolean	Whether the receipt is locked from further changes.
`total`	number	Total amount collected.
`subtotal`	number	Subtotal before discounts, taxes, and fees.
`discount_type`	number	Discount type applied (0 = none).
`discount_value`	number	Discount amount or percentage value.
`discount_rate`	number	Effective discount rate.
`total_discount`	number	Total discount applied to the receipt.
`service_charge`	number	Service charge percentage.
`service_charge_value`	number	Calculated service charge amount.
`delivery_fee`	number	Delivery fee amount.
`remaining`	number	Outstanding balance (0 when fully paid).
`i_tax`	number	Inclusive tax amount.
`e_tax`	number	Exclusive tax amount.
`total_tax`	number	Total tax amount (inclusive + exclusive).
`payment_methods`	array	Payment breakdown. See Payment method.
`fiscal_id`	string\|null	Fiscal receipt identifier for tax reporting.
`loyalty_type`	string\|null	Loyalty program type applied.
`loyalty_value`	number\|null	Loyalty discount or points value.
`address`	string\|null	Delivery address.
`description`	string\|null	Delivery or order notes.
`created_at`	string	Receipt creation time (YYYY-MM-DD HH:mm:ss).
`updated_at`	string	Last update time (YYYY-MM-DD HH:mm:ss).
`closed_at`	string\|null	Receipt close time (YYYY-MM-DD HH:mm:ss).
`shift_date`	string	Business 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.

Field	Type	Description
`id`	integer	Line item identifier.
`cid`	string	Client-generated UUID for the line item.
`product_id`	integer	Product ID from your catalog.
`count`	integer	Quantity ordered.
`portion_size`	integer	Portion size multiplier (usually `1`).
`total`	number	Line total after adjustments.
`price`	number	Unit price at the time of sale.
`subtotal`	number	Subtotal before receipt-level discounts.
`is_gift`	boolean	Whether this item was given as a complimentary gift.
`discount_type`	integer	Discount type on this line item (`0` = none).
`discount_value`	number	Discount amount or percentage.
`discount_rate`	number	Effective discount rate.
`total_discount`	number	Total discount on this line item.
`receipt_discount`	number	Portion of the receipt-level discount allocated to this item.
`loyalty_type`	string (nullable)	Loyalty program type applied to this item.
`loyalty_value`	number (nullable)	Loyalty points or discount value.
`meta.product.name`	string	Product name at the time of sale.
`meta.product.type`	string	Product type (`DISH`, `GOODS`, etc.).
`meta.product.price`	number	Product’s catalog price at the time of sale.
`meta.product.barcode`	string (nullable)	Product barcode.
`modificators`	array	Modifiers applied to this item. Included when `with[]=receipt_products.modificators` is passed. Empty array if none.
`created_at`	string	When the line item was added (`YYYY-MM-DD HH:mm:ss`).
`updated_at`	string	Last 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.

Overview

Auth

Venues

Users

Customers

Categories

Station

Products

Price Lists

Sales

Orders

Receipts

Tables

Purpose

HTTP Request

Path Parameters

Query Parameters

Request Example

Response

200 OK — Receipt

404 Not Found — Invalid ID

Field Reference

Receipt object

`receipt_products[]`

Notes

​Purpose

​HTTP Request

​Path Parameters

​Query Parameters

​Request Example

​Response

​200 OK — Receipt

​404 Not Found — Invalid ID

​Field Reference

​Receipt object

​receipt_products[]

​Notes

Purpose

HTTP Request

Path Parameters

Query Parameters

Request Example

Response

200 OK — Receipt

404 Not Found — Invalid ID

Field Reference

Receipt object

`receipt_products[]`

Notes