Customer Web Service Reference

4 Customer Web Service Reference

This chapter provides information about the Oracle Communications MetaSolv Solution (MSS) Customer Web Service.

About the Customer Web Service

The Customer Web Service enables an external system to import and maintain customer accounts in MSS. Customer Web Service operations enable you to:

Import or update a customer account into MSS.
Get a customer account details using customer account id from MSS.
Delete a customer account using customer account id from MSS.

About the Customer Web Service Packaging

The Customer Web Service is packaged in the MSS_WebService.ear file which contains the customer.war file. When the installer deploys the EAR file, the Customer Web Service is automatically deployed and ready to use.

Note:

The MSS_WebService.ear file also includes the other MSS web service operations. See Web Services Overview for information about these operations.

About the Customer WSDL, WAR, and Schema Files

The Customer Web Service is defined by the CustomerAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the customer.war file.

See "Understanding How MSS Defines Web Services" for more information about WSDL and WAR files, and about their directory locations in the EAR file.

About Customer Schema Files

Several schema files support the Customer Web Service. Within customer.war file, the schema files are located in the WEB-INF/wsdls directory. These schemas are categorized as common schemas, entity schemas, data schemas, and API schemas.

Common Schemas

For information about the common schema files, see "About Schema Files".

Entity Schemas

The entity schemas define elements, such as keys and types, specific to the web service.

The Customer entity schemas are defined in the following files:

CustomerManagementEntities.xsd
InventoryManagementEntities.xsd
MIPCommonEntities.xsd
OrderManagementEntities.xsd
OrderManagementEvents.xsd
ServiceEntities.xsd

Data Schemas

The data schemas contain numerous complex type structures, enumerations, and simple types.

The Customer data schemas are defined in the following files:

CustomerManagementData.xsd
InventoryManagementData.xsd
OrderAncillaryManagementData.xsd
OrderManagementData.xsd
ServiceData.xsd

API Schemas

The API schemas contain the high-level response and request type definitions and exception definitions.

The Customer API schemas are defined in the following files:

CustomerManagementAPI.xsd
OrderManagementAPI.xsd

deleteCustomerRequest Operation

This operation enables you to delete a customer account. It deletes all of the child accounts if there is no telephone number reservation against the customer account and if they are not dependent on the following:

Service request
Service items

The following are the request and response structures:

Request Structure: deleteCustomerRequest

Response Structure: deleteCustomerRequestResponse

deleteCustomerRequest

The deleteCustomerRequest element contains the input information for the operation. Each row in Table 4-1 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 4-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
deleteCustomerRequest	element	deleteCustomerAccountByKeyRequest	CustomerAPI.wsdl
deleteCustomerAccountByKeyRequest	element	mcmmekey	CustomerManagementAPI.xsd
mcmmekey	element	MetaSolvCustomerAccountKeyChoice	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKeyChoice	complexType	metaSolvCustomerAccountKey	CustomerManagementEntities.xsd
metaSolvCustomerAccountKey	element	MetaSolvCustomerAccountKey	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKey	complexType	Extension of CustomerAccountKey Contains a list of fields	CustomerManagementEntities.xsd

Table 4-2 describes the required fields for deleteCustomerRequest.

Table 4-2 Required Fields for deleteCustomerRequest

Field Name	Data Type	Field Description
customerAccountPrimaryKey	string	Customer Account ID of the customer account.

deleteCustomerRequestResponse

The deleteCustomerRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 4-3 describes the returned information in the response.

Table 4-3 Payload Information for the Response

Name	Defined As	Type Description	File Name
deleteCustomerRequestResponse	element	deleteCustomerAccountByKeyResponse	CustomerAPI.wsdl
deleteCustomerAccountByKeyResponse	element	Contains the status string	CustomerManagementAPI.xsd

Table 4-4 describes the error messages for the operation.

Table 4-4 Error Messages for the Operation

Error Message	Cause	Resolution
Record not found: PSRCustomerAccount.custAcctID=	Customer account ID provided is not valid.	Populate a valid customer account ID.
PSRServReqServItemProcessorMSG001:The customer account cannot be deleted as it has relationships with other customer accounts or service requests.	The customer account ID provided is associated with other customer account or service requests.	Check the dependent customer accounts or service requests before deleting the customer account.
PSRServReqServItemProcessorMSG002:This Customer account or child customer/billing account have service items. It cannot be deleted.	This customer account or child customer or billing account have service items.	Populate the customer account without active service items associated.

