Retail Fiscal Reader
Which sale fields hold a fiscal service's result, and what each status means. A manifest installs it.
Area: Your app: its install, its user and its doors · Why it is here: contract fiscal_reader · Fields: 10
iVendNext's own description: How a country's tax clearance is read from sale fields. The receipt prints as a tax document only once the sale is cleared. System Manager only.
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%20Fiscal%20Reader?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%20Fiscal%20Reader/⟨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%20Fiscal%20Reader" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"source": …, "companies": …, "status_field": …, "ref_field": …, "status_map": …}'
Change one with PUT /api/resource/Retail%20Fiscal%20Reader/⟨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.
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 |
|---|---|---|---|---|---|---|
| Source | source |
Data | yes | |||
| Enabled | enabled |
Check | ||||
| Companies | companies |
Table MultiSelect | yes | Allowed To Transact With | ||
| Status field | status_field |
Data | yes | |||
| Tax receipt number field | ref_field |
Data | yes | |||
| QR field | qr_field |
Data | ||||
| Seal field | signature_field |
Data | ||||
| Writer role | writer_role |
Link | Role | |||
| Writer users | writer_users |
Table MultiSelect | User Group Member | |||
| Status values | status_map |
Table | yes | Retail Fiscal Reader Status |
Table: Allowed To Transact With
The rows of companies. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | yes | Company |
Table: Retail Fiscal Reader Status
The rows of status_map. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Value the source writes | source_value |
Data | yes | |||
| Means | status |
Select | yes | one of: CLEARED, REPORTED, PENDING |
Table: User Group Member
The rows of writer_users. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| User | user |
Link | yes | User |