Earning

/FundsXML4/Funds/Fund/Subfunds/Subfund/Segments/Segment/Segments/Segment/SegmentDynamicData/Portfolios/Portfolio/Earnings/Earning

Diagram

Documentation

Earning data (single coupon, dividend or distribution) resulting from a security position

Properties

Type
EarningType
Cardinality
1..*
Namespace
xs = "http://www.w3.org/2001/XMLSchema"
altova = "http://www.altova.com/xml-schema-extensions"
ds = "http://www.w3.org/2000/09/xmldsig#"
Level
14
Sample Data

Child Elements & Attributes

Name (XPath) Type Documentation Sample Data
Text256Type

Unique Earning ID

Eindeutige Transaktionsnummer (Auftragsnummer)

Text (max. 256 characters)

ExampleText
xs:boolean

Indicates whether earning has been cancelled

Kennzeichen ob das Erträgnis storniert wurde

false
Text256Type

Earning ID of cancelled earning

Text (max. 256 characters)

ExampleText
xs:IDREF

Unique ID of asset (link to AssetMasterData)

Referenz zu den Wertpapierstammdaten

IdentifiersType

Identifiers of instrument (like ISIN, Ticker, ...)

Kennnummern des Instrumentes (ISIN, Ticker, ...)

xs:string

Type of earning:
Coupon, Dividend, Fund distribution, ...

Diese Bezeichnung ist aus dem Dictionary zu entnehmen.Gibt die Ertragsart an: z.B Coupon, Dividend,Fund distribution

Interest swap
xs:date

Closing date / trade date

Datum, an dem das Geschaeft abgeschlossen wurde

2022-03-07
xs:date

Date when earning has been booked into portfolio

2023-02-18
xs:date

Value date

2021-02-11
ISOCurrencyCodeType

Booking currency

Buchungswährung

Three-letter ISO-CurrencyCode (ISO 4217)

Dreistelliger ISO-Waehrungscode (ISO 4217)

KPO
ISOCurrencyCodeType

Income currency

Eträgniswährung

Three-letter ISO-CurrencyCode (ISO 4217)

Dreistelliger ISO-Waehrungscode (ISO 4217)

CIU
FundAmountType

Booking value

Buchungsbetrag

Amount in different currencies

Betrag in verschiedenen Waehrungen

FundAmountType

Interests value

Amount in different currencies

Betrag in verschiedenen Waehrungen

FXRatesType

FX Rates used for this earning

xs:decimal

Nominal value / units

Stuecke / Nominale

637.17
Text100Type

External reference number of earning transaction

Externe Referenznummer der Erträgnisbuchung

Text (max. 100 characters)

ExampleText
xs:integer

Account number of earning transaction

Kontonummer der Erträgnisbuchung

3702
Text1000Type

Posting text of earning transaction

Buchungstext der Erträgnisbuchung

Text (max. 1000 characters)

ExampleText
xs:boolean

Earning finally settled or not

true
(anonymous)

Earning details for coupon payments

Erträgnis vom Typ Kuponzahlung

(anonymous)

Earning details for dividend payments

Erträgnis vom Typ Dividendenzahlung

(anonymous)

Earning details for fund distributions

Erträgnis vom Typ Fondsausschüttung

Element Definition

<xs:element xmlns:altova="http://www.altova.com/xml-schema-extensions"
            xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
            xmlns:xs="http://www.w3.org/2001/XMLSchema"
            maxOccurs="unbounded"
            name="Earning"
            type="EarningType">
   <xs:annotation>
      <xs:documentation>Earning data (single coupon, dividend or distribution) resulting from a security position</xs:documentation>
   </xs:annotation>
</xs:element>

Referenced Type Definition (EarningType)

<xs:complexType xmlns:altova="http://www.altova.com/xml-schema-extensions"
                xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
                xmlns:xs="http://www.w3.org/2001/XMLSchema"
                name="EarningType">
   <xs:sequence>
      <xs:element name="EarningID" type="Text256Type">
         <xs:annotation>
            <xs:documentation xml:lang="en">Unique Earning ID</xs:documentation>
            <xs:documentation xml:lang="de">Eindeutige Transaktionsnummer (Auftragsnummer)</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="CancellationFlag" type="xs:boolean">
         <xs:annotation>
            <xs:documentation xml:lang="en">Indicates whether earning has been cancelled</xs:documentation>
            <xs:documentation xml:lang="de">Kennzeichen ob das Erträgnis storniert wurde</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="OriginalEarningID" type="Text256Type">
         <xs:annotation>
            <xs:documentation>Earning ID of cancelled earning</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="AssetUniqueID">
         <xs:annotation>
            <xs:documentation xml:lang="en">Unique ID of asset (link to AssetMasterData)</xs:documentation>
            <xs:documentation xml:lang="de">Referenz zu den Wertpapierstammdaten</xs:documentation>
         </xs:annotation>
         <xs:simpleType>
            <xs:restriction base="xs:IDREF">
               <xs:maxLength value="256"/>
            </xs:restriction>
         </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="Identifiers" type="IdentifiersType">
         <xs:annotation>
            <xs:documentation xml:lang="en">Identifiers of instrument (like ISIN, Ticker, ...)</xs:documentation>
            <xs:documentation xml:lang="de">Kennnummern des Instrumentes (ISIN, Ticker, ...)</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element name="EarningKind">
         <xs:annotation>
            <xs:documentation xml:lang="en">Type of earning:
