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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/InvestmentHolding.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/Account.xsd (at Account.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/InvestmentHolding.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
account http://cufxstandards.com/v5/Account.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/InvestmentHolding.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/Account.xsd" schemaLocation="Account.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: investmentHoldingList

Name investmentHoldingList
Type InvestmentHoldingList
Nillable no
Abstract no
Documentation Top level investment account list collection element.
JSON Instance Representation
{investmentHoldingList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"investmentHolding" : InvestmentHolding , [0..*] ?
investmentHoldingList}
Schema Component Representation
<xs:element name="investmentHoldingList" type="InvestmentHoldingList"/>
top

Global Definitions

Complex Type: HoldingIdList

Name HoldingIdList
Abstract no
Documentation The list of holding IDs that should have their associated accounts 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. -->
"holdingId" : HoldingId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="HoldingIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="holdingId" type="HoldingId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: InvestmentHolding

Name InvestmentHolding
Abstract no
JSON Instance Representation
{
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"holdingID" : HoldingId , [0..1] ?
"holdingCusipNumber" : xs:string , [0..1] ?
"holdingAsOfDateTime" : xs:dateTime , [0..1] ?
"holdingType" : HoldingType , [0..1] ?
"holdingDescription" : xs:string , [0..1] ?
"holdingQuantity" : xs:decimal , [0..1] ?
"holdingPrice" : common:Money , [0..1] ?
"holdingPriceDateTime" : xs:dateTime , [0..1] ?
"holdingStockSymbol" : xs:string , [0..1] ?
"holdingTotalValue" : common:Money , [0..1] ?
"holdingYield" : xs:decimal , [0..1] ?
"holdingYieldAsOfDate" : xs:dateTime , [0..1] ?
"holdingAssetClass" : xs:string , [0..1] ?
"holdingBondClass" : xs:string , [0..1] ?
"holdingBondType" : xs:string , [0..1] ?
"holdingMoodyRating" : xs:string , [0..1] ?
"holdingStandardAndPoorsRating" : xs:string , [0..1] ?
"holdingParValue" : common:Money , [0..1] ?
"holdingCouponRate" : xs:decimal , [0..1] ?
"holdingCouponFrequency" : common:FrequencyType , [0..1] ?
"holdingCallPrice" : common:Money , [0..1] ?
"holdingYieldToCall" : xs:decimal , [0..1] ?
"holdingCallType" : xs:string , [0..1] ?
"holdingYieldToMaturity" : xs:decimal , [0..1] ?
"holdingMaturityDate" : xs:dateTime , [0..1] ?
"holdingNextCouponDate" : xs:dateTime , [0..1] ?
"holdingNextCallDate" : xs:dateTime , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="InvestmentHolding">
<xs:sequence>
<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="holdingID" type="HoldingId" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingCusipNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingAsOfDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingType" type="HoldingType" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingQuantity" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingPrice" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingPriceDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingStockSymbol" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingTotalValue" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingYield" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingYieldAsOfDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingAssetClass" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingBondClass" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingBondType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingMoodyRating" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingStandardAndPoorsRating" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingParValue" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingCouponRate" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingCouponFrequency" type="common:FrequencyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingCallPrice" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingYieldToCall" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingCallType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingYieldToMaturity" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingMaturityDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingNextCouponDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdingNextCallDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: InvestmentHoldingList

Name InvestmentHoldingList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"investmentHolding" : InvestmentHolding , [0..*] ?
}
Schema Component Representation
<xs:complexType name="InvestmentHoldingList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="investmentHolding" type="InvestmentHolding" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: HoldingId

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

Simple Type: HoldingType

Name HoldingType
Content
  • Base XSD Type: string
  • value comes from list: {'Asset'|'Bond'|'Certificate of Deposit'|'Exchange-Traded Fund'|'Insurance'|'IRA Traditional'|'IRA Roth'|'IRA SEP'|'Money market account'|'Mutual fund'|'Real Estate'|'REIT'|'Stock'|'Other'|'RRIF'|'RRSP'|'TFSA'}
Schema Component Representation
<xs:simpleType name="HoldingType">
<xs:restriction base="xs:string">
<xs:enumeration value="Asset"/>
<xs:enumeration value="Bond"/>
<xs:enumeration value="Certificate of Deposit"/>
<xs:enumeration value="Exchange-Traded Fund"/>
<xs:enumeration value="Insurance"/>
<xs:enumeration value="IRA Traditional"/>
<xs:enumeration value="IRA Roth"/>
<xs:enumeration value="IRA SEP"/>
<xs:enumeration value="Money market account"/>
<xs:enumeration value="Mutual fund"/>
<xs:enumeration value="Real Estate"/>
<xs:enumeration value="REIT"/>
<xs:enumeration value="Stock"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="RRIF"/>
<xs:enumeration value="RRSP"/>
<xs:enumeration value="TFSA"/>
</xs:restriction>
</xs:simpleType>
top