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
Department1 Resource
This resource describes details of a single Department1
"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.
Available Fields
Name | Description | Datatype | Resource | "q" |
depid | Number | Yes | ||
description | String | |||
minmargin | Double | |||
maxmargin | Double | |||
flags | Number | |||
color | Number | |||
deleted | Department has been deleted | |||
physkey | String | |||
sortorder | Number | |||
rmsystem | String | |||
marginalert | Alert at POS if current margin outside targets | |||
xeroaccountid | Account id in Xero for this payment type | String | ||
loadcostpolicy | How/if cost price should be loaded into stores during a sync operation | Number | ||
sitecategory | ||||
default_webgroup | Default webgroup used for products in this department that do not specifically have a webgroup defined themselves | Number |