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
Sales Resource
This resource describes details of a single Sales
"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.
Available Fields
Name | Description | Datatype | Resource | "q" |
sid | Number | |||
completeddt | Date the sale is completed and will not undergo any futher change. This value is in the local time of the store. See also Completeddtutc | DateTime | ||
saletotal | Money/Currency | |||
phase | State of the sale, as in is it complete, parked, void etc. When selecting sales for reports you will typically only want to select those where phase=1 | Number | ||
startdt | DateTime | |||
restartflags | Bitmask containing internal processing flags. | Number | ||
rid | Number | |||
teller | Number | |||
cid | Number | |||
printflags | Status of receipt printing and sending. Technically a bitmask, however the lower 8 bits are a count of prints | Number | ||
originalsid | Number | |||
srcuid | Number | |||
srcuidkey | Number | |||
location | Number | |||
billingrun | Number | |||
externalid | String | |||
salestype | Number indicating the type of sale, such as where or how the sale was initiated | Number | ||
comments | String | |||
posversion | String | |||
physkey | String | |||
physkeycust | Physkey of the customer record | String | ||
stocklocation | Number | |||
physlocation | Number | |||
parent | Number | |||
rmsystem0 | ||||
rmsystem1 | ||||
rmsystem2 | ||||
rmsystem3 | ||||
createapp | Coded number indicating the program, app or web page that created this sale | Number | ||
createip | The source IP address of the machine or browser client that created this sale. | String | ||
quoteexpiry | Date/time this quotation expires and will no longer be valid | DateTime | ||
geolatitude | Latitude of user or Pos capture program when sale recorded | Double | ||
geolongitude | Longitude of user or Pos capture program when sale recorded | Double | ||
geoaltitude | Altitude of user or Pos capture program when sale recorded | Double | ||
completeddtutc | Date the sale is completed and will not undergo any futher change. This value is a UTC date. See also Completeddt | DateTime | ||
orderno | Customers order number | String | ||
custsource | How the customer was identified and selected to this sale | Number | ||
indicators | Bitmask containing various state indication flags | Number | ||
custdue | Date/time (local) that customer is due to return | DateTime | ||
commentsinternal | Comments for this sale that are internal use only | |||
x_ms_workflow_run_id | String | |||
serverprocessingstate | Used on Head Office databases to track status of post sale processing. See ServerProcessing table for more information. | Number | ||
packingprocessing | Internal control data used by packing processes | String | ||
packingconsignment | Internal control data used by packing processes | String | ||
packingcommentsemail | Email comment sent to customer when order dispatched | String |