POS Profile

A register's settings: its store, price list, payment methods, the keys on its screen and what its cashiers may do.

Area: Till sales · Why it is here: openapi.yaml; contract receipt; guide chapter 04; recipe approvals_stores; recipe configure_no_code; recipe connected_app; recipe customers_by_store; recipe lucky_draw; recipe post_sale_feedback; recipe receipt_format; recipe required_sale_details; sample S49; the MCP server; the request collection; retail core · Fields: 92

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/POS%20Profile?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/POS%20Profile/⟨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/POS%20Profile" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"company": …, "interface_profile": …, "warehouse": …, "payments": …, "write_off_account": …, "write_off_cost_center": …}'

Change one with PUT /api/resource/POS%20Profile/⟨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

s2_bins · s3_price_audit · s4_receipt_pack · s8_estate_rollout · s14_approvals_stores · s24_price_checker · s39_pharmacy_counter · s44_lucky_draw · s45_restaurant_back_office · s47_customers_by_store · s48_customer_code_check · s49_post_sale_feedback · s50_required_sale_details

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.

Table: POS Customer Group

The rows of customer_groups. Each row also has idx (its place), parent, parentfield and parenttype.

Table: POS Item Group

The rows of item_groups. Each row also has idx (its place), parent, parentfield and parenttype.

Table: POS Payment Method

The rows of payments. Each row also has idx (its place), parent, parentfield and parenttype.

Table: POS Profile Team

The rows of custom_applicable_for_team. Each row also has idx (its place), parent, parentfield and parenttype.

Table: POS Profile User

The rows of applicable_for_users. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Retail Kitchen Printer

The rows of custom_mpos_kitchen_printers. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Retail POS Profile Store

The rows of custom_mpos_visible_stores. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Retail Service Mode

The rows of custom_mpos_service_modes. Each row also has idx (its place), parent, parentfield and parenttype.

All record types · What you can use

This record type in the kit