Coupon, Dividend, Fund distribution, ...</xs:documentation>
            <xs:documentation xml:lang="de">Diese Bezeichnung ist aus dem Dictionary zu entnehmen.Gibt die Ertragsart an: z.B Coupon, Dividend,Fund distribution</xs:documentation>
         </xs:annotation>
         <xs:simpleType>
            <xs:restriction base="xs:string">
               <xs:enumeration value="Coupon"/>
               <xs:enumeration value="Dividend"/>
               <xs:enumeration value="Fund distribution"/>
               <xs:enumeration value="Interest deposit/giro"/>
               <xs:enumeration value="Interest swap"/>
               <xs:enumeration value="Other"/>
            </xs:restriction>
         </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ClosingDate" type="xs:date">
         <xs:annotation>
            <xs:documentation xml:lang="en">Closing date / trade date</xs:documentation>
            <xs:documentation xml:lang="de">Datum, an dem das Geschaeft abgeschlossen wurde</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element name="EntryDate" type="xs:date">
         <xs:annotation>
            <xs:documentation>Date when earning has been booked into portfolio</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="ValutaDate" type="xs:date">
         <xs:annotation>
            <xs:documentation>Value date</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element name="EntryCurrency" type="ISOCurrencyCodeType">
         <xs:annotation>
            <xs:documentation xml:lang="en">Booking currency</xs:documentation>
            <xs:documentation xml:lang="de">Buchungswährung</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="IncomeCurrency" type="ISOCurrencyCodeType">
         <xs:annotation>
            <xs:documentation xml:lang="en">Income currency</xs:documentation>
            <xs:documentation xml:lang="de">Eträgniswährung</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element name="EntryValue" type="FundAmountType">
         <xs:annotation>
            <xs:documentation xml:lang="en">Booking value</xs:documentation>
            <xs:documentation xml:lang="de">Buchungsbetrag</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="Interests" type="FundAmountType">
         <xs:annotation>
            <xs:documentation>Interests value</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="FXRates" type="FXRatesType">
         <xs:annotation>
            <xs:documentation>FX Rates used for this earning</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="NominalValueOrUnits" type="xs:decimal">
         <xs:annotation>
            <xs:documentation xml:lang="en">Nominal value / units</xs:documentation>
            <xs:documentation xml:lang="de">Stuecke / Nominale</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="ReferenceNumber" type="Text100Type">
         <xs:annotation>
            <xs:documentation xml:lang="en">External reference number of earning transaction</xs:documentation>
            <xs:documentation xml:lang="de">Externe Referenznummer der Erträgnisbuchung</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="AccountNumber" type="xs:integer">
         <xs:annotation>
            <xs:documentation xml:lang="en">Account number of earning transaction</xs:documentation>
            <xs:documentation xml:lang="de">Kontonummer der Erträgnisbuchung</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="PostingText" type="Text1000Type">
         <xs:annotation>
            <xs:documentation xml:lang="en">Posting text of earning transaction</xs:documentation>
            <xs:documentation xml:lang="de">Buchungstext der Erträgnisbuchung</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="FinallySettled" type="xs:boolean">
         <xs:annotation>
            <xs:documentation>Earning finally settled or not</xs:documentation>
         </xs:annotation>
      </xs:element>
      <xs:choice minOccurs="0">
         <xs:annotation>
            <xs:documentation xml:lang="en">Details specific for coupons, dividends and distributions</xs:documentation>
            <xs:documentation xml:lang="de">Aufsplittung in die verschiedenen Ertraegnissarten:
