Library
Developer Home
FD1 Client Protocol
Home
Concepts
Reading Data
Writing Data
Protocol Defined
Servers
Connect & Authenticate
Proxies & Tunnels
Webhooks & FirehosesProgramming Support
Logging
Minor Facts
State Facts
Response Format
How To Guides
eCommerce Sites
Custom Point of Sale
Customer Access
Bulk Downloads
Major APIs / Endpoints
All Endpoints
Products
Sales
SalesBuilder
Session
Get Attribute
Sale Capture
General Purpose
Data Capture
Devices
Barcode Scanners
Eftpos
IoT Sensors
Power Outlets
Printing
Scales
Security Cameras
Purchasing / Supply Side
Purchase Orders
Invoices
Invoice Payments
Document Capture
Rare APIs / Endpoints
SSL Certificates
API Key Management
Diagnositics
PosGreen
Server to Client Messages
Overview
Resources / Objects
Purchase Order
Invoice Payable
Invoice Payment
Product
Supplier
Location
Sale Lines
Sale Delivery Details
Sales
Price Maps
Employees
Carriers
Payments
Product Kits
Department 1
Customers
Webhooks & Firehoses
Pricemaps Resource
This resource describes details of a single Pricemaps
"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.
Available Fields
Name | Description | Datatype | Resource | "q" |
id | Number | |||
pid | Number | |||
depid | Number | |||
cid | Number | |||
locid | Number | |||
priority | Number | |||
enddt | DateTime | |||
startdt | DateTime | |||
unitprice | Money/Currency | |||
pricepct | Double | |||
comments | String | |||
dow | Day of Week entry is valid on | String | ||
physkey | Internal unique identifier | String | ||
controlflags | Control any special effects when processing this pricemap | Number | ||
prompt | String | |||
publiccomments | String | |||
barcode | A barcode that must be scanned before this pricemap will apply. See also the typecode field. | String | ||
typecode | A user entered voucher code or password that must be entered before this pricemap will apply. This is similar to the barcode field but manually entered | String | ||
deltaprice | ||||
usertypekey | A physkey referencing the TypesUser table which describes a user defined group or categorisation for this pricemap entry. For example a key pointing to "Clearance Stock" | String | ||
marketingkey | A physkey referencing the MarketingProgram table which places this pricemap into a marketing effort. | String | ||
createdt | Date/time (local) this record was created | DateTime | ||
plevelmin | Minimum version of code to understand and process this record | Number | ||
pricegroupkey | Physkey of a PriceGroup that defined or owns this entry | String | ||
rmsystem | String | |||
spid | Number | |||
countrycode | Valid for locations in this Country code | Number | ||
geoarea | Valid for locations in this Country code | Number | ||
pricetype | Internal code indicating what this pricemap holds | Number | ||
nocustomerpriceband | Block this pricemap and customer specific pricebands from existing on the same sale | |||
repricesale | Reprice the whole sale when this pricemap becomes valid for a sale |