element response

diagram
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
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 id xs:ID required         documentation id: System generated identifier. createDate Date optional         documentation createDate: Date the transaction was created. code xs:string required         documentation code: User assigned identifier. (if not specified, id is used) merchantAccountCode MerchantAccountCode required         documentation merchantAccountCode: Merchant account code. firstName xs:string optional         documentation firstName: If person - first name, not used otherwise. lastName xs:string optional         documentation lastName: If person - last name, if organization - organization's name. middleName xs:string optional         documentation middleName: If person - middle name, not used otherwise. title xs:string optional         documentation title: If person - title, not used otherwise. suffix xs:string optional         documentation suffix: If person - suffix, not used otherwise. type xs:string optional         documentation type: Type of the account. isActive xs:boolean optional         documentation isActive: If false, account has no active payment option or payment plans. homePhone xs:string optional         documentation homePhone: Home phone number. workPhone xs:string optional         documentation workPhone: Work phone number/contact number if organization. cellPhone xs:string optional         documentation cellPhone: Cell phone number. email xs:string optional         documentation email: Contact e-mail. street1 xs:string optional         documentation street1: Street1 of the address. street2 xs:string optional         documentation street2: Street2 of the address. city xs:string optional         documentation city: City of the address. state xs:string optional         documentation state: State of the address. zipCode xs:string optional         documentation zipCode: Zip code of the address. balance xs:int optional         documentation balance: Current balance on the account. beneficiaryInfo xs:string optional         documentation beneficiaryInfo: Buyer's information (if somebody else is responsible for payments).Contains full name and contact info customerAccountGroupCode xs:string optional         documentation customerAccountGroupCode: Predefined classification code for this account (to simplifysearching/reporting). isVerified xs:boolean optional         documentation isVerified: Not Used. Reserved for future use. notes xs:string optional         documentation notes: Any notes associated with the account. lastUpdateDate Date optional         documentation lastUpdateDate: Last time the account was updated. birthDate Date optional         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
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 id xs:ID required         documentation id: System generated identifier. createDate Date optional         documentation createDate: Date the transaction was created. code xs:string required         documentation code: User assigned identifier. (if not specified, id is used) merchantAccountCode MerchantAccountCode required         documentation merchantAccountCode: Merchant account code. isActive xs:boolean optional         documentation isActive: The is active. holderName xs:string optional         documentation holderName: The holder name. number xs:string optional         documentation number: The number. accessory xs:string optional         documentation accessory: The accessory. street1 xs:string optional         documentation street1: The street1. street2 xs:string optional         documentation street2: The street2. city xs:string optional         documentation city: The city. state xs:string optional         documentation state: The state. zipCode xs:string optional         documentation zipCode: The zip code. type xs:string optional         documentation type: The type. lastUpdateDate Date optional         documentation lastUpdateDate: The last update date. issue xs:string optional         documentation issue: The issue. cvv2 xs:string optional         documentation cvv2: The cvv2. maskedNumber xs:string optional         documentation maskedNumber: The masked number. maskedAccessory xs:string optional         documentation maskedAccessory: The masked accessory. customerAccount xs:IDREF optional         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
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 id xs:ID required         documentation id: System generated identifier. createDate Date optional         documentation createDate: Date the transaction was created. code xs:string required         documentation code: User assigned identifier. (if not specified, id is used) merchantAccountCode MerchantAccountCode required         documentation merchantAccountCode: Merchant account code. lastInvocingDate Date optional         documentation lastInvocingDate: The last invocing date. lastProcessingDate Date optional         documentation lastProcessingDate: The last processing date. sellerCode xs:string optional         documentation sellerCode: The seller code. length xs:int optional         documentation length: The length. value xs:int optional         documentation value: The value. deferredLength xs:int optional         documentation deferredLength: The deferred length. deferredValue xs:int optional         documentation deferredValue: The deferred value. amount xs:int optional         documentation amount: The amount. groupCode1 xs:string optional         documentation groupCode1: The group code1. groupCode2 xs:string optional         documentation groupCode2: The group code2. groupCode3 xs:string optional         documentation groupCode3: The group code3. groupCode4 xs:string optional         documentation groupCode4: The group code4. groupCode5 xs:string optional         documentation groupCode5: The group code5. groupCode6 xs:string optional         documentation groupCode6: The group code6. groupCode7 xs:string optional         documentation groupCode7: The group code7. groupCode8 xs:string optional         documentation groupCode8: The group code8. type xs:string optional         documentation type: The type. firstBillingDate Date optional         documentation firstBillingDate: The first billing date. nextBillingDate Date optional         documentation nextBillingDate: The next billing date. billingCycleCode xs:string optional         documentation billingCycleCode: The billing cycle code. itemCode xs:string optional         documentation itemCode: The item code. taxCode xs:string optional         documentation taxCode: The tax code. lastUpdateDate Date optional         documentation lastUpdateDate: The last update date. status xs:string optional         documentation status: The status. linkAccount xs:int optional         documentation linkAccount: The link account. paymentOption xs:IDREF optional         documentation paymentOption: The payment option. customerAccount xs:IDREF optional         documentation customerAccount: The customer account. linkParentPlan xs:IDREF optional         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
namespace	http://www.ibillingclient.org/schema/edi
type	AssetTransaction
properties	isRef  0 content  complex
children	captureInfo
attributes	Name   Type   Use   Default   Fixed   annotation id xs:ID required         documentation id: System generated identifier. createDate Date optional         documentation createDate: Date the transaction was created. code xs:string required         documentation code: User assigned identifier. (if not specified, id is used) merchantAccountCode MerchantAccountCode required         documentation merchantAccountCode: Merchant account code. accountActivityType AccountActivityType optional         documentation accountActivityType: Type of activity, e.g. invoice, payment customerAccount xs:IDREF optional         documentation customerAccount: Reference to the CustomerAccount affected by this activity. amount xs:int optional         documentation amount: Initial (fixed) amount of the transaction. balance xs:int optional         documentation balance: Current balance of the transaction. note xs:string optional         documentation note: Optional text note (description). creatorCode xs:string optional         documentation creatorCode: Optional free-hand code, can be used to identify creator of thetransaction (usually in external client system). sellerCode xs:string optional         documentation sellerCode: Optional free-hand code, can be used to identify seller associated withthe transaction (usually in external client system). shiftCode xs:string optional         documentation shiftCode: Optional free-hand code, can be used to identify POS shift that generatedthis transaction (usually in external client system). terminalCode xs:string optional         documentation terminalCode: Optional free-hand code, can be used to identify POS terminal thatgenerated this transaction (usually in external client system). taxAmount xs:int optional         documentation taxAmount: Amount of the tax (part of amount). dueDate Date optional         documentation dueDate: Date when the transaction becomes effective (applied to CustomerAccount).Before the due date, iBilling's balancing process will not apply anybalance on the transaction adjustmentTransaction xs:IDREF optional         documentation adjustmentTransaction: Reference to a transaction that reversed this transaction. Normally,Invoice or Fee can be reversed with Reversal, Payment or Claim with Voidor Decline transactionType AssetTransactionType optional         documentation transactionType: Type of AssetTransaction, e.g. Cash, Visa, Checking isPrepayment xs:boolean optional         documentation isPrepayment: If true, this transaction was created as a prepayment against charge(future invoice). accountNumber xs:string optional         documentation accountNumber: For credit card related transactions - number on the card <br/> For bankaccount related transactions - number of the account<br/> For checkrelated transactions - check number<br/> Not used otherwise.<br/> accessory xs:string optional         documentation accessory: For credit card related transactions - expiration date - MMyy <br/> Forbank account related transactions - routing number <br/> Not usedotherwise.<br/> maskedAccountNumber xs:string optional         documentation maskedAccountNumber: For credit card related transactions - masked number on the card e.g.5******3452 <br/> For bank account related transactions - masked numberof the account e.g. C******4435<br/> For check related transactions -check number<br/> Not used otherwise.<br/> maskedAccessory xs:string optional         documentation maskedAccessory: For credit card related transactions - expiration date - MMyy <br/> Forbank account related transactions - masked routing number e.g. ***6675<br/>Not used otherwise.<br/> captureInfo xs:IDREF optional         documentation captureInfo: Reference to the object representing processing related info. Onlyavailable when transaction is of electronic type (credit card or ACH)
annotation	documentation Represents (multiple occurences possible) all objects that matched the search criteria
source	<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>

