Interface: ConfigureDividendDistributionParams

Defined in: src/api/procedures/types.ts:1328

Properties

checkpoint

checkpoint: InputCaCheckpoint

Defined in: src/api/procedures/types.ts:1353

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

---

currency

currency: string

Defined in: src/api/procedures/types.ts:1361

ticker of the currency in which Dividends will be distributed

---

declarationDate?

optional declarationDate: Date

Defined in: src/api/procedures/types.ts:1332

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

---

defaultTaxWithholding?

optional defaultTaxWithholding: BigNumber

Defined in: src/api/procedures/types.ts:1343

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

---

description

description: string

Defined in: src/api/procedures/types.ts:1333

---

expiryDate?

optional expiryDate: Date

Defined in: src/api/procedures/types.ts:1377

optional, defaults to never expiring

---

maxAmount

maxAmount: BigNumber

Defined in: src/api/procedures/types.ts:1369

maximum amount of currency to distribute in total

---

originPortfolio?

optional originPortfolio: BigNumber | NumberedPortfolio

Defined in: src/api/procedures/types.ts:1357

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

---

paymentDate

paymentDate: Date

Defined in: src/api/procedures/types.ts:1373

date from which Asset Holders can claim their Dividends

---

perShare

perShare: BigNumber

Defined in: src/api/procedures/types.ts:1365

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

---

targets?

optional targets: InputCorporateActionTargets

Defined in: src/api/procedures/types.ts:1339

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

---

taxWithholdings?

optional taxWithholdings: InputCorporateActionTaxWithholdings

Defined in: src/api/procedures/types.ts:1348

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