Customer Element

In This Topic

Namespace

https://wsapi.ams360.com/v3.0/DataContract

Type

Customer Complex Type

Diagram

Overview

Customer Customer Complex Type

Sequence

IsActive optional xs:boolean

Indicates whether or not the customer has active business with the agency.

AddressLine1 optional xs:string

First line of address.

AddressLine2 optional xs:string

Second line of address.

CustomerNotationId optional guid Simple Type

BrokerCode optional xs:string

Broker code indicating the broker assigned to this customer's account.

Insert Validation:
Required when IsBrokersCustomer is true.

Update Validation:
Required when IsBrokersCustomer is true.

Valid values are maintained in the broker entity.

BusinessAreaCode optional xs:string

Area code portion of the business phone number.

BusinessExtension optional xs:string

Extension portion of the business phone number.

BusinessPhone optional xs:string

Phone portion of the business phone number.

Insert Validation:
Required if business area code exists.

Update Validation:
Required if business area code exists.

InBusinessSince optional xs:string

The year the customer started business.

Example: YYYY

City optional xs:string

City portion of address.

County optional xs:string

County portion of address.

AccountRepCode optional xs:string

Employee code indicating the account representative assigned to this customer's account.

Valid values are maintained in the employee entity where Representative is true.

DateCustomerAdded optional xs:dateTime

Date customer was added to the database. If customer type value changes, this date is updated to the current date of the change.

Insert Validation:
AMS360 creates on insert.

Update Validation:
Ignored on update.

CustomerId optional guid Simple Type

Globally Unique Identifier (GUID) for a customer.

Insert Validation:
AMS360 creates on insert.

Update Validation:
Match on customer id required for update.

36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000

CustomerNumber optional xs:int

Alternate key that uniquely identifies a customer.

Insert Validation:
AMS360 creates on insert.

Update Validation:
Ignored on update.

Positive whole number, uniqueness is maintained in AMS360.

DoingBusinessAs optional xs:string

Name with which the customer is doing business.

DateOfBirth optional xs:dateTime

Date of birth.

Example: 01/01/1968

DUNSNumber optional xs:string

Email optional xs:string

FaxAreaCode optional xs:string

Area code portion of the fax phone number.

FaxExtension optional xs:string

Extension portion of the fax phone number.

FaxPhone optional xs:string

Phone portion of the fax phone number.

Insert Validation:
Required if fax area code exists.

Update Validation:
Required if fax area code exists.

FederalTaxIdNumber optional xs:string

Federal Employer Identification Number (FEIN).

FirmName optional xs:string

Customer's business name.

Insert Validation:
Required if last name does not exist.

Update Validation:
Required if last name does not exist.

FirstName optional xs:string

Customer's first name.

FormalSalutation optional xs:string

Salutation used in formal correspondence.

GLBranchCode optional xs:string

Business unit general ledger branch code for this customer account.

Insert Validation:
Required when CustomerType is P or C.

Update Validation:
Required when CustomerType is P or C.

Valid values are maintained in the business unit entity for general ledger branches where GLDivisionCode matches.

GLDepartmentCode optional xs:string

Business unit general ledger department code for this customer account.

Insert Validation:
Required when CustomerType is P or C.

Update Validation:
Required when CustomerType is P or C.

Valid values are maintained in the business unit entity for general ledger departments where GLBranchCode matches.

GLDivisionCode optional xs:string

Business unit general ledger division code for this customer account.

Insert Validation:
Required if CustomerType = P or C.

Update Validation:
Required if CustomerType = P or C.

Valid values are maintained in the business unit entity for general ledger divisions.

GLGroupCode optional xs:string

Business unit general ledger group code for this customer account.

Insert Validation:
Required when CustomerType is P or C.

Update Validation:
Required when CustomerType is P or C.

Valid values are maintained in the general ledger group entity where GLDepartmentCode matches.

InformalSalutation optional xs:string

Salutation used in informal correspondence.

IsBenefits optional xs:boolean

Indicates customer has benefits business with agency.

IsBrokersCustomer optional xs:boolean

Indicates whether or not this customer is a broker's customer.

IsCommercial optional xs:boolean

Indicates customer has commercial lines business with agency.

IsFinancial optional xs:boolean

Indicates customer has financial services business with agency.

IsHealth optional xs:boolean

Indicates customer has health business with agency.

IsLife optional xs:boolean

Indicates customer has life business with agency.

IsNonPropertyAndCasualty optional xs:boolean

Indicates customer has non property and casualty business with agency.

IsPersonal optional xs:boolean

Indicates customer has personal lines business with agency.

LastName optional xs:string

Customer's last name.

Insert Validation:
Required if firm name does not exist.

Update Validation:
Required if firm name does not exist.

CellAreaCode optional xs:string

Area code portion of the cell phone number.

CellExtension optional xs:string

CellPhone optional xs:string

Phone portion of the cell phone number.

Insert Validation:
Required if cell area code exists.

Update Validation:
Required if cell area code exists.

MaritalStatus optional xs:string

Marital Status.

Insert Validation:
Must be set to one of the following:
“Married”
“Single”
“Divorced”
“Separated”
“Widowed”
“Dom Partn”
“Fiancee”
“Other”
“Unknown”
“Civ Union”

Update Validation:
Must be set to one of the following:
“Married”
“Single”
“Divorced”
“Separated”
“Widowed”
“Dom Partn”
“Fiancee”
“Other”
“Unknown”
“Civ Union”

Description value from the "MaritalStatus" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=MaritalStatus

MiddleName optional xs:string

Customer's middle name.

Occupation optional xs:string

Customer's occupation.

PagerAreaCode optional xs:string

Area code portion of the customer's pager.

PagerExtension optional xs:string

Extension number portion of the customer's pager.

PagerPhone optional xs:string

Phone number portion of the customer's pager.

Insert Validation:
Required if pager area code exists.

Update Validation:
Required if pager area code exists.

AccountExecCode optional xs:string

Employee code indicating the account executive assigned to this customer's account.

Valid values are maintained in the employee entity where Executive is true.

HomeAreaCode optional xs:string

Area code portion of the home phone number.

HomeExtension optional xs:string

Extension portion of the home phone number.

HomePhone optional xs:string

Phone portion of the home phone number.

Insert Validation:
Required if home area code exists.

Update Validation:
Required if home area code exists.

NAICSCode optional xs:string

North American Industry Classification System(NAICS) code for the business the customer represents.

State optional xs:string

State portion of address.

Code value from the "State" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=State

CustomerType optional xs:string

Represents whether the customer has placed business with an agency (customer), may potentially place business with the agency (prospect) or is a marketing contact for business solicitation (suspect).

Update Validation:
If customer type = C (customer) or P (prospect) the entity cannot be set to S (suspect).

Code value from the "CustomerType" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=CustomerType

BusinessEntityType optional xs:string

Business entity of the customer.

Description value from the "TypeOfEntity" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=TypeOfEntity

WebAddress optional xs:string

URL to the customer's web address.

ZipCode optional xs:string

Zip code portion of address.

IsSecured optional xs:boolean

Indicates whether employees need to have limited access to this customer.

SICCode optional xs:string

Standard Industrial Classification(SIC) code for the business the customer represents.