Customer Data
Customer data is exported to a JSON file named CustomerList.json and contains the Customer object along with its paired Address, Email, Phone, and Transfer objects.
Customer
| CustomerAccountKey |
String, 255 characters, cannot be null For linked accounts, this is the customer number of the primary person. It will be the same as CustomerKey if this is the primary person on two linked customer records OR if there is no spouse on file. Bidirectional |
||||||
| CustomerAcquisition |
String, 255 characters, can be null How the customer was acquired. |
||||||
| CustomerAsKey |
Integer, max 3 digits, can be null The associate signed to this customer. |
||||||
| CustomerBirthDate |
Date/Time, mm/dd/yyyy hh:mm:ss, can be null The customer's birthdate. Bidirectional |
||||||
| CustomerCompany |
String, max 255 characters, can be null The name of the company. Bidirectional |
||||||
| CustomerCoupleName |
String, max 255 characters, can be null For customer's with spouses, this is how the combined name should appear. Bidirectional |
||||||
| CustomerCreditLimit |
Decimal, max 18 digits, can be null For credit limit on this customer's store charge account. |
||||||
| CustomerDateEntered |
Date/Time, mm/dd/yyyy hh:mm:ss, can be null The date this customer was entered. |
||||||
| CustomerDateVerified |
No longer used (legacy) |
||||||
| CustomerDiscount |
No longer used (legacy) |
||||||
| CustomerFirstName |
String, max 255 characters, cannot be null The customer's first name. Bidirectional |
||||||
| CustomerGender |
String, max 1 character, can be null The customer's gender.
Bidirectional |
||||||
| Customerid |
Integer, max 7 digits, cannot be null The sequential customer number for this customer. The second component of CustomerKey, i.e. the customer number. |
||||||
| CustomerImage |
String, max 63,999 characters, can be null The image file linked to this customer. If there are multiple images each file name delineated by a vertical bar. Bidirectional |
||||||
| CustomerInactive |
Boolean, True/False, cannot be null
|
||||||
| CustomerInterestRate |
Decimal, max 18 digits, can be null Special interest rate for this customer's house account. Overrides system default. |
||||||
| CustomerIsCompany |
Boolean, True/False, cannot be null
|
||||||
| CustomerKey |
String, max 255 characters, cannot be null The customer number in format [CustomerStoreId - Customerid], e.g. 001-00001. |
||||||
| CustomerKey1 - 8 |
String, max 255 characters, can be null Custom detail fields defined by the user. Bidirectional |
||||||
| CustomerLastName |
String, max 255 characters, cannot be null The customer's last name. Bidirectional |
||||||
| CustomerLicenseNo |
String, 255 characters, can be null The customer's license number. |
||||||
| CustomerMarried |
No longer used (legacy) |
||||||
| CustomerMiddleName |
String, max 255 characters, cannot be null The customer's middle name. Bidirectional |
||||||
| CustomerMinMarkup |
No longer used (legacy) |
||||||
| CustomerMinPayment |
Decimal, max 18 digits, can be null The minimum payment due for this customer's house account. Overrides system default. |
||||||
| CustomerNoStatements |
Boolean, True/False, cannot be null
|
||||||
| CustomerNotes |
String, max 63,999 characters, can be null The first 255 characters of notes are stored in CustomerNotes255. Any characters over that limit are stored here. All notes are in RTF format. |
||||||
| CustomerNotes255 |
String, max 255 characters, can be null Notes on the customer. If the notes are longer than 255 characters the overflow goes to CustomerNotes. All notes are in RTF format. |
||||||
| CustomerOldCustKey |
String, max 255 characters, can be null For customers converted from another software system, this is the customer number in the previous software. |
||||||
| CustomerPrefEmail |
String, max 255 characters, can be null The key of the preferred email address. Bidirectional |
||||||
| CustomerPrefMail |
String, max 255 characters, can be null The key of the preferred mailing address. Bidirectional |
||||||
| CustomerPrefPhone |
String, max 255 characters, can be null The key of the preferred phone number. Bidirectional |
||||||
| CustomerQuickbooks |
No longer used (legacy) |
||||||
| CustomerReferredBy |
String, 255 characters, can be null The customer number of the person who referred this person.. |
||||||
| CustomerSpouseBirthdate |
Date/Time, mm/dd/yyyy hh:mm:ss, can be null The customer's spouse's birthdate. Bidirectional |
||||||
| CustomerSpouseKey |
String, max 255 characters, can be null The customer number of this customer's spouse. |
||||||
| CustomerSSNO |
No longer used (legacy) |
||||||
| CustomerStoreId |
Integer, 3 digits, cannot be null The store number for this customer. |
||||||
| CustomerSuffix |
String, 255 characters, can be null The customer's suffix, e.g. junior. Bidirectional |
||||||
| CustomerSwapped |
No longer used (legacy) |
||||||
| CustomerTaxExempt |
Boolean, True/False, cannot be null
|
||||||
| CustomerTaxId |
String, max 255 characters, can be null The tax ID for this customer. |
||||||
| CustomerTerms |
No longer used (legacy) |
||||||
| CustomerTitle |
String, 255 characters, can be null The customer's title, e.g. doctor. Bidirectional |
||||||
| CustomerType |
String, max 255 characters, can be null Custom detail fields defined by the user. Bidirectional |
||||||
| CustomerUpdateDate |
Date/Time, mm/dd/yyyy hh:mm:ss, cannot be null The date/time customer record was last modified. |
||||||
| CustomerUpdateSeq |
Integer, max 7 digits, cannot be null This number is incremented by one each time the customer record is updated. |
||||||
| CustomerUpdateStation |
Integer, max 3 digits, cannot be null The workstation number where the customer record was last updated. |
||||||
| CustomerUpdateStore |
Integer, max 3 digits, cannot be null The store number where the customer record was last updated. |
||||||
| CustomerUpdateUser |
Integer, max 3 digits, cannot be null The associate number for the person that last updated customer record. |
||||||
| CustomerWeddingAnniv |
Date/Time, mm/dd/yyyy hh:mm:ss, can be null The customer's wedding anniversary. Bidirectional |
||||||
| CustomerWholesale |
No longer used (legacy) |
||||||
| CustomerXfer |
Boolean, True/False, cannot be null
|
||||||
| CustomerYnStoreCredit |
Boolean, True/False, cannot be null
|
Addresses
| Key | The key paired to this data set. |
| AddressCustKey |
String, max 255 characters, cannot be null The customer number in format [CustomerStoreId - Customerid], e.g. 001-00001, that this address belongs to. |
| AddressType |
String, max 255 characters, cannot be null The type of address, e.g. home, work. |
| AddressCompany |
String, max 255 characters, can be null Company name included in address. |
| AddressStreet |
String, max 255 characters, cannot be null The street number and name of the address. |
| AddressStreet2 |
String, max 255 characters, can be null Additional street address data, e.g. suite., for this address. |
| AddressCity |
String, max 255 characters, cannot be null The city in the address. |
| AddressState |
String, max 255 characters, cannot be null The state in the address. |
| AddressZip |
String, max 255 characters, cannot be null The ZIP or postal code in the address. |
| AddressCountry |
String, max 255 characters, can be null The country in the address. |
| AddressCustAccountKey |
String, 255 characters, cannot be null For linked accounts, this is the customer number of the primary person. It will be the same as AddressCustKey if this is the primary person on two linked customer records OR if there is no spouse on file. |
Emails
| Key | The key paired to this data set. | ||||
| EmailCustKey |
String, max 255 characters, cannot be null The customer number in format [CustomerStoreId - Customerid], e.g. 001-00001, that this email belongs to. |
||||
| EmailType |
String, max 255 characters, cannot be null The type of email address, e.g. home, work. |
||||
| EmailEmail |
String, max 255 characters, cannot be null The email address. |
||||
| EmailSendPromo |
Boolean, True/False, cannot be null
|
||||
| EmailCustAccountKey |
String, 255 characters, cannot be null For linked accounts, this is the customer number of the primary person. It will be the same as AddressCustKey if this is the primary person on two linked customer records OR if there is no spouse on file. |
Phones
| Key | The key paired to this data set. | ||||
| PhoneCustKey |
String, max 255 characters, cannot be null The customer number in format [CustomerStoreId - Customerid], e.g. 001-00001, that this phone number belongs to. |
||||
| PhoneType |
String, max 255 characters, cannot be null The type of phone number, e.g. home, work. |
||||
| PhonePhone |
String, max 255 characters, cannot be null The phone number. |
||||
| PhoneDoNotContact |
Boolean, True/False, cannot be null
|
||||
| PhonePhoneExt |
String, max 255 characters, can be null The phone number's extension. |
||||
| PhoneCustAccountKey |
String, 255 characters, cannot be null For linked accounts, this is the customer number of the primary person. It will be the same as AddressCustKey if this is the primary person on two linked customer records OR if there is no spouse on file. |
CustomerTransfer
This object links your customer record to an Edge customer record.
| WebTransferKey |
String, max 255 characters, can be null Internal Edge key - do not change |
| WebTransferEdgeID |
String, max 255 characters, can be null Internal Edge key - do not change |
| WebTransferWebID |
String, max 255 characters, can be null Your ID number or key for this customer record; used to link your customer record to the Edge. If this is null then this customer has not been linked. When EDT imports the CustomerList.json back into the Edge it will link your customer ID/key to the Edge customer record. If no Edge customer exists, it will add them as a new customer. |
| WebTransferLastModified |
Date/Time, mm/dd/yyyy hh:mm:ss, cannot be null The date/time this record was last updated. |
| WebTransferRequiresWebUpload |
Boolean, True/False, cannot be null Internal flag - do not change |
| WebTransferRequiresEdgeAttention |
Boolean, True/False, cannot be null Internal flag - do not change |
| WebTransferType |
Integer, 1 digit, cannot be null Internal flag - do not change |