complexType CustomerAccount
diagram index_p22.png
namespace http://www.ibillingclient.org/schema/edi
type extension of ClientObject
properties
base ClientObject
used by
elements response/customerAccount request/customerAccount
attributes
Name  Type  Use  Default  Fixed  annotation
idxs:IDrequired      
documentation
id: System generated identifier.
createDateDateoptional      
documentation
createDate: Date the transaction was created.
codexs:stringrequired      
documentation
code: User assigned identifier. (if not specified, id is used)
merchantAccountCodeMerchantAccountCoderequired      
documentation
merchantAccountCode: Merchant account code.
firstNamexs:stringoptional      
documentation
firstName: If person - first name, not used otherwise.
lastNamexs:stringoptional      
documentation
lastName: If person - last name, if organization - organization's name.
middleNamexs:stringoptional      
documentation
middleName: If person - middle name, not used otherwise.
titlexs:stringoptional      
documentation
title: If person - title, not used otherwise.
suffixxs:stringoptional      
documentation
suffix: If person - suffix, not used otherwise.
typexs:stringoptional      
documentation
type: Type of the account.
isActivexs:booleanoptional      
documentation
isActive: If false, account has no active payment option or payment plans.
homePhonexs:stringoptional      
documentation
homePhone: Home phone number.
workPhonexs:stringoptional      
documentation
workPhone: Work phone number/contact number if organization.
cellPhonexs:stringoptional      
documentation
cellPhone: Cell phone number.
emailxs:stringoptional      
documentation
email: Contact e-mail.
street1xs:stringoptional      
documentation
street1: Street1 of the address.
street2xs:stringoptional      
documentation
street2: Street2 of the address.
cityxs:stringoptional      
documentation
city: City of the address.
statexs:stringoptional      
documentation
state: State of the address.
zipCodexs:stringoptional      
documentation
zipCode: Zip code of the address.
balancexs:intoptional      
documentation
balance: Current balance on the account.
beneficiaryInfoxs:stringoptional      
documentation
beneficiaryInfo: Buyer's information (if somebody else is responsible for payments).Contains full name and contact info
customerAccountGroupCodexs:stringoptional      
documentation
customerAccountGroupCode: Predefined classification code for this account (to simplifysearching/reporting).
isVerifiedxs:booleanoptional      
documentation
isVerified: Not Used. Reserved for future use.
notesxs:stringoptional      
documentation
notes: Any notes associated with the account.
lastUpdateDateDateoptional      
documentation
lastUpdateDate: Last time the account was updated.
birthDateDateoptional      
documentation
birthDate: If person - date of birth, not used otherwise.
annotation
documentation
Represents a party (person or organization) making/responsible for invoicing,payments, plans in the system.
source <xs:complexType name="CustomerAccount">
 
<xs:annotation>
   
<xs:documentation>Represents a party (person or organization) making/responsible for invoicing,payments, plans in the system.</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ClientObject">
     
<xs:attribute name="firstName" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>firstName: If person - first name, not used otherwise.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="lastName" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>lastName: If person - last name, if organization - organization's name.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="middleName" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>middleName: If person - middle name, not used otherwise.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="title" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>title: If person - title, not used otherwise.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="suffix" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>suffix: If person - suffix, not used otherwise.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="type" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>type: Type of the account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="isActive" type="xs:boolean" use="optional">
       
<xs:annotation>
         
<xs:documentation>isActive: If false, account has no active payment option or payment plans.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="homePhone" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>homePhone: Home phone number.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="workPhone" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>workPhone: Work phone number/contact number if organization.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="cellPhone" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>cellPhone: Cell phone number.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="email" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>email: Contact e-mail.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="street1" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>street1: Street1 of the address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="street2" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>street2: Street2 of the address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="city" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>city: City of the address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="state" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>state: State of the address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="zipCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>zipCode: Zip code of the address.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="balance" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>balance: Current balance on the account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="beneficiaryInfo" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>beneficiaryInfo: Buyer's information (if somebody else is responsible for payments).Contains full name and contact info</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="customerAccountGroupCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>customerAccountGroupCode: Predefined classification code for this account (to simplifysearching/reporting).</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="isVerified" type="xs:boolean" use="optional">
       
<xs:annotation>
         
<xs:documentation>isVerified: Not Used. Reserved for future use.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="notes" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>notes: Any notes associated with the account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="lastUpdateDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>lastUpdateDate: Last time the account was updated.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="birthDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>birthDate: If person - date of birth, not used otherwise.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute CustomerAccount/@firstName
type xs:string
properties
isRef 0
use optional
annotation
documentation
firstName: If person - first name, not used otherwise.
source <xs:attribute name="firstName" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>firstName: If person - first name, not used otherwise.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@lastName
type xs:string
properties
isRef 0
use optional
annotation
documentation
lastName: If person - last name, if organization - organization's name.
source <xs:attribute name="lastName" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>lastName: If person - last name, if organization - organization's name.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@middleName
type xs:string
properties
isRef 0
use optional
annotation
documentation
middleName: If person - middle name, not used otherwise.
source <xs:attribute name="middleName" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>middleName: If person - middle name, not used otherwise.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@title
type xs:string
properties
isRef 0
use optional
annotation
documentation
title: If person - title, not used otherwise.
source <xs:attribute name="title" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>title: If person - title, not used otherwise.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@suffix
type xs:string
properties
isRef 0
use optional
annotation
documentation
suffix: If person - suffix, not used otherwise.
source <xs:attribute name="suffix" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>suffix: If person - suffix, not used otherwise.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@type
type xs:string
properties
isRef 0
use optional
annotation
documentation
type: Type of the account.
source <xs:attribute name="type" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>type: Type of the account.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@isActive
type xs:boolean
properties
isRef 0
use optional
annotation
documentation
isActive: If false, account has no active payment option or payment plans.
source <xs:attribute name="isActive" type="xs:boolean" use="optional">
 
<xs:annotation>
   
<xs:documentation>isActive: If false, account has no active payment option or payment plans.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@homePhone
type xs:string
properties
isRef 0
use optional
annotation
documentation
homePhone: Home phone number.
source <xs:attribute name="homePhone" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>homePhone: Home phone number.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@workPhone
type xs:string
properties
isRef 0
use optional
annotation
documentation
workPhone: Work phone number/contact number if organization.
source <xs:attribute name="workPhone" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>workPhone: Work phone number/contact number if organization.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@cellPhone
type xs:string
properties
isRef 0
use optional
annotation
documentation
cellPhone: Cell phone number.
source <xs:attribute name="cellPhone" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>cellPhone: Cell phone number.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@email
type xs:string
properties
isRef 0
use optional
annotation
documentation
email: Contact e-mail.
source <xs:attribute name="email" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>email: Contact e-mail.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@street1
type xs:string
properties
isRef 0
use optional
annotation
documentation
street1: Street1 of the address.
source <xs:attribute name="street1" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>street1: Street1 of the address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@street2
type xs:string
properties
isRef 0
use optional
annotation
documentation
street2: Street2 of the address.
source <xs:attribute name="street2" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>street2: Street2 of the address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@city
type xs:string
properties
isRef 0
use optional
annotation
documentation
city: City of the address.
source <xs:attribute name="city" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>city: City of the address.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute CustomerAccount/@state
type xs:string
properties
isRef 0
use optional
annotation
documentation
state: State of the address.
source <xs:attribute na