Bill - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/Bill.xsd
Version 5.0.Revision
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v5/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v5/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v5/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v5/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v5/BillPayee.xsd (at BillPayee.xsd)
    • http://cufxstandards.com/v5/Artifact.xsd (at Artifact.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/Bill.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
relationship http://cufxstandards.com/v5/Relationship.xsd
contact http://cufxstandards.com/v5/Contact.xsd
account http://cufxstandards.com/v5/Account.xsd
billPayee http://cufxstandards.com/v5/BillPayee.xsd
artifact http://cufxstandards.com/v5/Artifact.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/Bill.xsd" version="5.0.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/BillPayee.xsd" schemaLocation="BillPayee.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Artifact.xsd" schemaLocation="Artifact.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: billList

Name billList
Type BillList
Nillable no
Abstract no
Documentation The bill list is the collection of bills from different payees for a party/relation/member.
JSON Instance Representation
{billList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"bill" : Bill , [0..*]
billList}
Schema Component Representation
<xs:element name="billList" type="BillList"/>
top

Global Definitions

Complex Type: Bill

Name Bill
Abstract no
JSON Instance Representation
{
"billId" : BillId , [0..1] ?
"billImageArtifactId" : artifact:ArtifactId , [0..1] ?
"eBillUri" : xs:anyURI , [0..1] ?
"billFromPayeeId" : billPayee:BillPayeeId , [0..1] ?
"billFromPayeeGlobalId" : billPayee:BillPayeeGlobalId , [0..1] ?
"partyId" : common:PartyId , [0..1] ?
"relationshipId" : relationship:RelationshipId , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"isEBill" : xs:boolean , [1] ?
"dueAmount" : common:Money , [0..1] ?
"earlyPaymentAmount" : common:Money , [0..1] ?
"minimumPaymentAmount" : common:Money , [0..1] ?
"sentDateTime" : xs:dateTime , [0..1] ?
"dueDateTime" : xs:dateTime , [0..1] ?
"earlyPaymentDateTime" : xs:dateTime , [0..1] ?
"lateFee" : common:Money , [0..1] ?
"updatedDateTime" : xs:dateTime , [0..1] ?
"billStatus" : BillStatus , [0..1] ?
"paymentClearedDateTime" : xs:dateTime , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"otherBillStatus" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Bill">
<xs:sequence>
<xs:element name="billId" type="BillId" minOccurs="0" maxOccurs="1"/>
<xs:element name="billImageArtifactId" type="artifact:ArtifactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="eBillUri" type="xs:anyURI" minOccurs="0" maxOccurs="1"/>
<xs:element name="billFromPayeeId" type="billPayee:BillPayeeId" minOccurs="0" maxOccurs="1"/>
<xs:element name="billFromPayeeGlobalId" type="billPayee:BillPayeeGlobalId" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyId" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipId" type="relationship:RelationshipId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountType" type="account:AccountType" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountSubType" type="account:AccountSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="isEBill" type="xs:boolean" minOccurs="1" maxOccurs="1"/>
<xs:element name="dueAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="earlyPaymentAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="minimumPaymentAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="sentDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="dueDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="earlyPaymentDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="lateFee" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="updatedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="billStatus" type="BillStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="paymentClearedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherBillStatus" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: BillIdList

Name BillIdList
Abstract no
Documentation The list of bill IDs that should have their associated bills either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"billId" : BillId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="BillIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="billId" type="BillId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: BillList

Name BillList
Abstract no
Documentation The bill list is the collection of bills from different payees for a party/relation/member.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"bill" : Bill , [0..*]
}
Schema Component Representation
<xs:complexType name="BillList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="bill" type="Bill" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: BillStatusList

Name BillStatusList
Abstract no
Documentation The list of bill statuses that should have their associated bill records either returned or affected by a read, update or delete request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"billStatus" : BillStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="BillStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="billStatus" type="BillStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: BillId

Name BillId
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="BillId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: BillStatus

Name BillStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Due'|'OverDue'|'Cancelled'|'Suspended'|'Paid'|'Void'|'Dispute'|'PaymentFailed'|'Scheduled'|'Other'}
Documentation This is enumeration of statuses for the bill payee.
Schema Component Representation
<xs:simpleType name="BillStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Due"/>
<xs:enumeration value="OverDue"/>
<xs:enumeration value="Cancelled"/>
<xs:enumeration value="Suspended"/>
<xs:enumeration value="Paid"/>
<xs:enumeration value="Void"/>
<xs:enumeration value="Dispute"/>
<xs:enumeration value="PaymentFailed"/>
<xs:enumeration value="Scheduled"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top