element response
diagram index_p8.png
namespace http://www.ibillingclient.org/schema/edi
properties
content complex
children customerAccount paymentOption paymentPlan assetTransaction revenueTransaction
annotation
documentation
Root element for server responses
source <xs:element name="response">
 
<xs:annotation>
   
<xs:documentation>Root element for server responses</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:choice minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>In case of find operations, if nothing is found, the response object will be empty</xs:documentation>
     
</xs:annotation>
     
<xs:element name="customerAccount" type="CustomerAccount" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>In case of save operation, represents the server representation of the persisted object. In case of find request, represents (multiple occurences possible) all objects that matched the criteria</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="paymentOption" type="PaymentOption" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="paymentPlan" type="PaymentPlan" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:choice maxOccurs="unbounded">
       
<xs:element name="assetTransaction" type="AssetTransaction">
         
<xs:annotation>
           
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="revenueTransaction" type="RevenueTransaction">
         
<xs:annotation>
           
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:choice>
   
</xs:choice>
 
</xs:complexType>
</xs:element>

element response/customerAccount
diagram index_p9.png
namespace http://www.ibillingclient.org/schema/edi
type CustomerAccount
properties
isRef 0
minOcc 1
maxOcc unbounded
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
In case of save operation, represents the server representation of the persisted object. In case of find request, represents (multiple occurences possible) all objects that matched the criteria
source <xs:element name="customerAccount" type="CustomerAccount" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>In case of save operation, represents the server representation of the persisted object. In case of find request, represents (multiple occurences possible) all objects that matched the criteria</xs:documentation>
 
</xs:annotation>
</xs:element>

element response/paymentOption
diagram index_p10.png
namespace http://www.ibillingclient.org/schema/edi
type PaymentOption
properties
isRef 0
minOcc 1
maxOcc unbounded
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.
isActivexs:booleanoptional      
documentation
isActive: The is active.
holderNamexs:stringoptional      
documentation
holderName: The holder name.
numberxs:stringoptional      
documentation
number: The number.
accessoryxs:stringoptional      
documentation
accessory: The accessory.
street1xs:stringoptional      
documentation
street1: The street1.
street2xs:stringoptional      
documentation
street2: The street2.
cityxs:stringoptional      
documentation
city: The city.
statexs:stringoptional      
documentation
state: The state.
zipCodexs:stringoptional      
documentation
zipCode: The zip code.
typexs:stringoptional      
documentation
type: The type.
lastUpdateDateDateoptional      
documentation
lastUpdateDate: The last update date.
issuexs:stringoptional      
documentation
issue: The issue.
cvv2xs:stringoptional      
documentation
cvv2: The cvv2.
maskedNumberxs:stringoptional      
documentation
maskedNumber: The masked number.
maskedAccessoryxs:stringoptional      
documentation
maskedAccessory: The masked accessory.
customerAccountxs:IDREFoptional      
documentation
customerAccount: The customer account.
annotation
documentation
Represents (multiple occurences possible) all objects that matched the search criteria
source <xs:element name="paymentOption" type="PaymentOption" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
 
</xs:annotation>
</xs:element>

element response/paymentPlan
diagram index_p11.png
namespace http://www.ibillingclient.org/schema/edi
type PaymentPlan
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children adjustment charge
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.
lastInvocingDateDateoptional      
documentation
lastInvocingDate: The last invocing date.
lastProcessingDateDateoptional      
documentation
lastProcessingDate: The last processing date.
sellerCodexs:stringoptional      
documentation
sellerCode: The seller code.
lengthxs:intoptional      
documentation
length: The length.
valuexs:intoptional      
documentation
value: The value.
deferredLengthxs:intoptional      
documentation
deferredLength: The deferred length.
deferredValuexs:intoptional      
documentation
deferredValue: The deferred value.
amountxs:intoptional      
documentation
amount: The amount.
groupCode1xs:stringoptional      
documentation
groupCode1: The group code1.
groupCode2xs:stringoptional      
documentation
groupCode2: The group code2.
groupCode3xs:stringoptional      
documentation
groupCode3: The group code3.
groupCode4xs:stringoptional      
documentation
groupCode4: The group code4.
groupCode5xs:stringoptional      
documentation
groupCode5: The group code5.
groupCode6xs:stringoptional      
documentation
groupCode6: The group code6.
groupCode7xs:stringoptional      
documentation
groupCode7: The group code7.
groupCode8xs:stringoptional      
documentation
groupCode8: The group code8.
typexs:stringoptional      
documentation
type: The type.
firstBillingDateDateoptional      
documentation
firstBillingDate: The first billing date.
nextBillingDateDateoptional      
documentation
nextBillingDate: The next billing date.
billingCycleCodexs:stringoptional      
documentation
billingCycleCode: The billing cycle code.
itemCodexs:stringoptional      
documentation
itemCode: The item code.
taxCodexs:stringoptional      
documentation
taxCode: The tax code.
lastUpdateDateDateoptional      
documentation
lastUpdateDate: The last update date.
statusxs:stringoptional      
documentation
status: The status.
linkAccountxs:intoptional      
documentation
linkAccount: The link account.
paymentOptionxs:IDREFoptional      
documentation
paymentOption: The payment option.
customerAccountxs:IDREFoptional      
documentation
customerAccount: The customer account.
linkParentPlanxs:IDREFoptional      
documentation
linkParentPlan: The link parent plan.
annotation
documentation
Represents (multiple occurences possible) all objects that matched the search criteria
source <xs:element name="paymentPlan" type="PaymentPlan" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Represents (multiple occurences possible) all objects that matched the search criteria</xs:documentation>
 
</xs:annotation>
</xs:element>

element response/assetTransaction
diagram index_p12.png