DividendDistribution
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a Corporate Action via which a Security Token issuer wishes to distribute dividends between a subset of the Tokenholders (targets)
↳
↳ DividendDistribution
Protected context• currency: string
ticker of the currency in which dividends are being distibuted
• declarationDate: Date
date at which the Corporate Action was created
• defaultTaxWithholding: BigNumber
default percentage of tax withholding for this Corporate Action
• description: string
brief text description of the Corporate Action
• expiryDate: null | Date
date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires
• id: BigNumber
internal Corporate Action ID
Protected kind• maxAmount: BigNumber
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
Portfolio from which the dividends will be distributed
• paymentDate: Date
date starting from which dividends can be paid/reclaimed
• perShare: BigNumber
amount of currency to pay for each share the Tokenholder holds
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
percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
• ticker: string
ticker of the Security Token
• uuid: string
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
Claim the dividends corresponding to the current Identity
Parameters:
Name
Type
args
void
opts?
Retrieve details associated with this Dividend Distribution
▸ exists(): Promise‹boolean›
Retrieve whether the Distribution exists
Returns: Promise‹boolean›
Retrieve an Identity that is entitled to dividends in this Distribution (participant), the amount it is entitled to and whether it has been paid or not
note if the Distribution Checkpoint hasn't been created yet, the result will be null. This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint
Parameters:
Name
Type
args?
undefined | object
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
Retrieve the payment history for this Distribution
note uses the middleware
note supports pagination
Parameters:
â–ªDefault value opts: object= {}
Name
Type
size?
undefined | number
start?
undefined | number
▸ getWithheldTax(): Promise‹BigNumber›
Retrieve the amount of taxes that have been withheld up to this point in this Distribution
note uses the middleware
Returns: Promise‹BigNumber›
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
Link a list of documents to this corporate action
note any previous links are removed in favor of the new list
Parameters:
Name
Type
args
opts?
Modify the Distribution's checkpoint
Parameters:
Name
Type
args
ModifyDistributionCheckpointParams
opts?
Transfer the corresponding share of the dividends to a list of Identities
note due to performance issues, we do not validate that the distribution has enough remaining funds to pay the corresponding amount to the supplied Identities
Parameters:
Name
Type
args
opts?
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
Parameters:
Name
Type
args
void
opts?
Return the Dividend Distribution's static data
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
• context:
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
• kind:
Overrides .
Defined in
Defined in
• origin: |
Defined in
Defined in
Defined in
• targets:
Inherited from .
Defined in
• taxWithholdings: []
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ checkpoint(): Promise‹ | ›
Overrides .
Defined in
Returns: Promise‹ | ›
▸ claim(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call claim.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
Overrides .
Defined in
▸ getParticipant(args?: undefined | object): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
▸ getParticipants(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getPaymentHistory(opts: object): Promise‹‹››
Defined in
Returns: Promise‹‹››
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
▸ linkDocuments(args: , opts?: ): Promise‹‹void››
Inherited from .
Defined in
note this method is of type , which means you can call linkDocuments.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ modifyCheckpoint(args: ModifyDistributionCheckpointParams, opts?: ): Promise‹‹void››
Overrides .
Defined in
note this method is of type , which means you can call modifyCheckpoint.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ pay(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call pay.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ reclaimFunds(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call reclaimFunds.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
â–¸ toJson():
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in