Retail Register Book

A book of a regulated-stock register: which items it takes, which movements enter it, and the columns it prints. A manifest installs it.

Area: Stock and stores · Why it is here: contract register_books; guide chapter 07; recipe manifest · Fields: 26

iVendNext's own description: A legal stock register book declared as data: which items and movements enter it, how its lines are numbered and corrected, and the columns it prints. Usually installed by an app; switched off, never deleted, once it has lines.

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%20Book?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%20Book/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Retail%20Register%20Book" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"book": …, "title": …, "data_set": …, "cite": …, "medium": …, "numbering": …}'

Change one with PUT /api/resource/Retail%20Register%20Book/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s41_regulated_register

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	Links to
Book	`book`	Data	yes
Title	`title`	Data	yes
Data set	`data_set`	Data	yes
Cite	`cite`	Small Text	yes
Enabled	`enabled`	Check
Certified	`certified`	Check
Medium	`medium`	Select	yes		one of: printed_book, system_of_record, official_book, regulator_system
Installed by	`source_app`	Data		yes
Numbering	`numbering`	Select	yes		one of: book_store, book_store_item
Keeps a balance	`balance`	Check
Correction	`correction`	Select	yes		one of: reversing_line, dated_note, signed_strike_through, signed_amendment
Keep lines for (years)	`retention_years`	Int	yes
Period (months)	`period_months`	Int
Return due (days after the period)	`return_due_days`	Int
Count role	`count_role`	Link	yes		Role
Count needs a witness	`count_witness`	Check
Full count after a loss within (hours)	`loss_count_hours`	Int
Items	`item_scope`	Code	yes
Class source	`class_source`	Code
Conditions	`conditions`	Code
Required columns	`required`	Code
Columns	`columns`	Code	yes
Details	`details`	Code
Prescription and permit sources	`authority`	Code
Column sources	`columns_from`	Code
Register stores	`register_stores`	Code

All record types · What you can use

This record type in the kit