-
Notifications
You must be signed in to change notification settings - Fork 11
api.procedures.types.ConfigureDividendDistributionParams
api/procedures/types.ConfigureDividendDistributionParams
- checkpoint
- currency
- declarationDate
- defaultTaxWithholding
- description
- expiryDate
- maxAmount
- originPortfolio
- paymentDate
- perShare
- targets
- taxWithholdings
• checkpoint: InputCaCheckpoint
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
• currency: string
ticker of the currency in which Dividends will be distributed
• Optional declarationDate: Date
date at which the issuer publicly declared the Dividend Distribution. Optional, defaults to the current date
• Optional defaultTaxWithholding: BigNumber
default percentage (0-100) of the Benefits to be held for tax purposes
• description: string
• Optional expiryDate: Date
optional, defaults to never expiring
• maxAmount: BigNumber
maximum amount of currency to distribute in total
• Optional originPortfolio: BigNumber | NumberedPortfolio
portfolio from which the Dividends will be distributed. Optional, defaults to the Dividend Distributions Agent's Default Portfolio
• paymentDate: Date
date from which Asset Holders can claim their Dividends
• perShare: BigNumber
amount of currency to distribute per each share of the Asset that a target holds
• Optional targets: InputCorporateActionTargets
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
• Optional taxWithholdings: InputCorporateActionTaxWithholdings
percentage (0-100) of the Benefits to be held for tax purposes from individual Asset Holder Identities.
This overrides the value of defaultTaxWithholding
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