iVendNextDevelopers Request a sandbox

Retail Fiscal Regime Config

A country's fiscal settings for the fiscal reader.

Area: Your app: its install, its user and its doors · Why it is here: contract fiscal_reader · Fields: 8

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%20Regime%20Config?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%20Fiscal%20Regime%20Config/⟨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%20Regime%20Config" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"country": …}'

Change one with PUT /api/resource/Retail%20Fiscal%20Regime%20Config/⟨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
Country country Link yes Country
Regime Label regime_label Data
Clearance Required clearance_required Check
Require Buyer Tax ID On Account require_buyer_tax_id_on_account Check
Release Goods Before Cleared release_goods_before_cleared Check
Deposit Is a Fiscal Event deposit_is_fiscal_event Check
Allow Offline Capture allow_offline_capture Check
Note note Small Text

All record types · What you can use

This record type in the kit