Retail Open Check Event
One step in a check's life (opened, lines added, sent, paid), written by the open check's calls.
Area: Till sales · Why it is here: guide chapter 07 · Fields: 9
iVendNext's own description: One change to an open check: who, at which till, what. Written once by the till, never changed.
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%20Event?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%20Event/⟨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. 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 | ||
| What | verb |
Data | yes | |||
| Who | user |
Link | yes | User | ||
| Till | till |
Data | yes | |||
| From | source |
Data | yes | |||
| Check Version After | version |
Int | yes | |||
| Request Key | write_key |
Data | yes | yes | ||
| Detail | detail |
Long Text | yes | |||
| Answer | result |
Long Text | yes | yes |