iRetail PRO store node 1.0.0-m1: checks
22 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
GET
/v1/checks
Checks, oldest first (spec/RESTAURANT.md, Checks); by default the open and billed ones.
operationId
listChecks · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
state
|
query | "active" | "open" | "billed" | "closed" | "canceled" |
active (open and billed, the default), or one state. |
table_id
|
query | string (uuid) |
Only this table's checks. |
waiter_id
|
query | string (uuid) |
Only this waiter's checks. |
limit
|
query | integer |
Page size, 1–200. |
after
|
query | string |
Cursor from the previous page. |
Responses
POST
/v1/checks
Open a check on a table, or a named tab, with its covers and optionally its first lines; the caller is its waiter.
Without the restaurant license module, a tab past the store's three places is 409 license_limit with details tables 3, and a check on a locked table (past the first three by id) is 403 module_disabled with details module restaurant (spec/LICENSE.md, The restaurant's three places).
operationId
openCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
Idempotency-Key
|
header | string |
spec/API.md, Idempotency. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckOpen
Responses
GET
/v1/checks/{id}
One check with its lines and totals.
operationId
getCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
Responses
PATCH
/v1/checks/{id}
Change a check's covers, a tab's name, held courses, customer, partner code or percent receipt discounts.
operationId
updateCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckPatch
Responses
POST
/v1/checks/{id}/lines
Add lines, unsent, holding stock for stocked items (spec/RESTAURANT.md, Stock on a check).
operationId
addCheckLines · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Idempotency-Key
|
header | string |
spec/API.md, Idempotency. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckLinesAdd
Responses
PATCH
/v1/checks/{id}/lines/{line_no}
Change a line; quantity, options, course and price only while it is unsent (409 line_sent).
operationId
updateCheckLine · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
line_no required
|
path | integer |
The line's number in the check. |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckLinePatch
Responses
DELETE
/v1/checks/{id}/lines/{line_no}
Delete an unsent line without a trace, releasing its hold (a sent line is voided instead).
operationId
removeCheckLine · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
line_no required
|
path | integer |
The line's number in the check. |
If-Match
|
header | string |
The version the change is based on. |
Responses
POST
/v1/checks/{id}/lines/{line_no}/void
Void a sent line with a reason; its station gets a cancel (spec/RESTAURANT.md, Courses and the kitchen).
operationId
voidCheckLine · Permission check.void_line
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
line_no required
|
path | integer |
The line's number in the check. |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonReason
Responses
POST
/v1/checks/{id}/send
Send the unsent lines of every course that is not held to the kitchen.
operationId
sendCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Responses
POST
/v1/checks/{id}/fire
Send a course's unsent lines, held or not, and stop holding it.
operationId
fireCourse · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonCourseFire
Responses
POST
/v1/checks/{id}/renew
Renew the check's holds for the store's check_hold_minutes and place lapsed ones again; raises no version.
operationId
renewCheckHolds · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
Responses
POST
/v1/checks/{id}/bill
Make the check billed and answer its pre-bill, which is not a fiscal document (spec/RESTAURANT.md, The pre-bill).
operationId
billCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Responses
POST
/v1/checks/{id}/reopen
Make a billed check open again.
operationId
reopenCheck · Permission check.reopen
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Responses
POST
/v1/checks/{id}/cancel
Cancel a check with nothing to pay; unsent lines are deleted and holds released (409 check_not_empty otherwise).
operationId
cancelCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Responses
POST
/v1/checks/{id}/move
Move a check to another table, or make it a tab (spec/RESTAURANT.md, Moving).
Without the restaurant license module, a check is not moved onto a locked table (403 module_disabled, details module restaurant), and making it a tab past the store's three places is 409 license_limit with details tables 3; moving a check off a locked table is allowed (spec/LICENSE.md, The restaurant's three places).
operationId
moveCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonCheckMove
Responses
POST
/v1/checks/{id}/merge
Merge another check into this one, its seats moved up past this check's guests; the other is canceled.
operationId
mergeCheck · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonCheckMerge
Responses
POST
/v1/checks/{id}/move-lines
Move chosen lines to another check, with their holds; answers the check they left.
operationId
moveCheckLines · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonCheckLinesMove
Responses
POST
/v1/checks/{id}/transfer
Pass a check to another waiter.
operationId
transferCheck · Permission check.transfer
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckTransfer
Responses
PUT
/v1/checks/{id}/service-charges/{charge_id}
Add a store's service charge to a check by hand, remove it with a reason (service_charge.remove too, or a senior's approval), or hand it back to the store's rules (spec/RESTAURANT.md, Service charges).
operationId
setCheckServiceCharge · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
charge_id required
|
path | string |
The store's service charge (spec/API.md, Service charges). |
If-Match
|
header | string |
The version the change is based on. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonCheckServiceChargeSet
Responses
POST
/v1/checks/{id}/split
The receipts a split would make, each figured by the receipt math, with their parts; changes nothing.
operationId
previewCheckSplit · Permission check.use
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
Request body required
application/jsonCheckSplitRequest
Responses
GET
/v1/check-conflicts
Offline receipts of checks that did not apply, for a person to settle (spec/RESTAURANT.md, Offline).
operationId
listCheckConflicts · Permission check.any
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
resolved
|
query | boolean |
false (the default) for the unresolved ones. |
limit
|
query | integer |
Page size, 1–200. |
after
|
query | string |
Cursor from the previous page. |
Responses
-
200OKCheckConflictPage -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error
POST
/v1/check-conflicts/{id}/resolve
Apply an offline receipt to its check after all, or dismiss the conflict. 409 check_conflict_resolved for one already resolved, before its version is compared.
operationId
resolveCheckConflict · Permission check.any
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonCheckConflictResolve
Responses
Schemas
Error object
Every error response.
error required
|
string |
Stable code, see spec/API.md. |
message required
|
string |
English text for logs. |
details
|
object |
Discount object | object
As in spec/RECEIPT_MATH.md.
ReceiptTax object
code required
|
string |
|
base required
|
integer (int64) |
|
amount required
|
integer (int64) |
CheckState "open" | "billed" | "closed" | "canceled"
open · billed · closed · canceled
CheckLineState "unsent" | "sent" | "voided"
unsent · sent · voided
HoldState "held" | "lapsed" | "none"
held · lapsed · none
CheckLineVoid object
reason required
|
string |
|
by required
|
string (uuid) |
|
approved_by required
|
string (uuid) | null |
|
at required
|
string (date-time) |
CheckLine object
A sale line with its seat and course (spec/RESTAURANT.md, Checks).
line_no required
|
integer |
|
item_id required
|
string (uuid) |
|
name required
|
string |
|
quantity_milli required
|
integer (int64) |
|
unit_price_minor required
|
integer (int64) |
The price when the line was added, options included (spec/RESTAURANT.md, Checks); a receipt paying the line carries it less its options' deltas. |
modifiers required
|
array of object |
|
discounts required
|
array of Discount |
|
seat required
|
integer |
0 for a shared line. |
course required
|
integer |
|
state required
|
CheckLineState |
|
sent_at required
|
string (date-time) | null |
|
voided required
|
CheckLineVoid | null |
|
receipt_id required
|
string (uuid) | null |
|
hold_state required
|
HoldState |
|
seller_id required
|
string (uuid) | null |
|
guest_order_id required
|
string (uuid) | null |
|
added_by required
|
string (uuid) |
|
added_at required
|
string (date-time) |
CheckLineTotals object
line_no required
|
integer |
|
gross required
|
integer (int64) |
|
line_discount required
|
integer (int64) |
|
receipt_discount required
|
integer (int64) |
|
net required
|
integer (int64) |
|
tax required
|
integer (int64) |
|
service_charges required
|
array of ServiceChargeShare |
The line's share of each charge that applies, with the tax on it. |
CheckTotals object
What one sale receipt of the check's lines that are not voided would be (spec/RESTAURANT.md, Checks).
lines required
|
array of CheckLineTotals |
|
taxes required
|
array of ReceiptTax |
|
gross_total required
|
integer (int64) |
|
discount_total required
|
integer (int64) |
|
net_total required
|
integer (int64) |
|
tax_total required
|
integer (int64) |
|
deposit_total
|
integer (int64) |
|
total required
|
integer (int64) |
|
points_earned required
|
integer | null |
What a bonus card would earn on one receipt of the check; null without one. |
service_charges required
|
array of CheckTotalsServiceCharge |
The service charges that apply to the check, judged on its covers and order type (spec/RESTAURANT.md, Service charges). |
service_charge_total required
|
integer (int64) |
Check object
An open order on a table, or a tab (spec/RESTAURANT.md, Checks).
id required
|
string (uuid) |
|
number required
|
integer (int64) |
|
kind required
|
"table" | "tab" |
|
table_id required
|
string (uuid) | null |
|
table_name required
|
string | null |
|
area_id required
|
string (uuid) | null |
|
name required
|
string | null |
A tab's name; null for a check on a table. |
waiter_id required
|
string (uuid) |
|
covers required
|
integer |
|
state required
|
CheckState |
|
order_type required
|
"dine_in" | "take_out" |
|
held_courses required
|
array of integer |
|
customer_id required
|
string (uuid) | null |
|
card_number_masked required
|
string | null |
|
partner_code required
|
string | null |
|
receipt_discounts required
|
array of object |
Percentages only (spec/RESTAURANT.md, Checks). |
service_charges required
|
array of CheckServiceCharge |
The store's service charges the check carries, in the store's order, each with how it came to (spec/RESTAURANT.md, Service charges). |
lines required
|
array of CheckLine |
|
totals required
|
CheckTotals |
|
paid_minor required
|
integer (int64) |
|
receipt_ids required
|
array of string (uuid) |
|
prebill_count required
|
integer |
|
opened_at required
|
string (date-time) |
|
billed_at required
|
string (date-time) | null |
|
closed_at required
|
string (date-time) | null |
|
merged_into required
|
string (uuid) | null |
|
version required
|
integer (int64) |
CheckPage object
items required
|
array of Check |
|
next required
|
string | null |
CheckLineInput object
item_id required
|
string (uuid) |
|
quantity_milli required
|
integer (int64) |
At most 10^12; a check holds at most 1 000 lines and is bounded as the receipt it adds up to (spec/API.md, Payments; 422 amount_too_large). |
seat
|
integer |
0 for a shared line. |
course
|
integer |
|
modifiers
|
array of string |
Option ids in the chosen order (spec/FOOD_SERVICE.md). |
discounts
|
array of Discount |
|
unit_price_minor
|
integer (int64) |
The price before options, as on a sale line (spec/FOOD_SERVICE.md); only with receipt.price.override, otherwise the store price. |
seller_id
|
string (uuid) | null |
CheckOpen object
table_id for a check on a table, or name for a tab.
table_id
|
string (uuid) | null |
|
name
|
string | null |
A tab's name; null for a check on a table. |
covers required
|
integer |
|
order_type
|
"dine_in" | "take_out" |
|
lines
|
array of CheckLineInput |
CheckPatch object
covers
|
integer |
|
name
|
string | null |
A tab's name; null for a check on a table. |
held_courses
|
array of integer |
|
customer_id
|
string (uuid) | null |
|
card_number
|
string | null |
A loyalty card as scanned; never returned (spec/LOYALTY.md). |
partner_code
|
string | null |
|
receipt_discounts
|
array of object |
Percentages only (spec/RESTAURANT.md, Checks). |
CheckLinesAdd object
lines required
|
array of CheckLineInput |
CheckLinePatch object
quantity_milli
|
integer (int64) |
|
seat
|
integer |
0 for a shared line. |
course
|
integer |
|
modifiers
|
array of string |
|
discounts
|
array of Discount |
|
unit_price_minor
|
integer (int64) |
The price before options, as on a sale line (spec/FOOD_SERVICE.md); only with receipt.price.override. |
seller_id
|
string (uuid) | null |
Reason object
reason required
|
string |
CourseFire object
course required
|
integer |
CheckMove object
table_id required
|
string (uuid) | null |
The table to move to; null makes the check a tab, which then needs a name. |
name
|
string | null |
A tab's name; null for a check on a table. |
CheckMerge object
source_check_id required
|
string (uuid) |
|
source_version required
|
integer (int64) |
CheckLinesMove object
to_check_id required
|
string (uuid) |
|
to_version required
|
integer (int64) |
|
line_nos required
|
array of integer |
|
to_seat
|
integer | null |
The seat every moved line takes; null keeps their seats. |
CheckTransfer object
waiter_id required
|
string (uuid) |
CheckSplitRequest object
items: receipts as lists of line numbers; seats: optionally shared_by; equal: parts (spec/RESTAURANT.md, Split and close).
kind required
|
"items" | "seats" | "equal" |
|
receipts
|
array of array of integer |
|
shared_by
|
array of integer |
|
parts
|
integer |
CheckSplitPart object
part required
|
integer |
|
seat required
|
integer | null |
|
amount_minor required
|
integer (int64) |
|
cash_minor required
|
integer | null |
The part when every part is paid in cash in a store that rounds cash; null otherwise. |
CheckSplitReceipt object
seat required
|
integer | null |
|
shared required
|
boolean |
|
line_nos required
|
array of integer |
|
taxes required
|
array of ReceiptTax |
|
gross_total required
|
integer (int64) |
|
discount_total required
|
integer (int64) |
|
net_total required
|
integer (int64) |
|
deposit_total
|
integer (int64) |
The container deposits of this receipt's lines (spec/TAX.md), inside total; present only when a line of it has one, as on a receipt. |
tax_total required
|
integer (int64) |
|
total required
|
integer (int64) |
|
cash_due required
|
integer | null |
|
parts required
|
array of CheckSplitPart |
The divided due of an equal split or of the shared lines; empty otherwise. |
service_charges required
|
array of ServiceChargeAmount |
The check's charges that apply, figured on this receipt's lines. |
service_charge_total required
|
integer (int64) |
CheckSplit object
check_version required
|
integer (int64) |
|
check_total required
|
integer (int64) |
|
receipts required
|
array of CheckSplitReceipt |
|
receipts_total required
|
integer (int64) |
|
difference required
|
integer (int64) |
receipts_total less check_total; taxes and stamps are figured per receipt. |
PreBillLine object
line_no required
|
integer |
|
seat required
|
integer |
0 for a shared line. |
quantity_milli required
|
integer (int64) |
|
name required
|
string |
|
options required
|
array of string |
|
gross required
|
integer (int64) |
|
line_discount required
|
integer (int64) |
PreBill object
A check's pre-bill; not a fiscal document, and printed as such (spec/RESTAURANT.md, The pre-bill).
check_id required
|
string (uuid) |
|
check_number required
|
integer (int64) |
|
table_name required
|
string | null |
|
name required
|
string | null |
A tab's name; null for a check on a table. |
waiter_id required
|
string (uuid) |
|
waiter_name required
|
string |
|
covers required
|
integer |
|
language required
|
string |
The store's receipt language, in which "Pre-bill — not a receipt" is printed. |
lines required
|
array of PreBillLine |
|
service_charges required
|
array of PreBillServiceCharge |
What the pre-bill prints of each charge that applies, in its language; the amounts are in totals. |
totals required
|
CheckTotals |
|
printed_at required
|
string (date-time) |
|
copy required
|
integer |
1 for the first print, then each reprint. |
CheckConflictReason object
line_no required
|
integer | null |
|
reason required
|
"check_closed" | "check_canceled" | "line_missing" | "line_voided" | "line_paid" | "line_changed" | "service_charges_changed" |
CheckConflict object
An offline receipt of a check that did not apply (spec/RESTAURANT.md, Offline).
id required
|
string (uuid) |
|
check_id required
|
string (uuid) |
|
receipt_id required
|
string (uuid) |
|
reasons required
|
array of CheckConflictReason |
|
created_at required
|
string (date-time) |
|
resolution required
|
"apply" | "dismiss" | null |
|
resolved_by required
|
string (uuid) | null |
|
resolved_at required
|
string (date-time) | null |
|
version required
|
integer (int64) |
CheckConflictPage object
items required
|
array of CheckConflict |
|
next required
|
string | null |
CheckConflictResolve object
resolution required
|
"apply" | "dismiss" |
ServiceChargeHow "automatic" | "added" | "removed"
automatic (its conditions hold), added by hand, or removed by hand with a reason.
automatic · added · removed
ServiceChargeAmount object
A charge figured on a receipt's lines.
id required
|
string |
|
base_minor required
|
integer (int64) |
What the rate was applied to. |
amount_minor required
|
integer (int64) |
|
tax_minor required
|
integer (int64) |
CheckTotalsServiceCharge object
A charge that applies to a check, figured on its lines, with how it came to.
id required
|
string |
|
how required
|
ServiceChargeHow |
|
base_minor required
|
integer (int64) |
|
amount_minor required
|
integer (int64) |
|
tax_minor required
|
integer (int64) |
CheckServiceCharge object
A service charge a check carries (spec/RESTAURANT.md, Service charges).
id required
|
string |
|
how required
|
ServiceChargeHow |
|
reason required
|
string | null |
|
by required
|
string (uuid) | null |
|
approved_by required
|
string (uuid) | null |
|
at required
|
string (date-time) | null |
CheckServiceChargeSet object
how required
|
"added" | "removed" | "automatic" |
added, removed (with a reason, and service_charge.remove or an approval) or automatic (back to the store's rules). |
reason
|
string | null |
PreBillServiceCharge object
id required
|
string |
|
label required
|
string |
|
rate_ppm required
|
integer |
|
notice required
|
string |
|
to_staff_ppm required
|
integer |