api_entities_DividendDistribution.DividendDistribution
Previousapi_entities_DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuerNextapi_entities_Entity.Entity
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / DividendDistribution
.DividendDistribution
Represents a Corporate Action via which an Asset issuer wishes to distribute dividends between a subset of the Asset Holders (targets)
↳ DividendDistribution
Asset affected by this Corporate Action
Inherited from
Defined in
• currency: string
ticker of the currency in which dividends are being distributed
Defined in
• declarationDate: Date
date at which the Corporate Action was created
Inherited from
Defined in
• defaultTaxWithholding: BigNumber
default percentage (0-100) of tax withholding for this Corporate Action
Inherited from
Defined in
• description: string
brief text description of the Corporate Action
Inherited from
Defined in
• expiryDate: null | Date
date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires
Defined in
• id: BigNumber
internal Corporate Action ID
Inherited from
Defined in
• maxAmount: BigNumber
maximum amount of currency to be distributed. Distributions are "first come, first served", so funds can be depleted before every Asset Holder receives their corresponding amount
Defined in
Portfolio from which the dividends will be distributed
Defined in
• paymentDate: Date
date starting from which dividends can be paid/reclaimed
Defined in
• perShare: BigNumber
amount of currency to pay for each share held by the Asset Holders
Defined in
Asset Holder Identities related to this Corporate action. If the treatment is Exclude, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa
Inherited from
Defined in
percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
Inherited from
Defined in
• uuid: string
Inherited from
Defined in
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
Overrides
Defined in
â–¸ claim(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Claim the Dividends corresponding to the signing Identity
note if currency is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Retrieve details associated with this Dividend Distribution
Returns
Defined in
â–¸ exists(): Promise<boolean>
Retrieve whether the Distribution exists
Returns
Promise<boolean>
Overrides
Defined in
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
args?
Object
-
args.identity
defaults to the signing Identity
Returns
Defined in
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 Asset Holders
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
Defined in
Retrieve the payment history for this Distribution
note uses the middleware
note supports pagination
Parameters
opts
Object
opts.size?
BigNumber
opts.start?
BigNumber
Returns
Defined in
â–¸ 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>
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ linkDocuments(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Link a list of documents to this corporate action
note any previous links are removed in favor of the new list
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Inherited from
Defined in
â–¸ modifyCheckpoint(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify the Distribution's Checkpoint
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Overrides
Defined in
â–¸ pay(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
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
note if currency is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ reclaimFunds(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
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
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ toHuman(): HumanReadable
Return the Dividend Distribution's static data
Returns
HumanReadable
Overrides
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• asset:
.
.
.
.
.
• origin: |
• targets:
.
• taxWithholdings: []
.
.
â–¸ checkpoint(): Promise< | >
Promise< | >
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
â–¸ details(): Promise<>
Promise<>
.
â–¸ getParticipant(args?): Promise<null | >
string |
Promise<null | >
â–¸ getParticipants(): Promise<[]>
Promise<[]>
â–¸ getPaymentHistory(opts?): Promise<<>>
Promise<<>>
<unknown, unknown>
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
<ModifyCaCheckpointParams, { checkpoint: }>
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
.
.
.