Billing - Complex Types
This section documents the complex data types for Billing service.
ChargingPlanInfo
Description: Charging plan data
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Element: name
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan name
Properties
| Property | Value |
|---|---|
| content | simple |
XSD Source
<xs:element name="name" type="common:string">
<xs:annotation>
<xs:documentation>Charging plan name</xs:documentation>
</xs:annotation>
</xs:element>Element: default
Type: common:boolean
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Set default charging plan
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="default" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Set default charging plan</xs:documentation>
</xs:annotation>
</xs:element>Element: planType
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan type: prepaid or postpaid. Default prepaid.
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
| default | prepaid |
XSD Source
<xs:element name="planType" type="common:string" minOccurs="0" default="prepaid">
<xs:annotation>
<xs:documentation>Charging plan type: prepaid or postpaid. Default prepaid.</xs:documentation>
</xs:annotation>
</xs:element>Element: chargeMethod
Type: restriction of xs:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charge method. Default value: fixed.
Properties
| Property | Value |
|---|---|
| content | complex |
| minOccurs | 0 |
| default | fixed |
Allowed Values
| Value | Description |
|---|---|
fixed | |
inherit |
XSD Source
<xs:element name="chargeMethod" minOccurs="0" default="fixed">
<xs:annotation>
<xs:documentation>Charge method. Default value: fixed.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fixed"/>
<xs:enumeration value="inherit"/>
</xs:restriction>
</xs:simpleType>
</xs:element>Element: soundID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Custom sound file played when outgoing access is blocked
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="soundID" type="common:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Custom sound file played when outgoing access is blocked</xs:documentation>
</xs:annotation>
</xs:element>Choice Element
Outgoing routing rule
- channelRuleID: common:positiveInteger - Outgoing routing rule identifier
- channelRule: common:string - Outgoing routing rule
ChargingPlanList
Description: Charging plan list data
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Element: ID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan ID
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="ID" type="common:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan ID</xs:documentation>
</xs:annotation>
</xs:element>Element: identifier
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan identifier
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="identifier" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan identifier</xs:documentation>
</xs:annotation>
</xs:element>Element: status
Type: common:boolean
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan status
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="status" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan status</xs:documentation>
</xs:annotation>
</xs:element>Element: name
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan name
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="name" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan name</xs:documentation>
</xs:annotation>
</xs:element>Element: planType
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan type: prepaid or postpaid.
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
| default | prepaid |
XSD Source
<xs:element name="planType" type="common:string" minOccurs="0" default="prepaid">
<xs:annotation>
<xs:documentation>Charging plan type: prepaid or postpaid.</xs:documentation>
</xs:annotation>
</xs:element>Element: default
Type: common:boolean
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Default charging plan
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="default" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Default charging plan</xs:documentation>
</xs:annotation>
</xs:element>Element: userID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan owner ID
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="userID" type="common:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan owner ID</xs:documentation>
</xs:annotation>
</xs:element>Element: userName
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan owner name
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="userName" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Charging plan owner name</xs:documentation>
</xs:annotation>
</xs:element>Element: common:scope
Type: common:scope
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="common:scope" type="common:scope" minOccurs="0"/>Credits
Description: Charging credits definition: prepaid charging plan
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Element: creditIn
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Outgoing calls credit
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="creditIn" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Outgoing calls credit</xs:documentation>
</xs:annotation>
</xs:element>Element: creditOut
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Incoming calls credit
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="creditOut" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Incoming calls credit</xs:documentation>
</xs:annotation>
</xs:element>Element: orderNo
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Order number
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="orderNo" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Order number</xs:documentation>
</xs:annotation>
</xs:element>Limits
Description: Charging limits definition: postpaid charging plan
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Element: limitIn
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Outgoing money limit
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="limitIn" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Outgoing money limit</xs:documentation>
</xs:annotation>
</xs:element>Element: limitOut
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Incoming money limit
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="limitOut" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Incoming money limit</xs:documentation>
</xs:annotation>
</xs:element>Element: overusage
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Overusage minutes
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="overusage" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Overusage minutes</xs:documentation>
</xs:annotation>
</xs:element>Element: orderNo
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Order number
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="orderNo" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Order number</xs:documentation>
</xs:annotation>
</xs:element>Element: monthly
Type: common:boolean
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: These limits should be added every month
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="monthly" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>These limits should be added every month</xs:documentation>
</xs:annotation>
</xs:element>CreditsList
Description: Charging plan recharge credits data
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Extends: Credits
Element: creditID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Billling plan credit ID
Properties
| Property | Value |
|---|---|
| content | simple |
XSD Source
<xs:element name="creditID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Billling plan credit ID</xs:documentation>
</xs:annotation>
</xs:element>Element: common:crDate
Type: common:crDate
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="common:crDate" type="common:crDate" minOccurs="0"/>LimitsList
Description: Charging plan recharge limits data
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Extends: Limits
Element: limitID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan limit ID
Properties
| Property | Value |
|---|---|
| content | simple |
XSD Source
<xs:element name="limitID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Charging plan limit ID</xs:documentation>
</xs:annotation>
</xs:element>Element: common:crDate
Type: common:crDate
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="common:crDate" type="common:crDate" minOccurs="0"/>DestinationException
Description: Destination exception charge
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Element: areaCode
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Area code
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="areaCode" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Area code</xs:documentation>
</xs:annotation>
</xs:element>Element: description
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="description" type="common:string" minOccurs="0"/>Element: charge
Type: inline complex type
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | complex |
| minOccurs | 0 |
XSD Source
<xs:element name="charge" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="initialAmount" type="xs:float" minOccurs="0">
<xs:annotation>
<xs:documentation>For fixed charging plans ONLY</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="initialInterval" type="common:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>For fixed charging plans ONLY</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="amount" type="xs:float" minOccurs="0"/>
<xs:element name="interval" type="common:integer" minOccurs="0"/>
<xs:element name="setupAmount" type="xs:float" minOccurs="0">
<xs:annotation>
<xs:documentation>For inherited charging plans ONLY</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>Choice Element
One of the following:
- chargingPackageID: common:positiveInteger - Free minutes package ID
- package: inline type - Free minutes package
DestinationExceptionList
Description: Destination exception charges list
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Element: chargingPlanID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan ID
Properties
| Property | Value |
|---|---|
| content | simple |
XSD Source
<xs:element name="chargingPlanID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Charging plan ID</xs:documentation>
</xs:annotation>
</xs:element>Element: exception
Type: inline complex type
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Destination exception charge
Properties
| Property | Value |
|---|---|
| content | complex |
| minOccurs | 0 |
| maxOccurs | unbounded |
XSD Source
<xs:element name="exception" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Destination exception charge</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Destination exception charge ID</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="areaCode" type="common:string">
<xs:annotation>
<xs:documentation>Area code</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="minutes" type="common:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>Included free minutes</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="common:string" minOccurs="0"/>
<xs:element name="initialAmount" type="xs:float" minOccurs="0"/>
<xs:element name="initialInterval" type="common:integer" minOccurs="0"/>
<xs:element name="amount" type="xs:float" minOccurs="0"/>
<xs:element name="interval" type="common:integer" minOccurs="0"/>
<xs:element name="chargingPackageID" type="common:positiveInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>Free minutes package ID</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="chargingPackage" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Free minutes package name</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>Element: common:notice
Type: common:notice
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
| maxOccurs | unbounded |
XSD Source
<xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>ChargingPackage
Description: Free minutes package
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Element: name
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Package name
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="name" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Package name</xs:documentation>
</xs:annotation>
</xs:element>Element: minutes
Type: common:integer
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Included minutes
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="minutes" type="common:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>Included minutes</xs:documentation>
</xs:annotation>
</xs:element>ChargingPackageList
Description: Free minutes packages list
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Used by
Element: chargingPlanID
Type: common:positiveInteger
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan ID
Properties
| Property | Value |
|---|---|
| content | simple |
XSD Source
<xs:element name="chargingPlanID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Charging plan ID</xs:documentation>
</xs:annotation>
</xs:element>Element: package
Type: inline complex type
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Free minutes package list
Properties
| Property | Value |
|---|---|
| content | complex |
| minOccurs | 0 |
| maxOccurs | unbounded |
XSD Source
<xs:element name="package" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Free minutes package list</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type="common:positiveInteger">
<xs:annotation>
<xs:documentation>Free minutes package ID</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Package name</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="minutes" type="common:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>Included minutes</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>Recharge
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Element: planType
Type: restriction of xs:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Charging plan type
Properties
| Property | Value |
|---|---|
| content | complex |
| minOccurs | 0 |
| default | postpaid |
Allowed Values
| Value | Description |
|---|---|
prepaid | |
postpaid |
XSD Source
<xs:element name="planType" minOccurs="0" default="postpaid">
<xs:annotation>
<xs:documentation>Charging plan type</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="prepaid"/>
<xs:enumeration value="postpaid"/>
</xs:restriction>
</xs:simpleType>
</xs:element>Element: currentIn
Type: common:unlimitedUFloat
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Currently incoming credit/limit left
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="currentIn" type="common:unlimitedUFloat" minOccurs="0">
<xs:annotation>
<xs:documentation>Currently incoming credit/limit left</xs:documentation>
</xs:annotation>
</xs:element>Element: currentOut
Type: common:unlimitedUFloat
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Currently outgoing credit/limit left
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="currentOut" type="common:unlimitedUFloat" minOccurs="0">
<xs:annotation>
<xs:documentation>Currently outgoing credit/limit left</xs:documentation>
</xs:annotation>
</xs:element>Element: currentOverusage
Type: common:unlimitedUFloat
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Currently overusage minutes left
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="currentOverusage" type="common:unlimitedUFloat" minOccurs="0">
<xs:annotation>
<xs:documentation>Currently overusage minutes left</xs:documentation>
</xs:annotation>
</xs:element>Element: common:notice
Type: common:notice
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
| maxOccurs | unbounded |
XSD Source
<xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>Element: currency
Type: common:string
Namespace: http://4psa.com/BillingData.xsd/5.2.5
Description: Default system currency
Properties
| Property | Value |
|---|---|
| content | simple |
| minOccurs | 0 |
XSD Source
<xs:element name="currency" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Default system currency</xs:documentation>
</xs:annotation>
</xs:element>Choice Element
One of the following:
- credit: inline type
- limit: LimitsList