getCustomerAccountByKey Operation

You can use this operation to retrieve customer account details by using the Customer Account ID which will be passed as an input value.

The following are the request and response structures:

Request Structure: getCustomerAccountByKey

Response Structure: getCustomerAccountByKeyResponse

getCustomerAccountByKey

The getCustomerAccountByKey element contains the input information for the operation. Each row in Table 4-5 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 4-5 Payload Information for the Request

Name	Defined As	Type Description	File Name
getCustomerAccountByKey	element	getCustomerAccountByKeyRequest	CustomerAPI.wsdl
getCustomerAccountByKeyRequest	element	mcmmekey	CustomerManagementAPI.xsd
mcmmekey	element	MetaSolvCustomerAccountKeyChoice	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKeyChoice	complexType	Complex type with metaSolvCustomerAccountKey element	CustomerManagementEntities.xsd
metaSolvCustomerAccountKey	element	MetaSolvCustomerAccountKey	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKey	complexType	Extension of CustomerAccountKey Contains a list of fields	CustomerManagementEntities.xsd

Table 4-6 describes the required fields for getCustomerAccountByKey.

Table 4-6 Required Fields for getCustomerAccountByKey

Field Name	Data Type	Field Description
customerAccountPrimaryKey	string	Customer Account ID of the customer account.

getCustomerAccountByKeyResponse

The getCustomerAccountByKeyResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 4-7 describes the returned information in the response.

Table 4-7 Payload Response for the Response

Name	Defined As	Type Description	File Name
getCustomerAccountByKeyResponse	element	CusgetCustomerAccountByKeyResponse	CustomerAPI.wsdl
CusgetCustomerAccountByKeyResponse	element	Contains the mcmmevalue element	CustomerManagementAPI.xsd
mcmmevalue	element	MetaSolvCustomerAccountValueChoice	CustomerManagementEntities.xsd
MetaSolvCustomerAccountValueChoice	complexType	complextype with metaSolvCustomerAccountValue element	CustomerManagementEntities.xsd
metaSolvCustomerAccountValue	element	MetaSolvCustomerAccountValue	CustomerManagementEntities.xsd
MetaSolvCustomerAccountValue	complexType	Extension of CustomerAccountValue Contains the metaSolvCustomerAccountKey element and a list of fields	CustomerManagementEntities.xsd
metaSolvCustomerAccountKey	element	MetaSolvCustomerAccountKey	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKey	complexType	Extension of CustomerAccountKey Contains a list of fields	CustomerManagementEntities.xsd

Table 4-8 describes the error messages for the operation.

Table 4-8 Error Messages for the Operation

Error Message	Cause	Resolution
No customer for account id	Customer account ID provided is not valid.	Populate the ID with a valid customer account ID.

importCustomerAccount Operation

This operation creates a new customer account or modifies an existing customer account.

The following are the request and response structures:

Request Structure: importCustomerAccount

Response Structure: importCustomerAccountResponse

importCustomerAccount

The importCustomerAccount element contains the input information for the operation. Each row in Table 4-9 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 4-9 Payload Information for the Request

Name	Defined As	Type Description	File Name
importCustomerAccount	element	updateCustomerAccountByValueRequest	CustomerAPI.wsdl
updateCustomerAccountByValueRequest	element	Contains the mcmmevalue element	CustomerManagementAPI.xsd
mcmmevalue	element	MetaSolvCustomerAccountValueChoice	CustomerManagementEntities.xsd
MetaSolvCustomerAccountValueChoice	complexType	Contains the metaSolvCustomerAccountValue element	CustomerManagementEntities.xsd
metaSolvCustomerAccountValue	element	MetaSolvCustomerAccountValue	CustomerManagementEntities.xsd
MetaSolvCustomerAccountValue	complexType	See Table 4-10	CustomerManagementEntities.xsd

Table 4-10 defines MetaSolvCustomerAccountValue.

Table 4-10 MetaSolvCustomerAccountValue Definition

