Retail Register Line
One numbered line of a regulated-stock register book, such as a controlled-drug register, written when a stock document is booked. Never edited.
Area: Stock and stores · Why it is here: contract register_books; sample S41 · Fields: 52
iVendNext's own description: One line of a legal stock register: written by the register door in the same save as the movement, numbered with no gaps, never edited. A mistake is corrected by a new line.
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%20Line?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%20Line/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it with each stock document a book takes; it is never edited. 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 |
|---|---|---|---|---|---|---|
| Number | number |
Int | yes | |||
| Book | book |
Link | yes | Retail Register Book | ||
| Register store | register_store |
Data | yes | |||
| Warehouse | warehouse |
Link | yes | Warehouse | ||
| Period | period |
Link | yes | Retail Register Period | ||
| Sequence | sequence |
Data | yes | |||
| Direction | direction |
Select | yes | one of: In, Out | ||
| Kind | kind |
Select | yes | one of: Receipt, Sale, Return, Transfer, Issue, Repack, Loss, Disposal, Count, Opening, Correction | ||
| Movement date | movement_date |
Date | yes | |||
| Movement time | movement_time |
Time | yes | |||
| Entered at | entered_at |
Datetime | yes | |||
| Entry date | entry_date |
Date | yes | |||
| Item | item |
Link | yes | Item | ||
| Item name | item_name |
Data | yes | |||
| Class | item_class |
Data | yes | |||
| Batch | batch_no |
Link | yes | Batch | ||
| Expiry date | expiry_date |
Date | yes | |||
| Quantity | qty |
Float | yes | |||
| Unit | uom |
Data | yes | |||
| Balance | balance |
Float | yes | |||
| Document type | voucher_type |
Link | yes | DocType | ||
| Document | voucher_no |
Dynamic Link | yes | |||
| Counterparty | counterparty |
Data | yes | |||
| Counterparty address | counterparty_address |
Small Text | yes | |||
| Reference | reference_no |
Data | yes | |||
| Prescription or permit number | authority_no |
Data | yes | |||
| Issued by | authority_issuer |
Data | yes | |||
| Issuer's licence | authority_issuer_licence |
Data | yes | |||
| Prescription or permit date | authority_date |
Date | yes | |||
| Dispenser | dispenser |
Data | yes | |||
| Dispenser name | dispenser_name |
Data | yes | |||
| Dispenser's licence | dispenser_licence |
Data | yes | |||
| Detail 1 | detail_1 |
Data | yes | |||
| Detail 2 | detail_2 |
Data | yes | |||
| Detail 3 | detail_3 |
Data | yes | |||
| Detail 4 | detail_4 |
Data | yes | |||
| Detail 5 | detail_5 |
Data | yes | |||
| Detail 6 | detail_6 |
Data | yes | |||
| Booked late | booked_late |
Check | yes | |||
| Incomplete | incomplete |
Check | yes | |||
| Below zero | below_zero |
Check | yes | |||
| Remarks | remarks |
Small Text | yes | |||
| Correction of | correction_of |
Link | yes | Retail Register Line | ||
| Correction of number | correction_of_number |
Int | yes | |||
| Correction note | correction_note |
Small Text | yes | |||
| Signed by | signed_by |
Data | yes | |||
| Signed by name | signed_by_name |
Data | yes | |||
| Previous line's hash | prev_hash |
Data | yes | |||
| Line hash | line_hash |
Data | yes | |||
| Hash version | hash_version |
Data | yes | |||
| Person seal | person_seal |
Small Text | yes | yes | ||
| Amended From | amended_from |
Link | yes | Retail Register Line |