Retail Open Check Claim
A till's claim on a check while it is being paid. A till's own record: your app never writes it.
Area: Till sales · Why it is here: guide chapter 07 · Fields: 17
iVendNext's own description: A till paying some of a check's lines: taken before any money moves, ended by the sale, a step back or a manager. Written only by the till.
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%20Claim?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Retail%20Open%20Check%20Claim/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: only a till writes it, when a check is paid. 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 |
|---|---|---|---|---|---|---|
| Check | check |
Link | yes | Retail Open Check | ||
| Status | status |
Select | yes | one of: held, booked, released, broken | ||
| Lines | line_ids |
Small Text | yes | |||
| Taken By | user |
Link | yes | User | ||
| Device | device |
Data | yes | |||
| Till | till |
Data | yes | |||
| Day | opening |
Link | yes | POS Opening Entry | ||
| Request Key | write_key |
Data | yes | yes | ||
| Token | token_hash |
Data | yes | yes | ||
| Payments | sale_keys |
Small Text | yes | |||
| Pending Tender | pending_tender |
Data | yes | |||
| Pending Amount | pending_amount |
Currency | yes | |||
| Pending Since | pending_noted_at |
Datetime | yes | |||
| Pending Cleared At | pending_cleared_at |
Datetime | yes | |||
| Money Noted on the Bank's Machine | pending_legs |
Long Text | yes | |||
| Ended By | ended_by |
Link | yes | User | ||
| Why Ended | end_reason |
Small Text | yes |