Name	Defined As	Type Description	File Name
MetaSolvCustomerAccountValue	complexType	Extension of CustomerAccountValue Contains the metaSolvCustomerAccountKey element	CustomerManagementEntities.xsd
metaSolvCustomerAccountKey	element	MetaSolvCustomerAccountKey	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKey	complexType	Extension of CustomerAccountKey Contains a list of fields	CustomerManagementEntities.xsd
customerBillingAccount	element	CustomerBillingAccountType	CustomerManagementEntities.xsd
CustomerBillingAccountType	complexType	billingAccount	CustomerManagementData.xsd
billingAccount	element	BillingAccountType	CustomerManagementData.xsd
BillingAccountType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerAccountBillCycle	element	CustomerAccountBillCycleType	CustomerManagementData.xsd
CustomerAccountBillCycleType	complexType	Contains a list of fields	CustomerManagementData.xsd
autoPayments	element	AutoPaymentType	CustomerManagementData.xsd
AutoPaymentType	complexType	Contains a list of fields	CustomerManagementData.xsd
prepayments	element	PrePaymentType	CustomerManagementData.xsd
PrePaymentType	complexType	Contains a list of fields	CustomerManagementData.xsd
creditApps	element	CreditAppsType	CustomerManagementEntities.xsd
CreditAppsType	complexType	Contains the following: psrResCreditApplications psrOrgCreditApplications	CustomerManagementData.xsd
psrResCreditApplications	element	PsrResCreditApplicationType	CustomerManagementData.xsd
PsrResCreditApplicationType	complexType	Contains a list of fields	CustomerManagementData.xsd
psrOrgCreditApplications	element	PsrOrgCreditApplicationType	CustomerManagementData.xsd
PsrOrgCreditApplicationType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerSicCode	element	CustomerSicCodeType	CustomerManagementEntities.xsd
CustomerSicCodeType	complexType	sicCode	CustomerManagementData.xsd
sicCode	element	SicCodeType	CustomerManagementData.xsd
SicCodeType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerServiceCategory	element	CustomerServiceCategoryType	CustomerManagementEntities.xsd
CustomerServiceCategoryType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerNotes	element	CustomerNoteType	CustomerManagementEntities.xsd
CustomerNoteType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerSalesModules	element	CustomerSalesModuleType	CustomerManagementEntities.xsd
CustomerSalesModuleType	complexType	Contains a list of fields	CustomerManagementData.xsd
salesPersons	element	SalesPersonType	CustomerManagementData.xsd
SalesPersonType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerContacts	element	CustomerContactType	CustomerManagementEntities.xsd
CustomerContactType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerSpecialHandlings	element	CustomerSpecialHandlingType	CustomerManagementEntities.xsd
CustomerSpecialHandlingType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerAddresses	element	CustomerAddressType	CustomerManagementEntities.xsd
CustomerAddressType	complexType	Contains a list of fields	CustomerManagementData.xsd
structureFormat	element	StructureFormatType	CustomerManagementData.xsd
StructureFormatType	complexType	Contains a list of fields	CustomerManagementData.xsd
structureFormatComponents	element	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd
Discounts	element	DiscountType	CustomerManagementEntities.xsd
DiscountType	complexType	Contains a list of fields	CustomerManagementData.xsd
Agreements	element	AgreementType	CustomerManagementEntities.xsd
AgreementType	complexType	Contains a list of fields	CustomerManagementData.xsd
taxExemptions	element	TaxExemptionType	CustomerManagementEntities.xsd
TaxExemptionType	complexType	Contains a list of fields	CustomerManagementData.xsd
internalAccounts	element	InternalAccountType	CustomerManagementEntities.xsd
InternalAccountType	complexType	Contains a list of fields	CustomerManagementData.xsd
metaSolvUserDataValue	element	metaSolvUserDataValue	CustomerManagementEntities.xsd
metaSolvUserDataValue	complexType	MetaSolvUserDataValueType	MIPCommonEntities.xsd
MetaSolvUserDataValueType	complexType	UserDataValueType	MIPCommonEntities.xsd
UserDataValueType	complexType	Contains a list of fields	MIPCommonEntities.xsd
BaseNameValueType	complexType	Contains a list of fields	MIPCommonEntities.xsd
metaSolvPartyRoleValue	element	metaSolvPartyRoleValue	CustomerManagementEntities.xsd
metaSolvPartyRoleValue	element	MetaSolvPartyRoleUpdateType	MIPCommonEntities.xsd
MetaSolvPartyRoleUpdateType	complexType	Contains a list of fields	MIPCommonEntities.xsd
PartyRoleType	complexType	Contains a list of fields	MIPCommonEntities.xsd

Required Fields for the importCustomerAccount Request Operation

