api.procedures.configureDividendDistribution.ConfigureDividendDistributionParams

Interface: ConfigureDividendDistributionParams

api/procedures/configureDividendDistribution.ConfigureDividendDistributionParams

Table of contents

Properties

• checkpoint
• currency
• declarationDate
• defaultTaxWithholding
• description
• expiryDate
• maxAmount
• originPortfolio
• paymentDate
• perShare
• targets
• taxWithholdings

Properties

checkpoint

• checkpoint: InputCaCheckpoint

checkpoint to be used to calculate Dividends. If a Schedule is passed, the next Checkpoint it creates will be used. If a Date is passed, a Checkpoint will be created at that date and used

Defined in

api/procedures/configureDividendDistribution.ts:93

---

currency

• currency: string

ticker of the currency in which Dividends will be distributed

Defined in

api/procedures/configureDividendDistribution.ts:101

---

declarationDate

• Optional declarationDate: Date

date at which the issuer publicly declared the Dividend Distribution. Optional, defaults to the current date

Defined in

api/procedures/configureDividendDistribution.ts:72

---

defaultTaxWithholding

• Optional defaultTaxWithholding: BigNumber

default percentage (0-100) of the Benefits to be held for tax purposes

Defined in

api/procedures/configureDividendDistribution.ts:83

---

description

• description: string

Defined in

api/procedures/configureDividendDistribution.ts:73

---

expiryDate

• Optional expiryDate: Date

optional, defaults to never expiring

Defined in

api/procedures/configureDividendDistribution.ts:117

---

maxAmount

• maxAmount: BigNumber

maximum amount of currency to distribute in total

Defined in

api/procedures/configureDividendDistribution.ts:109

---

originPortfolio

• Optional originPortfolio: BigNumber | NumberedPortfolio

portfolio from which the Dividends will be distributed. Optional, defaults to the Dividend Distributions Agent's Default Portfolio

Defined in

api/procedures/configureDividendDistribution.ts:97

---

paymentDate

• paymentDate: Date

date from which Asset Holders can claim their Dividends

Defined in

api/procedures/configureDividendDistribution.ts:113

---

perShare

• perShare: BigNumber

amount of currency to distribute per each share of the Asset that a target holds

Defined in

api/procedures/configureDividendDistribution.ts:105

---

targets

• Optional targets: InputCorporateActionTargets

Asset Holder Identities to be included (or excluded) from the Dividend Distribution. Inclusion/exclusion is controlled by the treatment property. When the value is Include, all Asset Holders not present in the array are excluded, and vice-versa. If no value is passed, the default value for the Asset is used. If there is no default value, all Asset Holders will be part of the Dividend Distribution

Defined in

api/procedures/configureDividendDistribution.ts:79

---

taxWithholdings

• Optional taxWithholdings: InputCorporateActionTaxWithholdings

percentage (0-100) of the Benefits to be held for tax purposes from individual Asset Holder Identities. This overrides the value of defaultTaxWithholding

Defined in

api/procedures/configureDividendDistribution.ts:88