- Kupons
- Dividenden
- Fondsausschuettung</xs:documentation>
         </xs:annotation>
         <xs:element name="Coupon">
            <xs:annotation>
               <xs:documentation xml:lang="en">Earning details for coupon payments</xs:documentation>
               <xs:documentation xml:lang="de">Erträgnis vom Typ Kuponzahlung</xs:documentation>
            </xs:annotation>
            <xs:complexType>
               <xs:sequence>
                  <xs:element minOccurs="0" name="UnitInterestsGrossValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Unit interests gross value</xs:documentation>
                        <xs:documentation xml:lang="de">Bruttostueckzinsen der Transaktion</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="UnitInterestsNetValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Unit interests net value</xs:documentation>
                        <xs:documentation xml:lang="de">Nettostueckzinsen der Transaktion</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="CapitalYieldsTaxValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Capital yields tax value</xs:documentation>
                        <xs:documentation xml:lang="de">KESt-Betrag der Wertpapiertransaktion</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="EUWithholdingTaxValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">EU withholding tax value</xs:documentation>
                        <xs:documentation xml:lang="de">Betrag der EU Quest</xs:documentation>
                     </xs:annotation>
                  </xs:element>
               </xs:sequence>
            </xs:complexType>
         </xs:element>
         <xs:element name="Dividend">
            <xs:annotation>
               <xs:documentation xml:lang="en">Earning details for dividend payments</xs:documentation>
               <xs:documentation xml:lang="de">Erträgnis vom Typ Dividendenzahlung</xs:documentation>
            </xs:annotation>
            <xs:complexType>
               <xs:sequence>
                  <xs:element minOccurs="0" name="DividendPerUnitValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Dividend value (per unit)</xs:documentation>
                        <xs:documentation xml:lang="de">Dividende pro Stück</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="DividendGrossValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Dividend gross value</xs:documentation>
                        <xs:documentation xml:lang="de">Bruttobetrag der Dividende</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="DividendNetValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Dividend net value</xs:documentation>
                        <xs:documentation xml:lang="de">Nettobetrag der Dividende</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="WithholdingTaxValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Withholding tax value</xs:documentation>
                        <xs:documentation xml:lang="de">Quest Betrag</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="ExDay" type="xs:date">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Ex day of dividend</xs:documentation>
                        <xs:documentation xml:lang="de">Extag der Dividende</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="PayDay" type="xs:date">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Pay day of dividend</xs:documentation>
                        <xs:documentation xml:lang="de">Auszahlungstag der Dividende</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="WithholdingTaxQuota" type="PercentageType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Withholding tax quota of dividend</xs:documentation>
                        <xs:documentation xml:lang="de">Quest-Satz der Dividende</xs:documentation>
                     </xs:annotation>
                  </xs:element>
               </xs:sequence>
            </xs:complexType>
         </xs:element>
         <xs:element name="FundDistribution">
            <xs:annotation>
               <xs:documentation xml:lang="en">Earning details for fund distributions</xs:documentation>
               <xs:documentation xml:lang="de">Erträgnis vom Typ Fondsausschüttung</xs:documentation>
            </xs:annotation>
            <xs:complexType>
               <xs:sequence>
                  <xs:element minOccurs="0" name="PayoutPerUnitValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Payout value (per unit)</xs:documentation>
                        <xs:documentation xml:lang="de">Ausschuettung pro Stueck</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="PayoutGrossValue" type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Payout gross value of distribution</xs:documentation>
                        <xs:documentation xml:lang="de">Brutto-Ausschüttungsbetrag</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0"
                              name="CapitalYieldsTaxUnitValue"
                              type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Capital yields tax value (per unit)</xs:documentation>
                        <xs:documentation xml:lang="de">KESt-Betrag der Ausschüttung (pro Stück)</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0"
                              name="CapitalYieldsTaxOverallValue"
                              type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Total capital yields tax value (per unit)</xs:documentation>
                        <xs:documentation xml:lang="de">KESt-Gesamtbetrag der Ausschüttung (pro Stück)</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0"
                              name="EUWithholdingTaxUnitValue"
                              type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">EU withholding tax value (per unit)</xs:documentation>
                        <xs:documentation xml:lang="de">EU-Quest Betrag pro Stück</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0"
                              name="EUWithholdingTaxOverallValue"
                              type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Total EU withholding tax value</xs:documentation>
                        <xs:documentation xml:lang="de">EU Quest Gesamtbetrag</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0"
                              name="PayoutIdenticEarningsValue"
                              type="FundAmountType">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Payout identic earnings value</xs:documentation>
                        <xs:documentation xml:lang="de">Ausschüttungsgleicher Ertrag</xs:documentation>
                     </xs:annotation>
                  </xs:element>
                  <xs:element minOccurs="0" name="ExDay" type="xs:date">
                     <xs:annotation>
                        <xs:documentation xml:lang="en">Ex day of distribution</xs:documentation>
                        <xs:documentation xml:lang="de">Extag der Ausschüttung</xs:documentation>
                     </xs:annotation>
                  </xs:element>
               </xs:sequence>
            </xs:complexType>
         </xs:element>
      </xs:choice>
   </xs:sequence>
</xs:complexType>