NameDescriptionTypeAdditional information
FirstName

First Name is required if a Consumer Account or Email is provided

string

None.

LastName

string

None.

Email

string

Matching regular expression pattern: ^[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?$

CustomerName

Customer Name is required if not a Consumer Account

string

None.

CustomerNumber

string

None.

IsConsumerAccount

This will be set to true if First Name is provided and Customer Name is not provided

boolean

None.

IsVendor

This flag will set Customer as also a Vendor

boolean

None.

Status

If not provided, this will be set based on CRM Settings setup in the application

IdNamePair

None.

Categories

This is required based on CRM Settings setup in the application. Category will be matched based on id first, if id is not present it will be matched based on name.

Collection of IdNamePair

None.

ReferralSource

This is required based on CRM Settings setup in the application. Referral Source will be matched based on id first, if id is not present it will be matched based on name.

IdNamePair

None.

Industry

Industry will be matched based on id first, if id is not present it will be matched based on name. If a match is not found, it will be ignored.

IdNamePair

None.

CustomerSince

date

None.

CreditLimit

decimal number

None.

WebSite

If valid Website is not provided, this will be ignored. (Ex. https://www.example.com)

string

None.

PrimaryLocation

If provided, this address will be set as primary.

Location

None.

BillToLocation

If Primary Location is not provided and Bill To Location is provided, this address will be set as primary.

Location

None.

ShipToLocation

If both Primary Location and Bill To Location is not provided and Ship To Location is provided, then this address will be set as primary.

Location

None.

ShipToSameAsBillTo

If passed as true, bill to location is required. Bill to location will be set as ship to location and any parameter passed for ship to location will be ignored.

boolean

None.

CountryDialCode

integer

None.

Phone

string

None.

IsTaxExempt

boolean

None.

IsFinanceChargeExempt

boolean

None.

PaymentTerm

Payment Term will be matched based on id first, if id is not present it will be matched based on name. If a match is not found, it will be ignored.

IdNamePair

None.

PriceList

Price List will be matched based on id first, if id is not present it will be matched based on name. If a match is not found, it will be ignored.

IdNamePair

None.

CustomFields

Custom Fields

Collection of CustomField

None.