The following tables describe the required fields for the importCustomerAccount request operation. The following are required for the operation:

metaSolvCustomerAccountValue
BillingAccountType
CustomerAccountBillCycleType

The remaining tables and fields are only required if that structure is included. For instance, the fields in AutoPaymentType are only required if the auto-payment option is provided.

Table 4-11 describes the required fields for metaSolvCustomerAccountValue.

Table 4-11 Required Fields for metaSolvCustomerAccountValue

Field Name	Data Type	Field Description
accessCustomerNr	integer	Industry standard code that identifies a PSR customer account as another carrier. Input a zero value if this is not applicable.
custAcctParentId	string	Return customer account parent ID.
accountStatus	Enum	Valid values of AccountStatusEnumType. Identifies the current condition of the customer or billing account.
billingInterfaceCd	Enum	Valid values of BillingInterfaceEnumType. Indicates the status of this customer information in the billing system.
tradingName	string	Only required for a business service category.If a business customer, the full name of the customer or billing account.
accountType	Enum	Valid values of AccountTypeEnumType. Type of account you are establishing.
extractCreationDate	CbeDateTime	Extract creation date.
customerNr	string	User-defined number or the system default number. The system assigns a sequential number to each record. Users can override this default by populating this field.
givenName	string	Only required for a residential service category.First name of a customer.
startDate	CbeDateTime	Start Date.
familyName	string	Only required for a residential service category.Last name of a customer.
middleInitial	CharType	Middle initial of a customer.
familyGeneration	string	Suffix of a customers name.
formOfAddress	string	Form of address to be used with a customer.
priorityCd	string	Classification of the customer or billing account that indicates the way a particular customer will be handled for collection issues and problems.
suspendNonPay	string	Indicates the customer account has a non-sufficient funds situation.
endDate	CbeDateTime	Indicates the date of the non-sufficient funds event. This field must be non-null. It may have a zero date value.

Table 4-12 describes the required fields for BillingAccountType.

Table 4-12 Required Fields for BillingAccountType

Field Name	Data Type	Field Description
autoPayInd	string	Indicates whether this account will pay its bills automatically (through credit card or bank draft).
billFormatCd	string	Billing format, or template used for invoices sent to this billing account.
billInArrearsInd	string	Indicates that you will bill this customer in arrears.
billingCapAmt	float	Billing cap amount.
creditClass	string	Description of the credit grouping for a customer.
currencyId	integer	Type of currency used in conducting business with this customer.
estUsage	float	Currency amount of the total estimated usage for this billing account.
languageCd	string	Language used in conducting business with this customer.
nsfEffDate	CbeDateTime	If the NSF check box is checked, the date that the customer payment was returned.
nsfInd	string	Indicates whether the billing account is in a non-sufficient funds situation.
supersedureFormInd	string	Indicates whether an Agreement of Change of Responsibility form is on file for the customer.

Table 4-13 describes the required fields for CustomerAccountBillCycleType.

Table 4-13 Required Fields for CustomerAccountBillCycleType

Field Name	Data Type	Field Description
billCycle	string	Indicator of how often (bill frequency) and when (billing period) the customer will receive a bill.
billCycleSeq	string	Sequence for the bill cycle.
startDate	CbeDateTime	Start date of bill cycle.
endDate	CbeDateTime	End date of bill cycle.
billPeriod	string	Two-digit code used for determining the bill cycle. The billing period is used to automatically create the last two characters of the bill cycle number.
billFreqCd	Enum	Valid values of BillingFrequencyEnumType. Cyclical billing frequency for the selected bill cycle.

Table 4-14 describes the required fields for AutoPaymentType.

Table 4-14 Required Fields for AutoPaymentType

Field Name	Data Type	Field Description
autoPaySeq	string	Auto payment sequence.
bankAcctNr	string	Account number from which funds will be drafted.
bankETN	string	Electronic transfer number of the bank holding the customer's account.
bankName	string	Name of the bank that issued the credit card or that holds the bank account.
ccExpDate	CbeDateTime	Month, day, and year that the credit card expires.
ccNr	string	Credit card number for the billing account.
ccNrSuf	string	Credit card number suffix for the billing account.
startDate	CbeDateTime	Start date for auto payment.
nameOnAcct	string	Name of the customer, as it appears on its credit card or bank account.
paymentTypeCd	string	Method that the customer will use to pay its invoices automatically.
primaryInd	string	Indicates whether this payment method is the customer's first choice. This is only required when the AutoPayment parent tag is provided. This field is only applicable when the customer supplies more than one Payment Method.

