complexType Adjustment
diagram index_p16.png
namespace http://www.ibillingclient.org/schema/edi
type extension of ClientObject
properties
base ClientObject
used by
element PaymentPlan/adjustment
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.
notesxs:stringoptional      
documentation
notes: Textual description of the adjustment reasons.
adjustmentReasonCodexs:stringoptional      
documentation
adjustmentReasonCode: Predefined code explaining the reason for the changes.
customerAccountxs:IDREFoptional      
documentation
customerAccount: Reference to CustomerAccount that owns the plans affected by the change.
annotation
documentation
Represents a change made to a PaymentPlan. Adjustment captures the reasonbehind the changes.<p/>The following changes are possible:<ul>
<li>Amount - changes billing amount of the plan</li>
<li>PaymentOption - changes payment option used for electronic billing</li>
<li>BillingCycle - changes date when invoices are generated</li>
<li>Cancellation - cancels some or all charges within a plan</li>
<li>Add - adds new billing charges to a plan</li>
<li>Freeze - adds new freeze (skip-billing) charges to a plan</li>
</ul>
source <xs:complexType name="Adjustment">
 
<xs:annotation>
   
<xs:documentation>Represents a change made to a PaymentPlan. Adjustment captures the reasonbehind the changes.<p/>The following changes are possible:<ul>
       
<li>Amount - changes billing amount of the plan</li>
       
<li>PaymentOption - changes payment option used for electronic billing</li>
       
<li>BillingCycle - changes date when invoices are generated</li>
       
<li>Cancellation - cancels some or all charges within a plan</li>
       
<li>Add - adds new billing charges to a plan</li>
       
<li>Freeze - adds new freeze (skip-billing) charges to a plan</li>
     
</ul>
   
</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ClientObject">
     
<xs:attribute name="notes" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>notes: Textual description of the adjustment reasons.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="adjustmentReasonCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>adjustmentReasonCode: Predefined code explaining the reason for the changes.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="customerAccount" type="xs:IDREF" use="optional">
       
<xs:annotation>
         
<xs:documentation>customerAccount: Reference to CustomerAccount that owns the plans affected by the change.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute Adjustment/@notes
type xs:string
properties
isRef 0
use optional
annotation
documentation
notes: Textual description of the adjustment reasons.
source <xs:attribute name="notes" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>notes: Textual description of the adjustment reasons.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute Adjustment/@adjustmentReasonCode
type xs:string
properties
isRef 0
use optional
annotation
documentation
adjustmentReasonCode: Predefined code explaining the reason for the changes.
source <xs:attribute name="adjustmentReasonCode" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>adjustmentReasonCode: Predefined code explaining the reason for the changes.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute Adjustment/@customerAccount
type xs:IDREF
properties
isRef 0
use optional
annotation
documentation
customerAccount: Reference to CustomerAccount that owns the plans affected by the change.
source <xs:attribute name="customerAccount" type="xs:IDREF" use="optional">
 
<xs:annotation>
   
<xs:documentation>customerAccount: Reference to CustomerAccount that owns the plans affected by the change.</xs:documentation>
 
</xs:annotation>
</xs:attribute>


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