element response/revenueTransaction

diagram
namespace	http://www.ibillingclient.org/schema/edi
type	RevenueTransaction
properties	isRef  0 content  complex
attributes	Name   Type   Use   Default   Fixed   annotation id xs:ID required         documentation id: System generated identifier. createDate Date optional         documentation createDate: Date the transaction was created. code xs:string required         documentation code: User assigned identifier. (if not specified, id is used) merchantAccountCode MerchantAccountCode required         documentation merchantAccountCode: Merchant account code. accountActivityType AccountActivityType optional         documentation accountActivityType: Type of activity, e.g. invoice, payment customerAccount xs:IDREF optional         documentation customerAccount: Reference to the CustomerAccount affected by this activity. amount xs:int optional         documentation amount: Initial (fixed) amount of the transaction. balance xs:int optional         documentation balance: Current balance of the transaction. note xs:string optional         documentation note: Optional text note (description). creatorCode xs:string optional         documentation creatorCode: Optional free-hand code, can be used to identify creator of thetransaction (usually in external client system). sellerCode xs:string optional         documentation sellerCode: Optional free-hand code, can be used to identify seller associated withthe transaction (usually in external client system). shiftCode xs:string optional         documentation shiftCode: Optional free-hand code, can be used to identify POS shift that generatedthis transaction (usually in external client system). terminalCode xs:string optional         documentation terminalCode: Optional free-hand code, can be used to identify POS terminal thatgenerated this transaction (usually in external client system). taxAmount xs:int optional         documentation taxAmount: Amount of the tax (part of amount). dueDate Date optional         documentation dueDate: Date when the transaction becomes effective (applied to CustomerAccount).Before the due date, iBilling's balancing process will not apply anybalance on the transaction adjustmentTransaction xs:IDREF optional         documentation adjustmentTransaction: Reference to a transaction that reversed this transaction. Normally,Invoice or Fee can be reversed with Reversal, Payment or Claim with Voidor Decline itemCode xs:string optional         documentation itemCode: The item code. isComplimentary xs:boolean optional         documentation isComplimentary: The is complimentary. paymentOption xs:IDREF optional         documentation paymentOption: The payment option.
annotation	documentation Represents (multiple occurences possible) all objects that matched the search criteria
source	<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>

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