Customers Resource

This resource describes details of a single Customers

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Available Fields

Name	Description	Datatype	Resource	"q"
cid	Unique number assigned to this customer record. Negative numbers may be subject to automatic renumbering. Zero is never used.	Number
key	Unique primary key assigned to this record.	String
name	The customers full name. This field is typically used on reports. If left blank the system will populate it based on other fields	String
lastname	The last name of the customer.	String
firstname	The customers first (christian) name.	String
address1	Line 1 of the customer primary address	String
address2	Line 2 of the customer primary address	String
address3	Line 3 of the customer primary address	String
address4	Line 4 of the customer primary address	String
address5	Line 5 of the customer primary address	String
address6	Line 6 of the customer primary address	String
city	Primary city or town this customer resides in. This value is expected to also be present in the AddressN fields and is extracted to aid reporting	String
postcode	Post code for this customer. This value is expected to also be present in the AddressN fields if relevant and is extracted to aid reporting	String
phone	Customer primary phone number	String
mobile	Customers mobile phone number	String
fax	Customers fax number	String
email	Customers primary email address	String
contactcomment	A comment relating to communication with this customer. Designed to say things like 'Do not call after 6pm'	String
birthday	Customers birthday. This can be either a precise date or a DD/MM pair. Used to trigger Point Of Sale messages on this aniversary
creditlimit	Total credit limit for this customer. Typically customers belong to an account and the account provides the credit limit
floorlimit	Maximum single transaction for this customer.
customercardno	A unique barcode sequence assigned to this customer alone. This field should contain the complete barcode
accountid	Account number this customer belongs too. Zero if customer does not have a charge account.	Number
receiptformat	If this customer is to use a specific receipt format, this field contains the name of the format to override system defaults
emailreceipt	Email Sale Receipts
createdate	Date this customer was created in the system.	DateTime
phone2	Secondary phone number of customer	String
companyname	Company name for this customer	String
keywords	A comma or pipe seperated list of keywords assigned to this customer. Keywords and meanings are free for sites to assign.
createdstore	Store that originally created this customer
customerrep
comments	Free form comments
division
state	State/Province for address	String
marketingoptin		Number
eucitizen
recordtype
marketingflags		Number
latitude	Customers primary Geographic latitude	Double
longitude	Customers primary Geographic longitude	Double
altitude	Customers primary Geographic altitude	Double
contactinterval	Defines the number of days that can elapse before contact is made to this customer	Number
crmflags		Number
lastcontactdt	Date/time (local) this customer was last contacted.	DateTime
occupationfreeform		String
occupationanzsco		Number
sellingmessage	Simple text message displayed on screen when customer selected at Point Of Sale	String
emailtransactions	Customers email address for transaction information	String
emailmarketing	Customers email address for marketing	String
emailgeneral	Customers email address for general communication	String
abn	Australian ABN number	String
gst	GST number	String
nzbn	New Zealand NZBN Number	String
deletedate	Date this customer was deleteed in the system.	DateTime
externalid	A site specific external Id, used when a link to another systems id is required	String
myobcontactid		String
languagelist	Comma seperated list of languages for this customer	String
address	Complete multi line address	String
accountterms	Credit terms to be applied if creating an account for this customer
accountcreditlimit	Credit limit to be applied if creating an account for this customer
lastsaledt	Date/time of last completed sale to this customer
lastsaleage	Elapsed days since last completed sale to this customer
lastsaleid	Last Sale Id number
lifetimespend	Total revenue from customer for all time	Money/Currency
stopcredit	Set to true if this customer is on stop credit.
u_invoicefrequency
prepay
u_accountstatus