Changes that might require adjustments on your side

On this page, we will collect the changes in our API that are necessary to adapt to Morningstar’s rework. Depending on how your systems are designed, they might require adjustments on your side.

Corporate Actions

subtype. We’ll start populating the field subType with the value SP when type=SPINOFF. Currently, it’s empty. This will ensure consistency and allow clients to determine the type of a corporate action using only one field – subtype or type – instead of needing to use both.

Rights Issues and Capital Repayment. Two new types of corporate actions are being added: Rights Issues and Capital Repayment.

• A capital repayment is a return of capital similar to a special dividend but it has different tax treatment. It is being collected for all companies globally, but it is typically only used by companies in the United Kingdom. There would not be any adjustment made to historical price data and per share data, however, these would be considered while calculating Total Return, similar to a Special Cash Dividend event.
• A right issue opt by a company is intended to raise new capital by new shares issued/offered to existing shareholders in proportion to their current shareholding, for a specified period and at a specified (usually discounted) price. For example, in a two-for-five rights issue, stockholders are offered two shares for every five they already hold at a discounted price.
• From the technical point of view, 2 new values arise for the type field (“RIGHTS_ISSUES” for Rights Issues and “CAPITAL_REPAYMENT” for Capital Repayment) and for the subtype field (“RI” for Rights Issues and “CR” for Capital Repayment).

taxRate. We are adding a new extension field: taxRate. It contains the withholding tax rate: the tax rate applicable to derive the Cash Dividend Net Amount. The Cash Dividend Net Amount is displayed in the adjustmentValue field for cash dividends.

Earning Ratio

fiscalYearEndMonth. (Update: This field will continue to be populated as we found the way to populate it on our side. Therefore, nothing changes for you) The extension field fiscalYearEndMonth is retired and will be empty from now on. It will, however, persist in the Earning Report controller.

Instrument Reference

srcExchange. Due to the transition from legacy localized datasets to a global schema, the field srcExchange in the Instrument Reference controller will be updated to ensure consistency across regions and products. Currently, it contains values such as (PINX, NYS, ASE, etc.). After the update, its values will be (OTCPK, NYSE, AMEX, etc.). It will not affect the exchange code encoded in dxSymbol.

industryTemplateCode. Possible values for the field industryTemplateCode will change, reflecting the change in methodology:

• Current possible values: N (Manufacturing), B (Bank), I (Insurance), M (Mining), U (Utility), T (Transportation).
• New possible values: N (Normal), B (Bank), I (Insurance), V (Investment).

advisorType. We are adding a new advisorType field. It provides more transparency on the role of advisor. Examples are:

• Solicitor
• Financial Adviser
• Remuneration Consultant
• Bank
• Stockbroker

shareClassDescription. Previously, this field was populated only when it was necessary to indicate the share class, such as “Class A” or “Class B”. Now, it will contain both the share class and the share name, for example: “Berkshire Hathaway Inc. B” instead of just “Class B”. It means that clients no longer need to concatenate shareClassDescription with standardName or legalName to form a full name; instead, you can just use shareClassDescription. Also, this field will now always be populated, at least with the share name, for example: “Maruwa Co., Ltd”.

reportStyle. The extension field reportStyle is retired and will be empty from now on.

delistingReason. The extension field delistingReason is retired and will be empty from now on.

Operation Ratio

fiscalYearEndMonth. (Update: This field will continue to be populated as we found the way to populate it on our side. Therefore, nothing changes for you) The extension field fiscalYearEndMonth is retired and will be empty from now on. It will, however, persist in the Earning Report controller.