element request
diagram index_p2.png
namespace http://www.ibillingclient.org/schema/edi
properties
content complex
children findCustomerAccount findPaymentOption findPaymentPlan findAccountTransaction customerAccount
attributes
Name  Type  Use  Default  Fixed  annotation
merchantAccountCodeMerchantAccountCoderequired      
documentation
Intrannuity assigned Merchant Code (value divisible by 1000)
passwordxs:stringrequired      
documentation
Password assigned to the merchant's account
annotation
documentation
Root element for client requests
source <xs:element name="request">
 
<xs:annotation>
   
<xs:documentation>Root element for client requests</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:choice>
     
<xs:element name="findCustomerAccount" type="QueryCustomerAccount">
       
<xs:annotation>
         
<xs:documentation>Represents request for search of CustomerAccounts</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="findPaymentOption" type="QueryPaymentOption">
       
<xs:annotation>
         
<xs:documentation>Represents request for search of PaymentOptions</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="findPaymentPlan" type="QueryPaymentOption">
       
<xs:annotation>
         
<xs:documentation>Represents request for search of PaymentPlans</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="findAccountTransaction" type="QueryAccountTransaction">
       
<xs:annotation>
         
<xs:documentation>Represents request for search of AccountTransactions (Asset or Revenue)</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="customerAccount" type="CustomerAccount">
       
<xs:annotation>
         
<xs:documentation>Presence of this element implies save operation (of the defined CustomerAccount)</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:choice>
   
<xs:attribute name="merchantAccountCode" type="MerchantAccountCode" use="required">
     
<xs:annotation>
       
<xs:documentation>Intrannuity assigned Merchant Code (value divisible by 1000)</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="password" type="xs:string" use="required">
     
<xs:annotation>
       
<xs:documentation>Password assigned to the merchant's account</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute request/@merchantAccountCode
type MerchantAccountCode
properties
isRef 0
use required
annotation
documentation
Intrannuity assigned Merchant Code (value divisible by 1000)
source <xs:attribute name="merchantAccountCode" type="MerchantAccountCode" use="required">
 
<xs:annotation>
   
<xs:documentation>Intrannuity assigned Merchant Code (value divisible by 1000)</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute request/@password
type xs:string
properties
isRef 0
use required
annotation
documentation
Password assigned to the merchant's account
source <xs:attribute name="password" type="xs:string" use="required">
 
<xs:annotation>
   
<xs:documentation>Password assigned to the merchant's account</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element request/findCustomerAccount
diagram index_p3.png
namespace http://www.ibillingclient.org/schema/edi
type QueryCustomerAccount
properties
isRef 0
content complex
attributes
Name  Type  Use  Default  Fixed  annotation
merchantAccountCodeMerchantAccountCodeoptional      
codexs:stringoptional      
firstNamexs:stringoptional      
lastNamexs:stringoptional      
middleNamexs:stringoptional      
titlexs:stringoptional      
suffixxs:stringoptional      
isActivexs:booleanoptional      
fromCreateDateDateoptional      
toCreateDateDateoptional      
phonexs:stringoptional      
emailxs:stringoptional      
zipCodexs:stringoptional      
creditCardNumberxs:stringoptional      
bankAccountNumberxs:stringoptional      
fromBalancexs:intoptional      
toBalancexs:intoptional      
customerAccountGroupCodexs:stringoptional      
annotation
documentation
Represents request for search of CustomerAccounts
source <xs:element name="findCustomerAccount" type="QueryCustomerAccount">
 
<xs:annotation>
   
<xs:documentation>Represents request for search of CustomerAccounts</xs:documentation>
 
</xs:annotation>
</xs:element>

element request/findPaymentOption
diagram index_p4.png
namespace http://www.ibillingclient.org/schema/edi
type QueryPaymentOption
properties
isRef 0
content complex
attributes
Name  Type  Use  Default  Fixed  annotation
merchantAccountCodeMerchantAccountCodeoptional      
codexs:stringoptional      
isActivexs:booleanoptional      
fromCreateDateDateoptional      
toCreateDateDateoptional      
holderNamexs:stringoptional      
numberxs:stringoptional      
accessoryxs:stringoptional      
cityxs:stringoptional      
statexs:stringoptional      
zipCodexs:stringoptional      
paymentOptionTypePaymentOptionTypeoptional      
customerAccountCodexs:stringoptional      
street1xs:stringoptional      
street2xs:stringoptional      
annotation
documentation
Represents request for search of PaymentOptions
source <xs:element name="findPaymentOption" type="QueryPaymentOption">
 
<xs:annotation>
   
<xs:documentation>Represents request for search of PaymentOptions</xs:documentation>
 
</xs:annotation>
</xs:element>

element request/findPaymentPlan
diagram index_p5.png
namespace http://www.ibillingclient.org/schema/edi
type QueryPaymentOption
properties
isRef 0
content complex
attributes
Name  Type  Use  Default  Fixed  annotation
merchantAccountCodeMerchantAccountCodeoptional      
codexs:stringoptional      
isActivexs:booleanoptional      
fromCreateDateDateoptional      
toCreateDateDateoptional      
holderNamexs:stringoptional      
numberxs:stringoptional      
accessoryxs:stringoptional      
cityxs:stringoptional      
statexs:stringoptional      
zipCodexs:stringoptional      
paymentOptionTypePaymentOptionTypeoptional      
customerAccountCodexs:stringoptional      
street1xs:stringoptional      
street2xs:stringoptional      
annotation
documentation
Represents request for search of PaymentPlans
source <xs:element name="findPaymentPlan" type="QueryPaymentOption">
 
<xs:annotation>
   
<xs:documentation>Represents request for search of PaymentPlans</xs:documentation>
 
</xs:annotation>
</xs:element>

element request/findAccountTransaction
diagram index_p6.png
namespace http://www.ibillingclient.org/schema/edi
type QueryAccountTransaction
properties
isRef 0
content complex
attributes
Name  Type  Use  Default  Fixed  annotation
merchantAccountCodeMerchantAccountCodeoptional      
codexs:stringoptional      
accountActivityTypeAccountActivityTypeoptional      
fromCreateDateDateoptional      
toCreateDateDateoptional      
customerAccountCodexs:stringoptional      
customerAccountNamexs:stringoptional      
isActiveCustomerAccountxs:booleanoptional      
itemCodexs:stringoptional      
accountNumberxs:stringoptional      
fromAmountxs:intoptional      
toAmountxs:intoptional      
fromBalancexs:intoptional      
toBalancexs:intoptional      
annotation
documentation
Represents request for search of AccountTransactions (Asset or Revenue)
source <xs:element name="findAccountTransaction" type="QueryAccountTransaction">
 
<xs:annotation>
   
<xs:documentation>Represents request for search of AccountTransactions (Asset or Revenue)</xs:documentation>
 
</xs:annotation>
</xs:element>

element request/customerAccount
diagram index_p7.png
namespace http://www.ibillingclient.org/schema/edi
type CustomerAccount
properties
isRef 0
content complex
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
Presence of this element implies save operation (of the defined CustomerAccount)
source <xs:element name="customerAccount" type="CustomerAccount">
 
<xs:annotation>
   
<xs:documentation>Presence of this element implies save operation (of the defined CustomerAccount)</xs:documentation>
 
</xs:annotation>
</xs:element>


XML Schema documentation generated by
XMLSpy Schema Editor http://www.altova.com/xmlspy