Get Checks
Production
https://api.simpra.app
Production
https://api.simpra.app
GET
https://api.simpra.app
Last modified:2026-07-30 09:20:57
Property| Parameter | Default | Description | Required |
|---|---|---|---|
| page | 1 | ||
| per_page | 50 | ||
| business_date | Example 2019-01-21 | ||
| business_date_since | Example 2019-01-21 | ||
| business_date_until | Example 2019-01-21 | ||
| status | open, closed, cancel, draft, new or merged | ||
| sort_by | desc | asc, desc | |
| updated_at | 0 | This value when zero returns all checks. Format unix time. | |
| closed_at_since | 0 | This value when zero returns all checks. Format unix time. | |
| closed_at_until | 0 | This value when zero returns all checks. Format unix time. | |
| revenue_center_id | |||
| table_id |
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.simpra.app/checks?page=undefined&per_page=undefined&business_date=undefined&business_date_since=undefined&business_date_until=undefined&status=undefined&sort_by=undefined&updated_at=undefined&closed_at_since=undefined&closed_at_until=undefined&revenue_center_id=undefined&table_id=undefined' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json'Response Response Example
{
"meta": {
"has_next_page": true,
"current_page": 1,
"per_page_count": 50,
"total_count": 1251,
"total_page": 26
},
"checks": [
{
"alias": null,
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"created_at": 1549914523,
"updated_at": 1549939599,
"closed_at": 1549939599,
"business_date": "2019-02-11",
"female_cover": 3,
"male_cover": 2,
"child_cover": 0,
"note": null,
"sequence": 933,
"status": "closed",
"delivery_status": "delivered",
"sequential_id": 424933,
"property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"revenue_center": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "GardenBro"
},
"shift_id": "b7fff683-2436-41e7-8961-2ca983cc0c33",
"employee": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Bro",
"phone_number": "123456789"
},
"table": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Bro 1#"
},
"sales_channel": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "POS"
},
"customer": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"first_name": "Big",
"last_name": "Brother",
"email": "big@brothers.com",
"phone_number": "123456789"
},
"delivery": {
"address": "BigBrother No.10",
"address_id": "ff1b69b1-a7de-4a74-8483-28a539ab8d70",
"recipient": null,
"payment_names": "Cash"
},
"extras": {
"portal_plus_invoice_int_id": 9643,
"portal_plus_tckn_or_vkn": "48342912",
"portal_plus_customer_name": "Brother A.Ş.",
"portal_plus_customer_email": "",
"portal_plus_customer_tax_office": "Esentepe",
"portal_plus_customer_address": "Haberler sok. No:12",
"portal_plus_notes": "",
"portal_plus_type": "einvoice"
},
"check_service_charge": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"service_charge_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"amount": "10.5",
"tax_amount": "1.89",
"net_amount": "8.61",
"tax": {
"id": "228923c8-fa07-4b77-94ca-372310cd3a3f",
"rate": 18,
"name": "Servis Ücreti"
}
},
"summary": {
"original_items_amount": "2118.64",
"original_taxes_amount": "381.36",
"complimentaries_amount": "0.0",
"discounts_amount": "600.0",
"taxes_amount": "411.86",
"service_charge_amount": "800.0",
"paid_amount": "2700.0",
"unpaid_amount": "0.0",
"paid_service_charge_amount": "0.0",
"total_amount": "2700.0",
"base_amount": "2500.0",
"offer_amount": "4.21"
},
"check_discounts": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"source": "system",
"value": "600",
"discount_amount": "10800",
"discount_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "TL İndirimi",
"type": "amount",
"annotation": "test annotation indirim"
}
],
"check_payments": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"payment_type_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"paid_amount": "700.0",
"device": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "The Great Book Pro"
},
"extras": {
"registry_no": "BB6644400",
"receipt_no": "4",
"z_no": 124
}
}
],
"check_items": [
{
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"parent_check_item_id": null,
"reason_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"business_date": "2019-02-11",
"status": "ordered",
"payment_status": "paid",
"kitchen_status": "ready",
"complimentary": false,
"unit_type": "item",
"quantity": "1.0",
"notes": [
"Life"
],
"is_combo": false,
"summary": {
"discount_amount": "24.0",
"tax_amount": "11.59322034",
"total_amount": "76.0",
"original_amount": "100.0",
"original_tax_amount": "15.25423729"
},
"tax": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"rate": 18,
"name": "İçecek"
},
"item": {
"id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
"name": "Short",
"type": "MenuItem",
"source_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af"
}
}
],
"check_offers": [
{
"id": "79ae7c2b-4356-4923-8eed-5515efac8e91",
"offer_id": "d94906e1-2260-4a37-afba-1fe5051b5cc9",
"name": "Happy Hour-1",
"value": "4.21"
}
]
}
]
}Modified at 2026-07-30 09:20:57