Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The following three events are used only as part of the conversion process and are not designed for clients already in production:

  • OPEN_CASHDIV

  • COUPON

  • RECLAIM

These events are used to load unsettled cash transactions as of the Conversion Date. Production clients do not use these events since this data is derived by Global Processing.

On this page

Open Cash Dividend

The OPEN_CASHDIV event is used to send unsettled cash transactions and traded rows to STAR as part of the conversion process. If amounts are supplied for the Reclaim Settle field (tag 852) and the Reclaim Base field (tag 851), a traded row is also added for the Reclaim associated with the Cash Dividend.

Open Cash Dividend Data Table

The following table describes the required and optional data fields for Open Cash Dividends.

Tag # – Tag Name

Required/Optional

Data Type

Value/Description of Field

55 – Event Type

Required

CHAR

OPEN_CASHDIV.

1163 – Entity ID

Required

CHAR (8)

Exact match lookup against RULESENTITY.ENTITY_ID.

3912 – Tax Accounting Method

Optional

VARCHAR2 (10)

Defaults to GL if not supplied.

35 – Ex Date

Required

DATE


36 – Accounting Date

Optional

DATE

Populates through lookup if not supplied.

37 – Settlement Date

Required

DATE


30 – Post Date

Optional

DATE

Defaults to Ex date if not supplied.

15 – Long Short Indicator

Optional

CHAR

 L or S. Defaults to L if not supplied.

1432 – Xreference Type

Optional

CHAR (30)


14 – Xref ID

Required

CHAR (100)

Exact match lookup against xreference table.

1077 – Calculate Dividend Switch

Optional

CHAR

If set to CALCULATE_DIVIDEND, the settlement and base amounts of the dividend, tax expense, and reclaim are calculated.

1737 – Periodic Distribution Type

Optional

VARCHAR2 (30)

Defaults to D (Cash Dividend) if not supplied. Valid values:
5 = 5 Year Capital Gain Distribution
I = Fund Income Distribution
LT = LT Capital Gain Distribution
ST = ST Capital Gain Distribution

1728 – Corporate Action Type

Optional

VARCHAR2 (50)


40 – Shares

Required

NUMBER(38,12)

Quantity held as of the Ex date.

45 – Dividend Per Share Rate

Conditionally Required – required if tag 1077 is set to CALCULATE_DIVIDEND

DEC


1295 – Tax Withholding Rate

Optional

NUMBER (28,12)

Tax withholding percentage as a whole number.

1296 – Tax Reclaim Rate

Optional

NUMBER (28,12)

Tax reclaim percentage as a whole number

87 – Settle to Base FX Rates

Required

DEC


325 – Gross Dividend Settle

Conditionally Required

MONEYL

Gross amount of dividend, including taxes. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. If tag 1077 is not equal to CALCULATE_DIVIDEND, this value must be supplied.

330 – Gross Dividend Base

Conditionally Required

MONEYB

Gross amount of dividend, including taxes. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. Otherwise, this value must be supplied.

50 – Net Settlement Amount

Conditionally Required

MONEYL

Net Settlement Amount of dividend. Typically equal to the local amount in situations where Asset Currency = Settlement Currency. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived by taking the Gross Dividend Settle and subtracting the tax and reclaim amounts. If tag 1077 is not equal to CALCULATE_DIVIDEND, this value must be supplied.

478 – Net Base Amount

Conditionally Required

MONEYB

Net Base Amount of dividend. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived by taking the Gross Dividend Base and subtracting the tax and reclaim amounts. If tag 1077 is not equal to CALCULATE_DIVIDEND, this value must be supplied.

852 – Reclaim Settle

Optional

MONEYL

Reclaim amount of the cash dividend in the settlement currency. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. If tag 1077 is not equal to CALCULATE_DIVIDEND, this must be supplied if applicable.

851 – Reclaim Base

Optional

MONEYB

Reclaim amount of the cash dividend in the entity's base currency. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. If tag 1077 is not equal to CALCULATE_DIVIDEND, this must be supplied if applicable.

853 – Tax Expense Settle

Optional

MONEYL

Tax expense amount in settlement currency. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. If tag 1077 is not equal to CALCULATE_DIVIDEND, this must be supplied if applicable.

854 – Tax Expense Base

Optional

MONEYB

