BaseDividend

Internal representation of a Dividend Distribution

Hierarchy

• BaseDividend

Index

Properties

• amount

• checkpointId

• claimedAmount

• created

• currency

• expiry

• index

• maturity

• name

• reclaimed

• tokenholders

• totalSupply

• totalWithheld

• totalWithheldWithdrawn

Properties

amount

• amount: BigNumber

Defined in src/PolymathBase.ts:301

amount of tokens provided in the Dividend

checkpointId

• checkpointId: number

Defined in src/PolymathBase.ts:285

checkpoint UUID to which this Dividend Distribution is associated

claimedAmount

• claimedAmount: BigNumber

Defined in src/PolymathBase.ts:305

amount of tokens paid so far

created

• created: Date

Defined in src/PolymathBase.ts:289

date at which the Dividend was created

currency

• currency: string | null

Defined in src/PolymathBase.ts:329

symbol of the currency in which Dividends are being distributed

expiry

• expiry: Date

Defined in src/PolymathBase.ts:297

date at which the Dividend will expire

index

• index: number

Defined in src/PolymathBase.ts:281

index of the dividend

maturity

• maturity: Date

Defined in src/PolymathBase.ts:293

date from which payments can be distributed

name

• name: string

Defined in src/PolymathBase.ts:325

name of the Dividend

reclaimed

• reclaimed: boolean

Defined in src/PolymathBase.ts:313

whether expired payments have been reclaimed

tokenholders

• tokenholders: DividendTokenholderStatus[]

Defined in src/PolymathBase.ts:333

dividend Tokenholders

totalSupply

• totalSupply: BigNumber

Defined in src/PolymathBase.ts:309

total supply of the Security Token

totalWithheld

• totalWithheld: BigNumber

Defined in src/PolymathBase.ts:317

total amount of tokens withheld as tax so far

totalWithheldWithdrawn

• totalWithheldWithdrawn: BigNumber

Defined in src/PolymathBase.ts:321

total amount of withheld taxes already withdrawn from the storage wallet