Table 4-15 describes the required fields for PrePaymentType.

Table 4-15 Required Fields for PrePaymentType

Field Name	Data Type	Field Description
currencyId	integer	Type of currency used in conducting business with this customer.
documentNumber	integer	Order number.
prepayID	integer	Pre payment ID.
subAcctInd	string	Sub Account Indicator.
Amount	float	Amount of the required prepayment, deposit, or interest.
amtRequested	float	Requested amount.
interestAmt	float	Corresponding interest amount.
amtValueType	string	Measurement that describes the entry in the Payment Amount field.
paymentMethod	string	Method that the customer will use to make the payment.
paymentType	string	Type of required payment that the customer is making.
prepaySeq	string	Sequence for pre payment.
dtRequested	CbeDateTime	Date that the customer was requested to make the required payment.
dtReturned	CbeDateTime	Only applicable for deposits. Date that the deposit was returned to the customer. This field must be non-null. It may have a zero date value.
paymentDt	CbeDateTime	Date that the customer made the required payment.

Table 4-16 describes the required fields for PsrOrgCreditApplicationType

Table 4-16 Required Fields for PsrOrgCreditApplicationType

Field Name	Data Type	Field Description
bankruptInd	string	Indicates whether this company has ever been through bankruptcy proceedings.
tradingName	string	Full company name of the business customer.
companyType	Enum	Valid values of CompanyTypeEnumType. The legal entity under which the company was formed.
dtOrgFormed	string	Date that the business was formed.
fedIdNr	string	Federal identification number assigned to the company.
nbrYrsInBusiness	string	Number of years that the company has been in business.
registrationDate	CbeDateTime	Date that the organization was legally registered or incorporated.
registrationStCd	string	State in which the organization was registered.
baseApp	Enum	Valid values of BaseAppType.

Table 4-17 describes the required fields for PsrResCreditApplicationType

Table 4-17 Required Fields for PsrResCreditApplicationType

Field Name	Data Type	Field Description
coApplicantNm	string	Full name of the customer's spouse or other co-applicant.
coApplicantSSN	string	Social security number of the customer's co-applicant.
employerAddress	string	Address of the customer's employer.
employerNm	string	Name of the customer's employer.
givenName	string	First name of the customer.
houseHoldIncome	float	Total income, in dollars, of the customer and his/her spouse, if applicable.
familyName	string	Last name of the customer.
middleInitial	CharType	Middle initial of the customer.
familyGeneration	string	Suffix of the customer name, such as Jr.
formOfAddress	string	Form of address to be used with the customer.
nrOfDependents	string	Number of people, other than the customer, that are currently dependent on the household income.
ownerOfHomeInd	string	Indicates whether the customer owns his or her own home.
Ssn	string	Social security number assigned to the customer.
baseApp	Enum	Valid values of baseApp.

Table 4-18 describes the required fields for SicCodeType.

Table 4-18 Required Fields for SicCodeType

Field Name	Data Type	Field Description
sicCd	string	Standard Industry Classification (SIC) code that is used to categorize customer listings for telephone directory publishing purposes.
stdCdInd	string	Indicates whether it is an standard industry code.
subAccountInd	string	Sub Account indicator.

Table 4-19 describes the required fields for CustomerServiceCategoryType.

Table 4-19 Required Fields for CustomerServiceCategoryType

Field Name	Data Type	Field Description
catgKey	integer	Category Key.
catgName	string	Category of service that you offer to customers. Service categories are tied to both customer records and products in the product catalog.
catgType	Enum	Valid values of CategoryTypeEnumType. A broad classification of the types of customers to whom you offer service.

Table 4-20 describes the required fields for CustomerNoteType.

Table 4-20 Required Fields for CustomerNoteType

Field Name	Data Type	Field Description
noteKey	integer	Note key value.
noteText	string	Additional information about the customer.
userId	string	User ID of the person entering the note.

Table 4-21 describes the required fields for CustomerSalesModuleType.

Table 4-21 Required Fields for CustomerSalesModuleType

Field Name	Data Type	Field Description
houseAccountInd	string	Indicates this sales module does not have commissions associated with it.
roleType	string	Identifies the role a sales module can play, such as salesperson or customer care representative.
salesModuleKey	string	Sales module key.
endDate	CbeDateTime	End date.

