complexType PaymentPlan
diagram index_p24.png
namespace http://www.ibillingclient.org/schema/edi
type extension of ClientObject
properties
base ClientObject
children adjustment charge
used by
element response/paymentPlan
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
The Class PaymentPlan.
source <xs:complexType name="PaymentPlan">
 
<xs:annotation>
   
<xs:documentation>The Class PaymentPlan.</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ClientObject">
     
<xs:sequence>
       
<xs:element name="adjustment" type="Adjustment" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>Adjustment explaining reasons behind payment plan changes</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="charge" type="Charge" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Represents a single charge within a payment plan</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<xs:attribute name="lastInvocingDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>lastInvocingDate: The last invocing date.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="lastProcessingDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>lastProcessingDate: The last processing date.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="sellerCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>sellerCode: The seller code.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="length" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>length: The length.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="value" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>value: The value.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="deferredLength" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>deferredLength: The deferred length.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="deferredValue" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>deferredValue: The deferred value.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="amount" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>amount: The amount.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode1" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode1: The group code1.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode2" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode2: The group code2.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode3" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode3: The group code3.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode4" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode4: The group code4.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode5" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode5: The group code5.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode6" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode6: The group code6.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode7" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode7: The group code7.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="groupCode8" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>groupCode8: The group code8.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="type" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>type: The type.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="firstBillingDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>firstBillingDate: The first billing date.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="nextBillingDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>nextBillingDate: The next billing date.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="billingCycleCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>billingCycleCode: The billing cycle code.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="itemCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>itemCode: The item code.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="taxCode" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>taxCode: The tax code.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="lastUpdateDate" type="Date" use="optional">
       
<xs:annotation>
         
<xs:documentation>lastUpdateDate: The last update date.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="status" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>status: The status.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="linkAccount" type="xs:int" use="optional">
       
<xs:annotation>
         
<xs:documentation>linkAccount: The link account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="paymentOption" type="xs:IDREF" use="optional">
       
<xs:annotation>
         
<xs:documentation>paymentOption: The payment option.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="customerAccount" type="xs:IDREF" use="optional">
       
<xs:annotation>
         
<xs:documentation>customerAccount: The customer account.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="linkParentPlan" type="xs:IDREF" use="optional">
       
<xs:annotation>
         
<xs:documentation>linkParentPlan: The link parent plan.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute PaymentPlan/@lastInvocingDate
type Date
properties
isRef 0
use optional
facets
pattern \d\d\d\d\d\d\d\d
annotation
documentation
lastInvocingDate: The last invocing date.
source <xs:attribute name="lastInvocingDate" type="Date" use="optional">
 
<xs:annotation>
   
<xs:documentation>lastInvocingDate: The last invocing date.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@lastProcessingDate
type Date
properties
isRef 0
use optional
facets
pattern \d\d\d\d\d\d\d\d
annotation
documentation
lastProcessingDate: The last processing date.
source <xs:attribute name="lastProcessingDate" type="Date" use="optional">
 
<xs:annotation>
   
<xs:documentation>lastProcessingDate: The last processing date.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@sellerCode
type xs:string
properties
isRef 0
use optional
annotation
documentation
sellerCode: The seller code.
source <xs:attribute name="sellerCode" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>sellerCode: The seller code.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@length
type xs:int
properties
isRef 0
use optional
annotation
documentation
length: The length.
source <xs:attribute name="length" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>length: The length.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@value
type xs:int
properties
isRef 0
use optional
annotation
documentation
value: The value.
source <xs:attribute name="value" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>value: The value.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@deferredLength
type xs:int
properties
isRef 0
use optional
annotation
documentation
deferredLength: The deferred length.
source <xs:attribute name="deferredLength" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>deferredLength: The deferred length.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@deferredValue
type xs:int
properties
isRef 0
use optional
annotation
documentation
deferredValue: The deferred value.
source <xs:attribute name="deferredValue" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>deferredValue: The deferred value.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@amount
type xs:int
properties
isRef 0
use optional
annotation
documentation
amount: The amount.
source <xs:attribute name="amount" type="xs:int" use="optional">
 
<xs:annotation>
   
<xs:documentation>amount: The amount.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@groupCode1
type xs:string
properties
isRef 0
use optional
annotation
documentation
groupCode1: The group code1.
source <xs:attribute name="groupCode1" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>groupCode1: The group code1.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute PaymentPlan/@groupCode2
type xs:string
properties
isRef 0
use optional
annotation
documentation
groupCode2: The group code2.
source