Tax expense amount in entity's base currency. If tag 1077 is set to CALCULATE_DIVIDEND, this value is derived. If tag 1077 is not equal to CALCULATE_DIVIDEND, this must be supplied if applicable.

85 – Settlement Currency

Conditionally Required

CHAR (30)

Required for dividends where Asset Currency does not equal Settlement Currency of dividend. This must contain the Settlement Currency.

5363 – Local Amount

Conditionally Required

MONEYL

If Asset Currency does not equal the Settlement Currency, this tag must contain the dividend amount in the asset (local) currency.

1078 – Reclaim Local Amount

Conditionally Required

CHAR

If Asset Currency does not equal the Settlement Currency, this tag must contain the dividend reclaim amount in the asset (local) currency.

7250 – Tax Reclaim Offset Days

Optional

INTEGER


245 – Tax Reclaim Settle Date

Optional

DATE

Settlement date of dividend plus Tax Reclaim Offset Days.

56 – Notes

Optional

VARCHAR2(255)


25 – Event ID – Dividend

Optional

VARCHAR2(55)

Event ID of cash dividend. STAR creates a unique ID if not supplied.

944 – Update Source

Optional

VARCHAR2 (8)


7000 – Income Statement Posting

Optional

CHAR

Valid values are Y or N. If set to N, postings to income and expense accounts are backed out.

Coupon

The COUPON event is used to send unsettled coupon transactions and traded rows to STAR as part of the conversion process. If amounts are supplied for the Reclaim Settle field (tag 852) and the Reclaim Base field (tag 851), a traded row is also added for the Reclaim associated with the Coupon.

Coupon Data Table

The following table describes the required and optional data fields for Coupons.

Tag # – Tag Name

Required/Optional

Date Type

Value/Description of Field

55 – Event Type

Required

CHAR

COUPON.

1163 – Entity ID

Required

CHAR (8)

Exact match lookup against RULESENTITY.ENTITY_ID.

3912 – Tax Accounting Method

Optional

VARCHAR2 (10)

Defaults to GL if not supplied.

35 – Effective Date

Required

DATE


36 – Accounting Date

Optional

DATE

Populates through lookup if not supplied.

37 – Settlement Date

Required

DATE


30 – Post Date

Optional

DATE

Defaults to effective date if not supplied.

15 – Long Short Indicator
 

Optional

CHAR

L or S. Defaults to L if not supplied.

1432 – Xreference Type

Optional

CHAR (30)


14 – Xref ID

Required

CHAR (100)

Exact match lookup against xreference table.

1077 – Calculate Tax and Base Amounts Switch

Optional

CHAR

If set to CALCULATE, taxes are derived based on the values entered in tags 1295 and 1296, and the Gross Coupon Base is calculated by dividing the Gross Coupon Local by the FX Rates (tag 87). The net amount of the coupon is derived by taking the Gross Amount minus Tax Expense and then subtracting the tax and reclaim amounts. If it is not set to CALCULATE, the Gross and Net, Local, and Base amounts must be passed in on the message.

40 – Shares

Required

NUMBER(38,12)

Quantity held as of the effective date.

1295 – Tax Withholding Rate

Optional

NUMBER (28,12)

Tax withholding percentage as a whole number.

1296 – Tax Reclaim Rate

Optional

NUMBER (28,12)

Tax reclaim percentage as a whole number.

87 – Local to Base FX Rates

Required

DEC


325 – Gross Coupon Local

Required

MONEYL

Gross local amount of coupon, including taxes.

330 – Gross Coupon Base

Conditionally Required

MONEYB

Gross base amount of coupon, including taxes. If tag 1077 is set to CALCULATE, this value is derived. Otherwise, this value must be supplied.

50 – Net Amount Local
 

Conditionally Required
 

MONEYL

Net Amount Local of the Coupon. If tag 1077 is set to CALCULATE_TAX, this value is derived by taking the Gross Coupon Local and subtracting the tax and reclaim amounts. If tag 1077 is not equal to CALCULATE, this value must be supplied.

478 – Base Amount

Conditionally Required

MONEYB

Net Amount Base of the Coupon. If tag 1077 is set to CALCULATE, this value is derived by taking the Gross Coupon Base and subtracting the tax and reclaim amounts.

852 – Reclaim Settle

Optional

MONEYL

Reclaim amount of the coupon in the security's local currency. If tag 1077 is set to CALCULATE, this value is derived. If tag 1077 is not equal to CALCULATE, this must be supplied if applicable.

