BaseDividend
Last updated
Was this helpful?
Last updated
Was this helpful?
Internal representation of a Dividend Distribution
BaseDividend
• amount: BigNumber
amount of tokens provided in the Dividend
• checkpointId: number
checkpoint UUID to which this Dividend Distribution is associated
• claimedAmount: BigNumber
amount of tokens paid so far
• created: Date
date at which the Dividend was created
• currency: string | null
symbol of the currency in which Dividends are being distributed
• expiry: Date
date at which the Dividend will expire
• index: number
index of the dividend
• maturity: Date
date from which payments can be distributed
• name: string
name of the Dividend
• reclaimed: boolean
whether expired payments have been reclaimed
dividend Tokenholders
• totalSupply: BigNumber
total supply of the Security Token
• totalWithheld: BigNumber
total amount of tokens withheld as tax so far
• totalWithheldWithdrawn: BigNumber
total amount of withheld taxes already withdrawn from the storage wallet
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• tokenholders: []
Defined in
Defined in
Defined in
Defined in