Retail Register Erasure
A record that a person's details were erased from a register book after its retention.
Area: Stock and stores · Why it is here: contract register_books; guide chapter 07 · Fields: 12
iVendNext's own description: One erasure of persons' details from a register book's past entries, by the book's count role once the law's retention has passed (Erase persons' details on the book). It names who, when, the retention in force, the shop's own destruction record and every entry and column erased. Never changed or deleted.
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%20Erasure?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%20Erasure/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it when a person's details are erased. All the record calls and their answers: the API reference.
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 | |||
| Entered up to | up_to |
Date | yes | |||
| Retention (years) | retention_years |
Int | yes | |||
| Erased by | erased_by |
Data | yes | |||
| Erased by (name) | erased_by_name |
Data | yes | |||
| Erased at | erased_at |
Datetime | yes | |||
| The market's destruction record | reference |
Data | yes | |||
| Entries erased | entries_erased |
Int | yes | |||
| Entries kept whole | entries_kept |
Int | yes | |||
| Entry numbers | entry_numbers |
Long Text | yes | |||
| Entries and columns | entries |
Long Text | yes |