851 – Reclaim Base

Optional

MONEYB

Reclaim amount of the coupon in the entity's base currency. If tag 1077 is set to CALCULATE, this value is derived. If tag 1077 is not equal to CALCULATE, this must be supplied if applicable.

853 – Tax Expense Local

Optional

MONEYL

Tax expense amount in the security's local currency. If tag 1077 is set to CALCULATE, this value is derived. If tag 1077 is not equal to CALCULATE, this must be supplied if applicable.

854 – Tax Expense Base

Optional

MONEYB

Tax expense amount in the entity's base currency. If tag 1077 is set to CALCULATE, this value is derived. If tag 1077 is not equal to CALCULATE, this must be supplied if applicable.

7250 – Tax Reclaim Offset Days

Optional

INTEGER


245 – Tax Reclaim Settle Date

Optional

DATE

Settlement date of coupon plus Tax Reclaim Offset Days.

56 – Notes

Optional

VARCHAR2(255)


25 – Event ID – Coupon

Optional

VARCHAR2(55)

Event ID of the coupon. STAR creates a unique ID if not supplied.

944 – Update Source

Optional

VARCHAR2 (8)


7000 – Income Statement Posting

Optional

CHAR

Valid values are Y or N. If set to N, postings to income and expense accounts are backed out.

Reclaim

The RECLAIM event is used to send unsettled reclaim transactions and traded rows to STAR as part of the conversion process.

Reclaim Data Table

The following table describes the required and optional data fields for Reclaims.

Tag # – Tag Name

Required/Optional

Date Type

Value/Description of Field

55 – Event Type

Required

CHAR

RECLAIM.

1163 – Entity ID

Required

CHAR (8)

Exact match lookup against RULESENTITY.ENTITY_ID.

3912 – Tax Accounting Method

Optional

VARCHAR2 (10)

Defaults to GL if not supplied.

35 – Effective Date

Required

DATE


36 – Accounting Date

Optional

DATE

Populates through lookup if not supplied.

37 – Settlement Date

Required

DATE


30 – Post Date

Optional – defaults to Ex date if not supplied

DATE


15 – Long Short Indicator

Optional

CHAR

L or S. Defaults to L if not supplied.

1432 – Xreference Type

Optional

CHAR (30)


14 – Xref ID

Required

CHAR (100)

Exact match lookup against xreference table.

1077 – Calculate Base Amount Switch

Optional

CHAR

If set to CALCULATE_BASE, the Net Amount Base is calculated by taking the settlement amount and dividing it by the settle to base FX Rates.

1728 – Corporate Action Type

Optional

VARCHAR2 (50)

Defaults to CASH DIVIDEND if not supplied.

40 – Shares

Required

NUMBER(38,12)

Quantity held as of the effective date.

1295 – Tax Withholding Rate

Optional

NUMBER (28,12)

Tax withholding percentage as a whole number.

1296 – Tax Reclaim Rate

Optional

NUMBER (28,12)

Tax reclaim percentage as a whole number.

87 – Settle to Base FX Rates

Required

DEC


50 – Net Amount Settle

Required

MONEYL

Net settlement amount of the reclaim. Typically equal to the local amount in situations where Asset Currency = Settlement Currency.

478 – Net Amount Base

Conditionally Required

MONEYB

Net base amount of the reclaim. If tag 1077 = CALCULATE_BASE, this value is derived by dividing the settlement amount by the settle to base FX Rates.

853 – Tax Expense Settle

Optional

MONEYL

Tax expense amount in the settlement currency of the dividend.

854 – Tax Expense Base

Optional

MONEYB

Tax expense amount in the entity's base currency.

85 – Settlement Currency

Conditionally Required – required for dividends where the asset currency does not equal the settlement currency of the dividend.

CHAR (30)

Must contain the settlement currency.

5363 – Local Amount

Conditionally Required

MONEYL

If the asset currency does not equal the settlement currency, this tag must contain the reclaim amount in the asset (local) currency.

56 – Notes

Optional

VARCHAR2(255)


25 – Event ID

Optional – STAR creates a unique ID if not supplied

VARCHAR2(55)

Event ID of the reclaim.

944 – Update Source

Optional

VARCHAR2 (8)


7000 – Income Statement Posting

Optional
 

CHAR

Valid values are Y or N. If set to N, postings to income and expense accounts are backed out.

  • No labels