Retail Register Period
A period of a register book, closed with its count.
Area: Stock and stores · Why it is here: guide chapter 07; recipe regulated_register; sample S41 · Fields: 12
iVendNext's own description: A register book's period at one register store: its dates and its return due date, and the establishment's name and address copied when it is made. Every line carries the period it was written into. The book prints from it.
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%20Period?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%20Period/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it when a period is signed off. 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 | |||
| From | from_date |
Date | yes | |||
| To | to_date |
Date | yes | |||
| Return due | return_due |
Date | ||||
| Status | status |
Select | yes | one of: Open, Signed off | ||
| Signed off by | signed_off_by |
Link | yes | User | ||
| Signed off at | signed_off_at |
Datetime | yes | |||
| Chain | chain_status |
Small Text | yes | |||
| Sealed at sign-off | sealed |
Code | yes | |||
| Establishment | establishment |
Data | yes | |||
| Establishment address | establishment_address |
Small Text | yes |