API – Customer Collections
Introduction
This article lists the collection options for a customer.
Customer Type (customer.type)
Variable | Description |
customer.type.company | Customer is a company |
customer.type.flooringCustomer | Customer is a flooring customer (a company with a credit limit) |
customer.type.individual | Customer is an individual |
Gender (customer.gender)
Variable | Description |
customer.gender.female | The customer is a female |
customer.gender.male | The customer is a male |
customer.gender.unknown | The gender is unknown |
Generation Code (customer.generationCode)
Variable | Description |
customer.generationCode.ii | Same as "II" |
customer.generationCode.iii | Same as "III" |
customer.generationCode.iv | Same as "IV" |
customer.generationCode.v | Same as "V" |
customer.generationCode.vi | Same as "VI" |
customer.generationCode.vii | Same as "VII" |
customer.generationCode.viii | Same as "VIII" |
customer.generationCode.ix | Same as "IX" |
customer.generationCode.sr | Same as "Sr." |
customer.generationCode.jr | Same as "Jr." |
customer.generationCode.none | No generation code |
ID Number Type (customer.idType)
Variable | Description |
customer.idType.employerNumber | Employer Identification Number |
customer.idType.sin | Social Insurance Number |
customer.idType.ssn | Social Security Number |
Customer Status (customer.status)
Variable | Description |
customer.status.active | The customer's status is active. |
customer.status.lead | Indicates a potential customer. |