Retail Register State
A register book's running balance, per item and store.
Area: Stock and stores · Why it is here: sample S41 · Fields: 8
iVendNext's own description: A register book's running balance per register store and item, and whether its opening line exists. Written by the register door only.
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%20Register%20State?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%20Register%20State/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext keeps it with each line. All the record calls and their answers: the API reference.
Samples that use it
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 |
|---|---|---|---|---|---|---|
| Book | book |
Link | yes | Retail Register Book | ||
| Register store | register_store |
Data | yes | |||
| Item | item |
Link | yes | Item | ||
| Item name | item_name |
Data | ||||
| Balance | balance |
Float | ||||
| Opening line written | has_opening |
Check | ||||
| Count due by | count_due_by |
Datetime | yes | |||
| Last loss at | last_loss_at |
Datetime | yes |