Home Record types Record types and fields: what your app can read and write
The 107 record types an app most often reads or writes in a retailer's iVendNext, each with its fields: which are required, which are read-only, what each links to, and the address to read and write it. They are read from the product itself at POS 2.1.0.667 (till app 60147699c), with the fields iVendNext adds, and are read again at each release. Every other record type is reached the same way, at /api/resource/⟨Record Type⟩.
107 record types. Browse by area, or find one in the A to Z list. Your own record types come from your manifest (what a manifest can add ).
Areas: Sales and returns · Till sales · Items · Prices and price lists · Customers and groups · Stock and stores · Batches and serial numbers · Loyalty · Gift cards · Coupons and promotions · Payments and payment methods · Purchase and transfer documents · The retailer's setup · Your app: its install, its user and its doors
Sales and returns
Record type
Fields
Tables
Why it is here
Sales Invoice
172
10
openapi.yaml; api/validate.sh; guide chapter 02; recipe bulk_reads; recipe customer_history_page; recipe price_checker; recipe print_pack; recipe webhook_receiver; sample S2; sample S29; sample S3; sample S39; sample S41; sample S43; the MCP server; the request collection; retail core
Sales Order
104
7
recipe call_centre_orders; recipe click_and_collect; sample S16; sample S33; sample S35; sample S39; retail core
Delivery Note
107
5
recipe click_and_collect; sample S33; sample S39; sample S41; retail core
Quotation
81
7
retail core
Sale Attribute
9
0
recipe required_sale_details
Transaction Item Attribute
7
0
contract label_layout; guide chapter 04; recipe capture; recipe configure_no_code
Reason Code Master
5
0
guide chapter 04; recipe configure_no_code
Till sales
Record type
Fields
Tables
Why it is here
POS Invoice
219
19
openapi.yaml; contract fiscal_reader; guide chapter 01c; guide chapter 10; recipe customer_history_page; recipe duty_free_allowance; recipe gift_card_on_spend; recipe loyalty_provider; recipe lucky_draw; recipe portal; recipe post_sale_feedback; recipe receipt_format; recipe restaurant_back_office; recipe stock_alerts; recipe system_sync; recipe webhook_receiver; sample S13; sample S2; sample S22; sample S25; sample S3; sample S36; sample S4; sample S41; sample S43; sample S49; sample S52; sample S9; the MCP server; the feed client; the request collection; retail core
POS Profile
92
8
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
POS Opening Entry
24
3
retail core
POS Closing Entry
30
6
recipe ai_manager; recipe bi_feed; sample S9; retail core
Retail Open Check
24
1
guide chapter 07
Retail Floor Section
4
0
guide chapter 07
Retail Floor Place
7
0
guide chapter 07
Retail Open Check Claim
17
0
guide chapter 07
Retail Open Check Event
9
0
guide chapter 07
Retail Kitchen Order
8
1
contract open_check
POS Terminal
11
0
contract label_layout
Items
Record type
Fields
Tables
Why it is here
Item
104
11
openapi.yaml; api/README.md; contract fields; guide chapter 02; guide chapter 07; recipe age_check; recipe bulk_reads; recipe duty_free_allowance; recipe integration_user; recipe optical_prescriptions; recipe print_pack; recipe stock_alerts; recipe system_sync; sample S2; sample S23; sample S27; sample S36; sample S37; sample S39; sample S40; sample S42; sample S45; the MCP server; the kit's tool sign_in; the request collection; retail core
Item Group
12
2
recipe age_check; recipe duty_free_allowance; recipe optical_prescriptions; sample S31; sample S36; sample S37; sample S38; sample S39; sample S42; retail core
UOM
3
0
retail core
Brand
4
1
retail core
Item Label Printing
5
1
guide chapter 12
Barcode Mask
7
1
contract label_layout
Prices and price lists
Record type
Fields
Tables
Why it is here
Item Price
19
0
guide chapter 01c; guide chapter 07; recipe approvals; recipe approvals_stores; recipe derived_price_lists; recipe estate_rollout; recipe expiry_markdown; recipe print_pack; recipe system_sync; sample S11; sample S14; sample S23; sample S26; retail core
Price List
7
1
card price-list-with-photos; guide chapter 07; recipe approvals; recipe estate_rollout; sample S29; retail core
Pricing Rule
61
3
retail core
Customers and groups
Record type
Fields
Tables
Why it is here
Customer
60
5
openapi.yaml; contract fields; recipe customer_code_check; recipe customer_history_page; recipe loyalty_provider; recipe optical_prescriptions; recipe print_pack; sample S22; sample S25; sample S39; sample S42; sample S43; sample S49; sample S52; the MCP server; the request collection; retail core
Customer Group
10
2
guide chapter 04; recipe configure_no_code; recipe coupon_rules; recipe customer_code_check; recipe customer_owned_loyalty; recipe customers_by_store; recipe gift_card_on_spend; recipe lucky_draw; recipe payment_method_rules; recipe required_sale_details; recipe rule_guard; sample S46; sample S47; sample S48; sample S50; retail core
Territory
8
1
recipe call_centre_orders; sample S35; retail core
Address
16
1
guide chapter 04; recipe receipt_format; retail core
Contact
25
3
retail core
Stock and stores
Record type
Fields
Tables
Why it is here
Warehouse
31
0
openapi.yaml; guide chapter 04; recipe customers_by_store; recipe desk_action; recipe estate_rollout; the MCP server; the request collection; retail core
Bin
15
0
openapi.yaml; recipe connected_app; recipe restaurant_back_office; recipe stock_alerts; the MCP server; the request collection; retail core
Stock Entry
53
2
openapi.yaml; api/README.md; guide chapter 05; recipe connected_app; sample S40; sample S45; the MCP server; the request collection; retail core
Stock Reconciliation
14
1
recipe merge_documents; sample S28; sample S41; retail core
Stock Ledger Entry
31
0
recipe restaurant_back_office; retail core
Material Request
22
1
retail core
Company
83
0
recipe lucky_draw; retail core
Retail Register Line
52
0
contract register_books; sample S41
Retail Register Period
12
0
guide chapter 07; recipe regulated_register; sample S41
Retail Register State
8
0
sample S41
Retail Register Book
26
0
contract register_books; guide chapter 07; recipe manifest
Retail Register Count
8
1
contract register_books; recipe regulated_register
Retail Register Erasure
12
0
contract register_books; guide chapter 07
Batches and serial numbers
Record type
Fields
Tables
Why it is here
Batch
18
0
recipe expiry_markdown; recipe stock_alerts; sample S23; sample S40; retail core
Serial No
24
0
openapi.yaml; recipe units_as_serials; the MCP server; the request collection; retail core
Serial and Batch Bundle
21
1
openapi.yaml; api/README.md; recipe stock_alerts; the MCP server; the request collection; retail core
Loyalty
Gift cards
Payments and payment methods
Purchase and transfer documents
The retailer's setup
Your app: its install, its user and its doors
Record type
Fields
Tables
Why it is here
Retail Extension Package
28
0
guide chapter 07; guide chapter 08; guide chapter 14a; recipe approvals; recipe manifest
Retail Extension Install
8
0
Retail Extension Subscription
28
2
contract desk_action; contract partner_capture; contract partner_check; contract partner_fulfil; contract partner_page; contract payer; contract price; guide chapter 09; recipe call_centre_orders; recipe configure_no_code; recipe desk_action; recipe expiry_markdown; recipe optical_prescriptions; recipe rule_guard
Retail Extension Log
20
0
contract desk_action; contract doccheck; contract partner_capture; contract partner_check; guide chapter 09; recipe document_check
Retail Extension Module
13
0
contract partner_check; contract price; guide chapter 07; guide chapter 08; guide chapter 09; recipe configure_no_code; recipe manifest
Retail Desk Action
15
3
contract desk_action; recipe call_centre_orders; recipe desk_action; recipe expiry_markdown
Retail Remote App Key
16
0
contract remote_till_key; guide chapter 06; guide chapter 13; recipe ai_till_key; recipe point_handler
Retail Save Rule
36
1
contract save_rules; recipe event_feed; recipe save_rules
Retail Override Request
29
0
recipe till_guard
Retail Scan Source
12
0
contract scan_source; recipe unit_codes
Retail List Mark
6
1
card products-on-promotion-colour; contract list_mark; guide chapter 07
Retail Label Layout
7
0
contract label_layout; guide chapter 14a
Retail Fiscal Reader
10
3
contract fiscal_reader
Retail Fiscal Regime Config
8
0
contract fiscal_reader
Retail Partner Code
24
0
contract partner_fulfil
Retail Permission
54
0
contract open_check; recipe open_check
User
77
6
recipe customer_history_page; recipe integration_user
User Permission
7
0
guide chapter 04; recipe approvals; recipe approvals_stores; recipe estate_rollout; recipe portal
Comment
11
0
openapi.yaml; recipe merge_documents; the MCP server; the request collection
Registered Application
4
1
contract event_feed; recipe event_feed; recipe integration_user; recipe system_sync
Integration Sync Log
7
0
guide chapter 05; recipe event_feed
Prepared Report
9
0
recipe shop_reports
A to Z
A
B
C
D
G
I
J
L
M
N
O
P
Q
R
Reason Code Master — Sales and returns
Registered Application — Your app: its install, its user and its doors
Retail Coupon Draw — Coupons and promotions
Retail Desk Action — Your app: its install, its user and its doors
Retail Extension Install — Your app: its install, its user and its doors
Retail Extension Log — Your app: its install, its user and its doors
Retail Extension Module — Your app: its install, its user and its doors
Retail Extension Package — Your app: its install, its user and its doors
Retail Extension Subscription — Your app: its install, its user and its doors
Retail Fiscal Reader — Your app: its install, its user and its doors
Retail Fiscal Regime Config — Your app: its install, its user and its doors
Retail Floor Place — Till sales
Retail Floor Section — Till sales
Retail Kitchen Order — Till sales
Retail Label Layout — Your app: its install, its user and its doors
Retail List Mark — Your app: its install, its user and its doors
Retail Open Check — Till sales
Retail Open Check Claim — Till sales
Retail Open Check Event — Till sales
Retail Override Request — Your app: its install, its user and its doors
Retail Partner Code — Your app: its install, its user and its doors
Retail Permission — Your app: its install, its user and its doors
Retail Register Book — Stock and stores
Retail Register Count — Stock and stores
Retail Register Erasure — Stock and stores
Retail Register Line — Stock and stores
Retail Register Period — Stock and stores
Retail Register State — Stock and stores
Retail Remote App Key — Your app: its install, its user and its doors
Retail Save Rule — Your app: its install, its user and its doors
Retail Scan Source — Your app: its install, its user and its doors
Retail Setting — The retailer's setup
Role — The retailer's setup
S
T
U
UOM — Items
User — Your app: its install, its user and its doors
User Permission — Your app: its install, its user and its doors
W
This record type in the kit