api_procedures_configureDividendDistribution.ConfigureDividendDistributionParams
Previousapi_procedures_claimClassicTicker.ClaimClassicTickerParamsNextapi_procedures_consumeAuthorizationRequests.ConsumeParams
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / ConfigureDividendDistributionParams
.ConfigureDividendDistributionParams
checkpoint to be used to calculate Dividends. If a Schedule is passed, the next Checkpoint it creates will be used. If a Date is passed, a Checkpoint will be created at that date and used
Defined in
• currency: string
ticker of the currency in which Dividends will be distributed
Defined in
• Optional declarationDate: Date
date at which the issuer publicly declared the Dividend Distribution. Optional, defaults to the current date
Defined in
• Optional defaultTaxWithholding: BigNumber
default percentage (0-100) of the Benefits to be held for tax purposes
Defined in
• description: string
Defined in
• Optional expiryDate: Date
optional, defaults to never expiring
Defined in
• maxAmount: BigNumber
maximum amount of currency to distribute in total
Defined in
portfolio from which the Dividends will be distributed. Optional, defaults to the Dividend Distributions Agent's Default Portfolio
Defined in
• paymentDate: Date
date from which Asset Holders can claim their Dividends
Defined in
• perShare: BigNumber
amount of currency to distribute per each share of the Asset that a target holds
Defined in
Asset Holder Identities to be included (or excluded) from the Dividend Distribution. Inclusion/exclusion is controlled by the treatment property. When the value is Include, all Asset Holders not present in the array are excluded, and vice-versa. If no value is passed, the default value for the Asset is used. If there is no default value, all Asset Holders will be part of the Dividend Distribution
Defined in
percentage (0-100) of the Benefits to be held for tax purposes from individual Asset Holder Identities. This overrides the value of defaultTaxWithholding
Defined in
• checkpoint:
• Optional originPortfolio: BigNumber |
• Optional targets:
• Optional taxWithholdings: