FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks & Firehoses Programming 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

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

NameDescriptionDatatypeResource"q"
sidNumber
completeddtDate the sale is completed and will not undergo any futher change. This value is in the local time of the store. See also CompleteddtutcDateTime
saletotalMoney/Currency
phaseState 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=1Number
startdtDateTime
restartflagsBitmask containing internal processing flags.Number
ridNumber
tellerNumber
cidNumber
printflagsStatus of receipt printing and sending. Technically a bitmask, however the lower 8 bits are a count of printsNumber
originalsidNumber
srcuidNumber
srcuidkeyNumber
locationNumber
billingrunNumber
externalidString
salestypeNumber indicating the type of sale, such as where or how the sale was initiatedNumber
commentsString
posversionString
physkeyString
physkeycustPhyskey of the customer recordString
stocklocationNumber
physlocationNumber
parentNumber
rmsystem0
rmsystem1
rmsystem2
rmsystem3
createappCoded number indicating the program, app or web page that created this saleNumber
createipThe source IP address of the machine or browser client that created this sale. String
quoteexpiryDate/time this quotation expires and will no longer be validDateTime
geolatitudeLatitude of user or Pos capture program when sale recordedDouble
geolongitudeLongitude of user or Pos capture program when sale recordedDouble
geoaltitudeAltitude of user or Pos capture program when sale recordedDouble
completeddtutcDate the sale is completed and will not undergo any futher change. This value is a UTC date. See also CompleteddtDateTime
ordernoCustomers order numberString
custsourceHow the customer was identified and selected to this saleNumber
indicatorsBitmask containing various state indication flagsNumber
custdueDate/time (local) that customer is due to returnDateTime
commentsinternalComments for this sale that are internal use only
x_ms_workflow_run_idString
serverprocessingstateUsed on Head Office databases to track status of post sale processing. See ServerProcessing table for more information. Number
packingprocessingInternal control data used by packing processesString
packingconsignmentInternal control data used by packing processesString
packingcommentsemailEmail comment sent to customer when order dispatchedString