Skip to main content

Purpose

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

HTTP Request

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

Path Parameters

ParameterTypeDescription
idnumberUnique identifier of the receipt you want to inspect.

Request Example

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

Response

200 OK — Receipt

{
  "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,
    "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,
    "receipt_products": [
      {
        "id": 14,
        "cid": "f5b17d93-5586-411b-9e9d-934d3aa2e2ff",
        "product_id": 31042,
        "total": 22000,
        "price": 22000,
        "count": 1,
        "meta": {
          "product": {
            "name": "Апельсинли реване",
            "giftable": false,
            "price": 22000,
            "modifier_name": "not found",
            "discountable": true,
            "sold_by_weight": false,
            "priceWithoutTaxes": 22000,
            "barcode": null,
            "taxes": [],
            "station": {
              "id": 57,
              "name": "Отдел Кондитер"
            }
          }
        }
      },
      {
        "id": 15,
        "cid": "c5202cc3-1f03-47b1-9dbc-5f049dabf997",
        "product_id": 31046,
        "total": 8000,
        "price": 8000,
        "count": 1,
        "meta": {
          "product": {
            "name": "Ачма узум жевиз",
            "giftable": false,
            "price": 8000,
            "modifier_name": "not found",
            "discountable": true,
            "sold_by_weight": false,
            "priceWithoutTaxes": 8000,
            "barcode": null,
            "taxes": [],
            "station": {
              "id": 57,
              "name": "Отдел Кондитер"
            }
          }
        }
      }
    ],
    "properties": {
      "daily_id": 1,
      "monthly_id": 1
    }
  },
  "time": 50,
  "timestamp": "2025-10-06 09:24:53",
  "unix": 1759742693
}

404 Not Found — Invalid ID

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

Field Reference

FieldTypeDescription
idnumberReceipt identifier.
statusnumberWorkflow status code (2 = closed).
totalnumberTotal paid amount.
payment_methodsarrayDetailed payment method breakdown.
receipt_productsarrayItems included in the receipt.
meta.sale_type.namestringName of the sale type used.
shift_datestringBusiness day the receipt belongs to.

Notes

  • Closed receipts store the final POS totals; quantities and amounts cannot be edited through this endpoint.
  • Use receipt_products for reconciliation with inventory or accounting systems.
  • Combine with the list endpoint when you need to cross-check totals before exporting reports.