iVendNextDevelopers Request a sandbox

Retail Permission

The till's rights given to a user or a role, such as opening a check or a markdown cap.

Area: Your app: its install, its user and its doors · Why it is here: contract open_check; recipe open_check · Fields: 54

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

Change one with PUT /api/resource/Retail%20Permission/⟨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
Retail Permission Name retail_permission_name Data yes
Sale sale Check
Item Return item_return Check
Sale Return sale_return Check
Gift Certificate gift_certificate Check
Sale with Fulfillment sale_with_fulfillment Check
On Account Payment on_account_payment Check
Suspend / Recall suspend_recall Check
Delete Suspended Transaction delete_suspended_transaction Check
Void Transaction void_transaction Check
Void Item void_item Check
Cash In cash_in Check
Cash Out cash_out Check
Expense expense Check
Quotation quotation Check
Order order Check
Convert Expired Quotation convert_expired_quotation Check
Price Override Lower Limit price_override_lower_limit Percent
Maximum Item Discount(%) maximum_item_discount Percent
Price Override Upper Limit price_override_upper_limit Percent
Maximum Sale Discount(%) maximum_sale_discount Percent
Open Shift open_shift Check
Suspend/Resume Shift suspend_resume_shift Check
Count Shift count_shift Check
Close Shift close_shift Check
Tax Override tax_override Check
Open Cash Drawer open_cash_drawer Check
Reprint Transaction Receipts reprint_transaction_receipts Check
X Tape Report x_tape_report Check
Manual Weight Entry (added by iVendNext) custom_manual_weight Check
May Apply Employee Discount (added by iVendNext) custom_mpos_employee_discount Check
May Do No-Receipt Returns (added by iVendNext) custom_mpos_no_receipt_return Check
May Approve a Partner's Check (added by iVendNext) custom_mpos_approve_partner_check Check
May Sell on a Payer (added by iVendNext) custom_mpos_payer_sale Check
May Skip the Customer's Code (added by iVendNext) custom_mpos_skip_customer_code Check
May Turn a Till's Cash Drawer On or Off (added by iVendNext) custom_mpos_cash_drawer_setup Check
May Free Up a Till (added by iVendNext) custom_mpos_free_terminal Check
May Add to a Check (added by iVendNext) custom_mpos_check_add Check
May Change Their Own Lines (added by iVendNext) custom_mpos_check_edit_own Check
May End Another Till's Payment (added by iVendNext) custom_mpos_check_break_claim Check
May Print a Check for the Table (added by iVendNext) custom_mpos_check_print Check
May Close an Empty Check (added by iVendNext) custom_mpos_check_close_empty Check
May See the Checks (added by iVendNext) custom_mpos_check_read Check
May Move, Merge or Split (added by iVendNext) custom_mpos_check_move Check
May Hand a Check Over (added by iVendNext) custom_mpos_check_transfer_server Check
May Comp a Line (added by iVendNext) custom_mpos_check_comp Check
May Take Payment for a Check (added by iVendNext) custom_mpos_check_pay Check
May Change Any Line (added by iVendNext) custom_mpos_check_edit_any Check
May Send to the Kitchen (added by iVendNext) custom_mpos_check_mark_sent Check
May Open a Check (added by iVendNext) custom_mpos_check_open Check
May Retire a POS Device (added by iVendNext) custom_mpos_device_admin Check
May Take Layaway (added by iVendNext) custom_mpos_layaway Check
May Take the Service Charge Off a Sale (added by iVendNext) custom_mpos_remove_service_charge Check
May Void a Line the Kitchen Has (added by iVendNext) custom_mpos_void_sent_line Check

All record types · What you can use

This record type in the kit