Customer data model

This is the data structure of Customer entity when you are trying to create or update Customer in myKaarma.

Summary of the fields.

Parameter Name	Description	Required
customerKey	Unique identifier used by DMS to uniquely identify each customer, used by mykaarma to lookup customers in DMS databases for various purposes like update, deletion, booking appointment etc.	No
firstName	Customer's first name.	Yes ( no only if isBusiness is set to true and company name is provided)
lastName	Customer's last name.	Yes ( no only if isBusiness is set to true and company name is provided)
company	Name of the company if the customer is a business.	No ( yes only if isBusiness is set to true )
isBusiness	Boolean indicating if the customer is a business entity. Set true for company customers, fleet customers.	No
preferredCommunication	Refers to the customer's preferred method of communication. Allowed values are text, phone , email	No
addresses	List of addresses associated with the customer.	No
preferredLocale	Customer's preferred language or locale. ( use en-us for English or fr-ca for French)	No
emails	List of email addresses associated with the customer.	No
phoneNumbers	List of phone numbers associated with the customer.	No
vehicles	List of vehicles owned by the customer.	No
validateVin	Boolean indicating if the vehicle's VIN should be validated. If set to true , invalid VIN vehicles would be rejected.	No
searchForDuplicate	Boolean indicating if the system should check for duplicate customers before creation. API Partners are expected to pass this parameter as false	No
addresses.type	An enumeration with possible values: COMMON, PRIMARY, BILLING which tells type of address. COMMON: Used when the primary and billing addresses are the same. PRIMARY: Represents the customer's home address. BILLING: Represents the customer's business address. Recommended: PRIMARY.	Yes ( only if addresses is not empty )
addresses.addressType	Indicates the type of address: use P for PRIMARY/COMMON type and B for BILLING type. Recommended: P.	Yes ( only if addresses is not empty )
addresses.line1	The first line of the customer's address.	Yes ( only if addresses is not empty )
addresses.line2	The second line of the customer's address, often used for apartment or suite numbers.	No
addresses.zip	The postal code for the customer's address.	No
addresses.country	The country of the customer's address.	Yes ( only if addresses is not empty )
addresses.isValid	Boolean indicating if the address is valid. Default value true.	No
addresses.isPreferred	Boolean indicating if this is the customer's preferred address. Default value : false.	No
addresses.state	The state or region of the customer's address.	Yes ( only if addresses is not empty )
emails.emailAddress	The customer's email address.	Yes ( only if emails is not empty )
emails.label	Describes the type of email. Allowed values are personal,home,work,other.	Yes ( only if emails is not empty )
emails.okToEmail	Boolean indicating if it's permissible to send emails to this address. Allowed values true/false.	Yes
emails.isPreferred	Boolean indicating if this is the customer's preferred email address. Allowed values true/false.	Yes
phoneNumbers.phoneNumber	The customer's phone number, prefixed with +1 for the country code. example +11234567890	Yes ( only if phones is not empty)
phoneNumbers.label	Describes the type of phone. Allowed values are cell,business,home,work,other. If you have a primary phone number on your side, always send it with cell because cell is used for auto communication within myKaarma	Yes ( only if phones is not empty)
phoneNumbers.okToCall	Boolean indicating if it's permissible to call this number. Allowed values true/false.	Yes
phoneNumbers.okToText	Boolean indicating if it's permissible to send text messages to this number. Allowed values true/false.	Yes
phoneNumbers.isPreferred	Boolean indicating if this is the customer's preferred phone number. Allowed values true/false.	Yes