Retail Open Check
A table's, a tab's or a pre-order's running order, open until a till takes the payment. Written only through the open check's calls.
Area: Till sales · Why it is here: guide chapter 07 · Fields: 24
iVendNext's own description: A table's or a tab's running order, written only by the till. It holds what was ordered, never a price.
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Retail%20Open%20Check?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Retail%20Open%20Check/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: only the open check's calls write it (check_open, check_add_lines and the rest); the record API is refused. All the record calls and their answers: the API reference.
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Store | store |
Link | yes | Warehouse | ||
| Register | pos_profile |
Link | yes | POS Profile | ||
| Place | place |
Link | yes | Retail Floor Place | ||
| Name on the Check | label |
Data | yes | |||
| Party Size | covers |
Int | yes | |||
| Server | server |
Link | yes | User | ||
| Service Mode | service_mode |
Data | yes | |||
| Suggested Customer | suggested_customer |
Link | yes | Customer | ||
| Status | status |
Select | yes | one of: open, closed, merged | ||
| Merged Into | merged_into |
Link | yes | Retail Open Check | ||
| Version | version |
Int | yes | |||
| Header Changed at Version | changed_at_version |
Int | yes | yes | ||
| Opened From | source |
Data | yes | |||
| Their Reference | source_ref |
Data | yes | |||
| Opened At | opened_at |
Datetime | yes | |||
| Opened By | opened_by |
Link | yes | User | ||
| Opened on Till | opened_on_till |
Data | yes | |||
| Times Printed | printed_count |
Int | yes | |||
| Last Printed At | last_printed_at |
Datetime | yes | |||
| Last Written At | last_write_at |
Datetime | yes | |||
| Last Written On Till | last_write_till |
Data | yes | |||
| Kitchen Order | kitchen_ref |
Data | yes | |||
| Queued Offline | offline_flag |
Small Text | yes | |||
| Lines | lines |
Table | yes | Retail Open Check Line |
Table: Retail Open Check Line
The rows of lines. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Line | line_id |
Data | yes | |||
| Item | item_code |
Link | yes | Item | ||
| Item Name | item_name |
Data | yes | |||
| Quantity | qty |
Float | yes | |||
| Unit | uom |
Link | yes | UOM | ||
| Choices | options |
Small Text | yes | |||
| Note | note |
Small Text | yes | |||
| Promised to the Guest | concession_note |
Small Text | yes | |||
| Seat | seat |
Data | yes | |||
| Course | course |
Data | yes | |||
| State | state |
Select | yes | one of: open, paid, removed, voided | ||
| Why Removed | removal_reason |
Data | yes | |||
| Sent | sent |
Check | yes | |||
| Sent At | sent_at |
Datetime | yes | |||
| Sent By | sent_by |
Link | yes | User | ||
| Kitchen Order | kitchen_order |
Data | yes | |||
| Kitchen Line | kitchen_line |
Data | yes | |||
| Ordered At | ordered_at |
Datetime | yes | |||
| Added By | added_by |
Link | yes | User | ||
| Added on Till | added_on_till |
Data | yes | |||
| Added From | source |
Data | yes | |||
| Changed at Version | changed_at_version |
Int | yes | |||
| Being Paid Under | claim_id |
Link | yes | Retail Open Check Claim | ||
| Being Paid at Till | claim_till |
Data | yes | |||
| Being Paid By | claim_user |
Link | yes | User | ||
| Being Paid Since | claimed_at |
Datetime | yes | |||
| Paid By Sale | paid_by |
Data | yes |