Retail Register Count
A count of a register book's stock, which settles a book that would go below zero.
Area: Stock and stores · Why it is here: contract register_books; recipe regulated_register · Fields: 8 · Submitted (booked) records: send docstatus: 1 to book it as you create it, or submit a draft with submit.
iVendNext's own description: A count of a register book's items at one register store, against the register's own balance. Approved by the book's count role.
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%20Count?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Retail%20Register%20Count/⟨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%20Count" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"book": …, "register_store": …, "count_kind": …, "counted_at": …, "rows": …}'
Change one with PUT /api/resource/Retail%20Register%20Count/⟨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
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 | |||
| Kind | count_kind |
Select | yes | one of: Count, Opening | ||
| Counted at | counted_at |
Datetime | yes | |||
| Witness | witness |
Link | User | |||
| Witnessed at | witnessed_at |
Datetime | yes | |||
| Items | rows |
Table | yes | Retail Register Count Row | ||
| Amended From | amended_from |
Link | yes | Retail Register Count |
Table: Retail Register Count Row
The rows of rows. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Item | item |
Link | yes | Item | ||
| Batch | batch_no |
Link | Batch | |||
| Counted | counted_qty |
Float | ||||
| Register balance | register_balance |
Float | yes | |||
| Difference | difference |
Float | yes | |||
| Used by reconciliation | reconciliation |
Link | yes | Stock Reconciliation |