v5.0.0

DividendDistribution

Represents a Corporate Action via which a Security Token issuer wishes to distribute dividends between a subset of the Tokenholders (targets)

Hierarchy

↳ CorporateAction

↳ DividendDistribution

Index

Properties

Methods

Properties

claim

• claim: ProcedureMethod‹void, void›

Defined in src/api/entities/DividendDistribution/index.ts:154

Claim the dividends corresponding to the current Identity

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

currency

• currency: string

Defined in src/api/entities/DividendDistribution/index.ts:70

ticker of the currency in which dividends are being distibuted

declarationDate

• declarationDate: Date

Inherited from CorporateAction.declarationDate

Defined in src/api/entities/CorporateAction/index.ts:70

date at which the Corporate Action was created

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

Inherited from CorporateAction.defaultTaxWithholding

Defined in src/api/entities/CorporateAction/index.ts:86

default percentage of tax withholding for this Corporate Action

description

• description: string

Inherited from CorporateAction.description

Defined in src/api/entities/CorporateAction/index.ts:75

brief text description of the Corporate Action

expiryDate

• expiryDate: null | Date

Defined in src/api/entities/DividendDistribution/index.ts:86

date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires

id

• id: BigNumber

Inherited from CorporateAction.id

Defined in src/api/entities/CorporateAction/index.ts:60

internal Corporate Action ID

Protected kind

• kind: UnpredictableBenefit

Overrides CorporateAction.kind

Defined in src/api/entities/DividendDistribution/index.ts:93

linkDocuments

• linkDocuments: ProcedureMethod‹LinkCaDocsParams, void›

Inherited from CorporateAction.linkDocuments

Defined in src/api/entities/CorporateAction/index.ts:148

Link a list of documents to this corporate action

param list of documents

note any previous links are removed in favor of the new list

note required role:

  • Corporate Actions Agent

maxAmount

• maxAmount: BigNumber

Defined in src/api/entities/DividendDistribution/index.ts:81

maximum amount of currency to be distributed. Distributions are "first come, first served", so funds can be depleted before every Tokenholder receives their corresponding amount

modifyCheckpoint

• modifyCheckpoint: ProcedureMethod‹ModifyDistributionCheckpointParams, void›

Overrides CorporateAction.modifyCheckpoint

Defined in src/api/entities/DividendDistribution/index.ts:159

Modify the Distribution's checkpoint

origin

• origin: DefaultPortfolio | NumberedPortfolio

Defined in src/api/entities/DividendDistribution/index.ts:65

Portfolio from which the dividends will be distributed

pay

• pay: ProcedureMethod‹PayDividendsParams, void›

Defined in src/api/entities/DividendDistribution/index.ts:164

Transfer the corresponding share of the dividends to a list of Identities

paymentDate

• paymentDate: Date

Defined in src/api/entities/DividendDistribution/index.ts:91

date starting from which dividends can be paid/reclaimed

perShare

• perShare: BigNumber

Defined in src/api/entities/DividendDistribution/index.ts:75

amount of currency to pay for each share the Tokenholder holds

reclaimFunds

• reclaimFunds: ProcedureMethod‹void, void›

Defined in src/api/entities/DividendDistribution/index.ts:174

Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired

note withheld taxes are also reclaimed in the same transaction

note required roles:

  • Origin Portfolio Custodian

targets

• targets: CorporateActionTargets

Inherited from CorporateAction.targets

Defined in src/api/entities/CorporateAction/index.ts:81

tokenholder identities related to this Corporate action. If the treatment is Exclude, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

taxWithholdings

• taxWithholdings: TaxWithholding[]

Inherited from CorporateAction.taxWithholdings

Defined in src/api/entities/CorporateAction/index.ts:92

percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

ticker

• ticker: string

Inherited from CorporateAction.ticker

Defined in src/api/entities/CorporateAction/index.ts:65

ticker of the Security Token

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

checkpoint

▸ checkpoint(): Promise‹Checkpoint | CheckpointSchedule›

Overrides CorporateAction.checkpoint

Defined in src/api/entities/DividendDistribution/index.ts:180

Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead

Returns: Promise‹Checkpoint | CheckpointSchedule›

details

▸ details(): Promise‹DividendDistributionDetails›

Defined in src/api/entities/DividendDistribution/index.ts:199

Retrieve details associated with this Dividend Distribution

Returns: Promise‹DividendDistributionDetails›

exists

▸ exists(): Promise‹boolean›

Overrides CorporateAction.exists

Defined in src/api/entities/DividendDistribution/index.ts:190

Retrieve whether the Distribution exists

Returns: Promise‹boolean›

getParticipants

▸ getParticipants(): Promise‹DistributionParticipant[]›

Defined in src/api/entities/DividendDistribution/index.ts:225

Retrieve a comprehensive list of all Identities that are entitled to dividends in this Distribution (participants), the amount they are entitled to and whether they have been paid or not

note this request can take a lot of time with large amounts of Tokenholders

note if the Distribution Checkpoint hasn't been created yet, the result will be an empty array. This is because the Distribution participants cannot be determined without a Checkpoint

Returns: Promise‹DistributionParticipant[]›

getWithheldTax

▸ getWithheldTax(): Promise‹BigNumber›

Defined in src/api/entities/DividendDistribution/index.ts:292

Retrieve the amount of taxes that have been withheld up to this point in this Distribution

note uses the middleware

Returns: Promise‹BigNumber›

isEqual

▸ isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Returns: boolean

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers: object

Parameters:

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers: object

Parameters:

Returns: Identifiers

PreviousDistributionsNextDocuments

Last updated