Table 4-22 describes the required fields for SalesPersonType.

Table 4-22 Required Fields for SalesPersonType

Field Name	Data Type	Field Description
tradingName	string	Name of the company for whom the salesperson works.
emailAddress	string	Email address of the salesperson.
givenName	string	Name of the salesperson.
familyName	string	Last name of the salesperson.
mgrName	string	Name of the salesperson's manager.
salesPersonKey	integer	Sales person key value.
Ssn	string	Social security number of the salesperson.
telephoneNr	string	Telephone number of the salesperson.

Table 4-23 describes the required fields for CustomerContactType.

Table 4-23 Required Fields for CustomerContactType

Field Name	Data Type	Field Description
contactSeq	string	Contact sequence.
contactType	string	Description of this contact's role. This is used to determine who to call for different situations and needs.
givenName	string	First name of the contact.
familyName	string	Last name of the contact.
startDate	CbeDateTime	Start date.
sendToBillingInd	string	Indicates whether this contact information will be fed to the billing system.
telephoneNr	string	Telephone number of the contact.
endDate	CbeDateTime	End date.
gaInstanceKeyCity	integer	City in which the contact is located.
gaInstanceKeyState	integer	State or province in which the contact is located.
gaInstanceKeyCountry	integer	Country in which the contact is located.

Table 4-24 describes the required fields for CustomerSpecialHandlingType.

Table 4-24 Required Fields for CustomerSpecialHandlingType

Field Name	Data Type	Field Description
startDate	CbeDateTime	Creation Date of record.
label	string	Type of customer for whom a special handling code is appropriate.
requiredInd	string	Indicates the special handling code is required for the selected customer account type.
specialHandlingCd	string	Code used to identify customer or billing accounts as requiring special treatment or special handling of invoices and disconnect notices.
specialHandlingSeq	string	Special handling sequence value.
systemDefaultCd	string	Indicates whether a value is the default value for a handling code.
endDate	CbeDateTime	Deletion date of record.
Value	string	Different options associated with the handling code.
valueCd	string	Code associated with each value type.

Table 4-25 describes the required fields for CustomerAddressType.

Table 4-25 Required Fields for CustomerAddressType

Field Name	Data Type	Field Description
tradingName	string	If a business customer, the full name of the customer or billing account.
customerAddressKey	integer	Customer address key value.
dispatchMethodCd	string	Media that is used to bill the customer, such as paper or electronic mail.
givenName	string	First name of a residential customer or the contact for a business customer.
familyName	string	Last name of a residential customer or the contact for a business customer.
Function	enum	Valid values of AddressFunctionEnumType. The function of an address for a customer, such as primary or secondary billing address.
secondaryBillName	string	Name of a department or group that further identifies the customer being billed.
sendToBillingInd	string	Send to Billing indicator value.
generalDelInd	string	Indicates if the customer wants mail sent general delivery by the post office.
incorporatedCd	Enum	Valid values of CityIncorporatedCdEnumType. Identifies whether an area code is inside the incorporated area of that city.
disconnectInd	boolean	Disconnect indicator.

Table 4-26 describes the required fields for StructureFormatType.

Table 4-26 Required Fields for StructureFormatType

Field Name	Data Type	Field Description
sfType	string	Category that describes a structure.
name	string	Name of a specific customization of a structured format type.

Table 4-27 describes the required fields for StructureFormatComponentType.

Table 4-27 Required Fields for StructureFormatComponentType

Field Name	Data Type	Field Description
Id	int	ID of a component of a structured format.
name	string	Name of a component of a structured format.
componentType	string	Type of component, such as table-driven drop-down or valid value drop-down.
Value	string	Name of a value for a component.

Table 4-28 describes the required fields for DiscountType.

Table 4-28 Required Fields for DiscountType

Field Name	Data Type	Field Description
agrmntID	integer	Agreement ID.
discountType	string	Type of discount offered to the customer, either percent or fixed amount.
agrmntNbr	string	Agreement number.
agrmntType	string	Agreement Type.
discountMinUom	string	Discount minimum value.
discountRole	string	Role of discount.
discountSeq	string	Sequence for discount.
periodValueUom	string	Period value UOM.
agrmntDt	CbeDateTime	Date of agreement.
toEffDt	CbeDateTime	Date the discount ceases to be in effect. This field must be non-null. It may have a zero date value.
fromEffDt	CbeDateTime	Date the discount is effective.

