Skip to main content

​
Purpose

Update specific fields of a receipt using the PATCH method. Only the provided fields will be updated; all other fields remain unchanged. Important Notes:
  • The PATCH method can update receipts even after they are closed (when closed_at is not null).
  • Only limited fields can be updated via PATCH (see the field list below).
  • For comprehensive updates, use the Update Receipt method instead.

​
HTTP Request

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

​
Path Parameters

ParameterTypeDescription
idnumberUnique identifier of the receipt to update.

​
Request Body

Only the fields you want to update need to be included in the request body. Available updateable fields:
FieldTypeDescription
order_statusstringOrder status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED".
order_numberstringOrder number identifier (e.g., "RPO-00001").
fiscal_idstringFiscal receipt identifier.
lockbooleanLock status of the receipt (true or false).

​
Request Example

curl --location --request PATCH 'https://integrations.clopos.com/open-api/v2/receipts/1' \
  --header 'Content-Type: application/json' \
  --header 'x-token: oauth_example_token' \
  --data '{
    "order_status": "NEW",
    "order_number": "RPO-00001",
    "fiscal_id": "Twrewr89fnscvj22",
    "lock": false
}'

​
Response

​
200 OK — Receipt Updated

The response returns the full receipt data with all fields updated: 
{
    "success": true,
    "data": {
        "id": 1,
        "venue_id": 1,
        "cash_shift_cid": null,
        "cid": "43025959-0e82-4fbd-bcc7-1bc0101183b7",
        "user_id": 1,
        "open_by_user_id": null,
        "close_by_user_id": null,
        "courier_id": null,
        "seller_id": null,
        "terminal_id": 1,
        "source": "web",
        "closed_terminal_id": null,
        "service_notification_id": null,
        "table_id": null,
        "hall_id": null,
        "customer_id": null,
        "sale_type_id": 1000,
        "is_returns": null,
        "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": []
            }
        },
        "suspicion": 0,
        "printed": false,
        "total": 30000,
        "subtotal": 30000,
        "original_subtotal": 30000,
        "gift_total": 0,
        "totalCost": 0,
        "payment_methods": [
            {
                "id": 1,
                "name": "Cash",
                "amount": 30000
            }
        ],
        "fiscal_id": "Twrewr89fnscvj22",
        "by_cash": 30000,
        "by_card": 0,
        "remaining": 0,
        "discount_type": 0,
        "discount_value": 0,
        "discount_rate": 0,
        "rps_discount": 0,
        "service_charge": 0,
        "service_charge_value": 0,
        "i_tax": 0,
        "delivery_fee": 0,
        "e_tax": 0,
        "total_tax": 0,
        "description": null,
        "address": null,
        "terminal_version": null,
        "loyalty_type": null,
        "loyalty_value": null,
        "order_status": "NEW",
        "order_number": "RPO-00001",
        "created_at": "2025-08-18 13:45:16",
        "updated_at": "2025-10-29 12:43:07",
        "terminal_updated_at": null,
        "closed_at": "2025-08-18 14:47:05",
        "shift_date": "2025-08-18",
        "deleted_at": null,
        "total_discount": 0,
        "properties": {
            "daily_id": 1,
            "monthly_id": 1
        }
    },
    "message": "Əməliyyat uğurla həyata keçirildi",
    "time": 92,
    "timestamp": "2025-10-29 12:43:07",
    "unix": 1761741787
}

​
404 Not Found — Receipt Not Found

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

​
400 Bad Request — Validation Error

{
  "success": false,
  "error": "validation_failed",
  "message": "Invalid field values provided"
}

​
Field Reference

​
Updateable Fields

FieldTypeDescription
order_statusstringCurrent order status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED".
order_numberstringExternal order number or identifier.
fiscal_idstringFiscal receipt identifier used for tax reporting.
lockbooleanIf true, locks the receipt to prevent further modifications.

​
Notes

  • Only the fields provided in the request body will be updated; all other fields remain unchanged.
  • The response includes the complete receipt object with all fields, not just the updated ones.
  • Only the specified fields (order_status, order_number, fiscal_id, lock) can be updated through this endpoint.
  • Other receipt fields are read-only and cannot be modified via this API.
  • This method can update receipts even after they are closed (when closed_at is not null).
  • For comprehensive updates of multiple fields, use the Update Receipt method instead.