-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.DividendDistribution.DividendDistribution
api/entities/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
- currency
- declarationDate
- defaultTaxWithholding
- description
- expiryDate
- id
- maxAmount
- origin
- paymentDate
- perShare
- targets
- taxWithholdings
- uuid
- checkpoint
- claim
- details
- exists
- getParticipant
- getParticipants
- getPaymentHistory
- getWithheldTax
- isEqual
- linkDocuments
- modifyCheckpoint
- pay
- reclaimFunds
- toHuman
- generateUuid
- unserialize
• asset: FungibleAsset
Asset affected by this Corporate Action
api/entities/CorporateActionBase/index.ts:80
• currency: string
Asset ID of the currency in which dividends are being distributed
api/entities/DividendDistribution/index.ts:98
• declarationDate: Date
date at which the Corporate Action was created
CorporateActionBase.declarationDate
api/entities/CorporateActionBase/index.ts:85
• defaultTaxWithholding: BigNumber
default percentage (0-100) of tax withholding for this Corporate Action
CorporateActionBase.defaultTaxWithholding
api/entities/CorporateActionBase/index.ts:101
• description: string
brief text description of the Corporate Action
CorporateActionBase.description
api/entities/CorporateActionBase/index.ts:90
• expiryDate: null | Date
date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires
api/entities/DividendDistribution/index.ts:114
• id: BigNumber
internal Corporate Action ID
api/entities/CorporateActionBase/index.ts:75
• 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
api/entities/DividendDistribution/index.ts:109
• origin: NumberedPortfolio | DefaultPortfolio
Portfolio from which the dividends will be distributed
api/entities/DividendDistribution/index.ts:93
• paymentDate: Date
date starting from which dividends can be paid/reclaimed
api/entities/DividendDistribution/index.ts:119
• perShare: BigNumber
amount of currency to pay for each share held by the Asset Holders
api/entities/DividendDistribution/index.ts:103
• targets: CorporateActionTargets
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
api/entities/CorporateActionBase/index.ts:96
• taxWithholdings: TaxWithholding[]
percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
CorporateActionBase.taxWithholdings
api/entities/CorporateActionBase/index.ts:107
• uuid: string
▸ checkpoint(): Promise<CheckpointSchedule | Checkpoint>
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
Promise<CheckpointSchedule | Checkpoint>
CorporateActionBase.checkpoint
api/entities/DividendDistribution/index.ts:253
▸ claim(opts?): Promise<GenericPolymeshTransaction<void, void>>
Claim the Dividends corresponding to the signing Identity
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
if currency is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)
Note
this method is of type NoArgsProcedureMethod, which means you can call claim.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
api/entities/DividendDistribution/index.ts:202
▸ details(): Promise<DividendDistributionDetails>
Retrieve details associated with this Dividend Distribution
Promise<DividendDistributionDetails>
api/entities/DividendDistribution/index.ts:281
▸ exists(): Promise<boolean>
Retrieve whether the Distribution exists
Promise<boolean>
api/entities/DividendDistribution/index.ts:272
▸ getParticipant(args?): Promise<null | DistributionParticipant>
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
| Name | Type | Description |
|---|---|---|
args? |
Object |
- |
args.identity |
string | Identity
|
defaults to the signing Identity |
Promise<null | DistributionParticipant>
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
api/entities/DividendDistribution/index.ts:362
▸ getParticipants(): Promise<DistributionParticipant[]>
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
Promise<DistributionParticipant[]>
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
api/entities/DividendDistribution/index.ts:307
▸ getPaymentHistory(opts?): Promise<ResultSet<DistributionPayment>>
Retrieve the payment history for this Distribution
| Name | Type |
|---|---|
opts |
Object |
opts.size? |
BigNumber |
opts.start? |
BigNumber |
Promise<ResultSet<DistributionPayment>>
Note
uses the middleware V2
Note
supports pagination
api/entities/DividendDistribution/index.ts:501
▸ getWithheldTax(): Promise<BigNumber>
Retrieve the amount of taxes that have been withheld up to this point in this Distribution
Promise<BigNumber>
Note
uses the middlewareV2
api/entities/DividendDistribution/index.ts:460
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ linkDocuments(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Link a list of documents to this corporate action
| Name | Type |
|---|---|
args |
LinkCaDocsParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
any previous links are removed in favor of the new list
Note
this method is of type ProcedureMethod, which means you can call linkDocuments.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
CorporateActionBase.linkDocuments
api/entities/CorporateActionBase/index.ts:160
▸ modifyCheckpoint(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Modify the Distribution's Checkpoint
| Name | Type |
|---|---|
args |
Modify<ModifyCaCheckpointParams, { checkpoint: InputCaCheckpoint }> |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call modifyCheckpoint.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
CorporateActionBase.modifyCheckpoint
api/entities/DividendDistribution/index.ts:212
▸ pay(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Transfer the corresponding share of the dividends to a list of Identities
| Name | Type |
|---|---|
args |
PayDividendsParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
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)
Note
this method is of type ProcedureMethod, which means you can call pay.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
api/entities/DividendDistribution/index.ts:230
▸ reclaimFunds(opts?): Promise<GenericPolymeshTransaction<void, void>>
Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<void, void>>
Note
withheld taxes are also reclaimed in the same transaction
Note
required roles:
- Origin Portfolio Custodian
Note
this method is of type NoArgsProcedureMethod, which means you can call reclaimFunds.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
api/entities/DividendDistribution/index.ts:245
▸ toHuman(): HumanReadable
Return the Dividend Distribution's static data
api/entities/DividendDistribution/index.ts:616
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
CorporateActionBase.generateUuid
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types