Table 4-29 describes the required fields for AgreementType.

Table 4-29 Required Fields for AgreementType

Field Name	Data Type	Field Description
agrmntNbr	string	Number printed on the signed agreement.
agrmntType	string	Type of agreement associated with the customer.
nmOnAgrmnt	string	Name of the customer contact providing the agreement.
fromEffDt	CbeDateTime	First date on which the agreement is effective.
toEffDt	CbeDateTime	Last date on which the agreement is effective. This field must be non-null. It may have a zero date value.

Table 4-30 describes the required fields for TaxExemptionType.

Table 4-30 Required Fields for TaxExemptionType

Field Name	Data Type	Field Description
certificateNbr	string	Number of the customer's tax exemption certificate.
Description	string	Description of the tax exemption.
taxExemptSeq	string	Sequence value for tax exemption.
taxExemptType	string	Short name or identifier for a type of tax exemption.
fromEffDt	CbeDateTime	Date that the tax exemption is effective.
toEffDt	CbeDateTime	Date on which the tax exemption ceases to be in effect. This field must be non-null. It may have a zero date value.

Table 4-31 describes the required fields for InternalAccountType.

Table 4-31 Required Fields for InternalAccountType

Field Name	Data Type	Field Description
internalAcctID	integer	Internal account ID value.
internalAcctNbr	string	Internal Account Number.
companyNm	string	Name of a group or department within the customer account or billing account.
fromEffDt	CbeDateTime	Start date.
toEffDt	CbeDateTime	End date.
accountStatus	Enum	Valid values of AccountStatusEnumType.
billingInterfaceCd	Enum	Valid values of BillingInterfaceEnumType.

Table 4-32 describes the required fields for UserDataValueType.

Table 4-32 Required Fields for UserDataValueType

Field Name	Data Type	Field Description
tableNm	string	ASAP table where the user data will be stored. This table corresponds to where the user data was originally defined.
keyColumnNm	string	Actual primary key column name of the product area. This is required so the user data row can be associated with one item.
keyValue	integer	Actual value of the product area.

Table 4-33 describes the required fields for BaseNameValueType.

Table 4-33 Required Fields for BaseNameValueType

Field Name	Data Type	Field Description
column	string	Field is the user data column that will be updated.
value	string	Value entered into the defined column.
dataType	string	Function of a user data field. Determines the kind of information a user can enter in a field on the User Data window. Valid Values: Number, Decimal, VARCHAR2, Date, Dropdown.

Table 4-34 describes the required fields for MetaSolvPartyRoleUpdateType.

Table 4-34 Required Fields for MetaSolvPartyRoleUpdateType

Field Name	Data Type	Field Description
actionCd	string	Code for the action to be taken for the party role.

Table 4-35 describes the required fields for PartyRoleType.

Table 4-35 Required Fields for PartyRoleType

Field Name	Data Type	Field Description
partyId	integer	Party id value of the party role of the level 1 service item. This field along with the partyRoleSeq defines the service provider.
partyRoleSeq	integer	Party role sequence value of the level 1 service item. This field along with the partyId defines the service provider.

importCustomerAccountResponse

The importCustomerAccountResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 4-36 describes the returned information in the response.

Table 4-36 Payload Information for the Response

Name	Defined As	Type Description	File Name
importCustomerAccountResponse	element	updateCustomerAccountByValueResponse	CustomerAPI.wsdl
updateCustomerAccountByValueResponse	complexType	Complex Type with element mcmmekey	CustomerManagementAPI.xsd
mcmmekey	element	MetaSolvCustomerAccountKeyChoice	CustomerManagementEntities.xsd
MetaSolvCustomerAccountKeyChoice	complexType	Complex Type with element metasolv-cmme:metaSolvCustomerAccountKey	CustomerManagementEntities.xsd
metaSolvCustomerAccountKey	complexType	Complex Type with a list of elements	CustomerManagementEntities.xsd

Table 4-37 describes the error messages for the operation.

Table 4-37 Error Messages for the Operation

Error Message	Cause	Resolution
Record Exists: PSRCustomerAccount.custAcctID=.	A customer account ID exists with the same account number already exists.	Populate the account number which is not used.
Missing Data: PSRCustomerAccount.companyNm.	The company name is missing in the input.	Populate the company name in the input structure.