Polymesh SDK API Reference
alpha
alpha
  • README
  • modules
  • @polymathnetwork/polymesh-sdk
    • api_client_AccountManagement.AccountManagement
    • api_client_Assets.Assets
    • api_client_Claims.Claims
    • api_client_Identities.Identities
    • api_client_Network.Network
    • api_client_Polymesh.Polymesh
    • api_client_Settlements.Settlements
    • api_entities_Account.Account
    • api_entities_Asset.Asset
    • api_entities_Asset_AssetHolders.AssetHolders
    • api_entities_Asset_Checkpoints.Checkpoints
    • api_entities_Asset_Checkpoints_Schedules.Schedules
    • api_entities_Asset_Compliance.Compliance
    • api_entities_Asset_Compliance_Requirements.Requirements
    • api_entities_Asset_Compliance_TrustedClaimIssuers.TrustedClaimIssuers
    • api_entities_Asset_CorporateActions.CorporateActions
    • api_entities_Asset_CorporateActions_Distributions.Distributions
    • api_entities_Asset_Documents.Documents
    • api_entities_Asset_Issuance.Issuance
    • api_entities_Asset_Offerings.Offerings
    • api_entities_Asset_Permissions.Permissions
    • api_entities_Asset_Settlements.Settlements
    • api_entities_Asset_TransferRestrictions.TransferRestrictions
    • api_entities_Asset_TransferRestrictions_Count.Count
    • api_entities_Asset_TransferRestrictions_Percentage.Percentage
    • api_entities_Asset_TransferRestrictions_TransferRestrictionBase.TransferRestrictionBase
    • api_entities_AuthorizationRequest.AuthorizationRequest
    • api_entities_Checkpoint.Checkpoint
    • api_entities_CheckpointSchedule.CheckpointSchedule
    • api_entities_CorporateAction.CorporateAction
    • api_entities_CorporateActionBase.CorporateActionBase
    • api_entities_CustomPermissionGroup.CustomPermissionGroup
    • api_entities_DefaultPortfolio.DefaultPortfolio
    • api_entities_DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuer
    • api_entities_DividendDistribution.DividendDistribution
    • api_entities_Entity.Entity
    • api_entities_Identity.Identity
    • api_entities_Identity_AssetPermissions.AssetPermissions
    • api_entities_Identity_IdentityAuthorizations.IdentityAuthorizations
    • api_entities_Identity_Portfolios.Portfolios
    • api_entities_Instruction.Instruction
    • api_entities_KnownPermissionGroup.KnownPermissionGroup
    • api_entities_NumberedPortfolio.NumberedPortfolio
    • api_entities_Offering.Offering
    • api_entities_PermissionGroup.PermissionGroup
    • api_entities_Portfolio.Portfolio
    • api_entities_Subsidy.Subsidy
    • api_entities_TickerReservation.TickerReservation
    • api_entities_Venue.Venue
    • api_entities_common_namespaces_Authorizations.Authorizations
  • enums
    • api_entities_Asset_Checkpoints_types.CaCheckpointType
    • api_entities_CorporateActionBase_types.CorporateActionKind
    • api_entities_CorporateActionBase_types.TargetTreatment
    • api_entities_Instruction_types.AffirmationStatus
    • api_entities_Instruction_types.InstructionStatus
    • api_entities_Instruction_types.InstructionType
    • api_entities_Offering_types.OfferingBalanceStatus
    • api_entities_Offering_types.OfferingSaleStatus
    • api_entities_Offering_types.OfferingTimingStatus
    • api_entities_TickerReservation_types.TickerReservationStatus
    • api_entities_Venue_types.VenueType
    • types.AuthorizationType
    • types.CalendarUnit
    • types.ClaimType
    • types.ConditionTarget
    • types.ConditionType
    • types.ErrorCode
    • types.KnownAssetType
    • types.PayingAccountType
    • types.PermissionGroupType
    • types.PermissionType
    • types.RoleType
    • types.ScopeType
    • types.SecurityIdentifierType
    • types.SignerType
    • types.TransactionArgumentType
    • types.TransactionQueueStatus
    • types.TransactionStatus
    • types.TransferError
    • types.TransferRestrictionType
    • types.TransferStatus
    • types.TxGroup
  • interfaces
    • api_entities_Account.UniqueIdentifiers
    • api_entities_Asset.UniqueIdentifiers
    • api_entities_Asset_CorporateActions_types.CorporateActionDefaultConfig
    • api_entities_Asset_types.AgentWithGroup
    • api_entities_Asset_types.AssetDetails
    • api_entities_Asset_types.IdentityBalance
    • api_entities_Asset_types.TransferBreakdown
    • api_entities_Asset_types.TransferRestrictionResult
    • api_entities_AuthorizationRequest.Params
    • api_entities_AuthorizationRequest.UniqueIdentifiers
    • api_entities_Checkpoint.UniqueIdentifiers
    • api_entities_CheckpointSchedule.Params
    • api_entities_CheckpointSchedule.UniqueIdentifiers
    • api_entities_CheckpointSchedule_types.ScheduleDetails
    • api_entities_CorporateAction.HumanReadable
    • api_entities_CorporateAction.Params
    • api_entities_CorporateAction.UniqueIdentifiers
    • api_entities_CorporateActionBase.HumanReadable
    • api_entities_CorporateActionBase.Params
    • api_entities_CorporateActionBase.UniqueIdentifiers
    • api_entities_CorporateActionBase_types.CorporateActionTargets
    • api_entities_CorporateActionBase_types.TaxWithholding
    • api_entities_CustomPermissionGroup.HumanReadable
    • api_entities_CustomPermissionGroup.UniqueIdentifiers
    • api_entities_DefaultPortfolio.UniqueIdentifiers
    • api_entities_DefaultTrustedClaimIssuer.UniqueIdentifiers
    • api_entities_DividendDistribution.DividendDistributionParams
    • api_entities_DividendDistribution_types.DistributionParticipant
    • api_entities_DividendDistribution_types.DividendDistributionDetails
    • api_entities_Identity.UniqueIdentifiers
    • api_entities_Instruction.UniqueIdentifiers
    • api_entities_Instruction_types.InstructionAffirmation
    • api_entities_Instruction_types.Leg
    • api_entities_KnownPermissionGroup.HumanReadable
    • api_entities_KnownPermissionGroup.UniqueIdentifiers
    • api_entities_NumberedPortfolio.UniqueIdentifiers
    • api_entities_Offering.UniqueIdentifiers
    • api_entities_Offering_types.Investment
    • api_entities_Offering_types.OfferingDetails
    • api_entities_Offering_types.OfferingStatus
    • api_entities_Offering_types.OfferingTier
    • api_entities_Offering_types.Tier
    • api_entities_PermissionGroup.UniqueIdentifiers
    • api_entities_Portfolio.UniqueIdentifiers
    • api_entities_Portfolio_types.HistoricSettlement
    • api_entities_Portfolio_types.PortfolioBalance
    • api_entities_Portfolio_types.SettlementLeg
    • api_entities_Subsidy.UniqueIdentifiers
    • api_entities_Subsidy_types.SubsidyData
    • api_entities_Subsidy_types.SubsidyWithAllowance
    • api_entities_TickerReservation.UniqueIdentifiers
    • api_entities_TickerReservation_types.TickerReservationDetails
    • api_entities_Venue.UniqueIdentifiers
    • api_entities_Venue_types.VenueDetails
    • api_procedures_addAssetRequirement.AddAssetRequirementParams
    • api_procedures_addInstruction.AddInstructionParams
    • api_procedures_addInstruction.AddInstructionWithVenueIdParams
    • api_procedures_addInstruction.AddInstructionsParams
    • api_procedures_addInvestorUniquenessClaim.AddInvestorUniquenessClaimParams
    • api_procedures_addTransferRestriction.Storage
    • api_procedures_claimClassicTicker.ClaimClassicTickerParams
    • api_procedures_configureDividendDistribution.ConfigureDividendDistributionParams
    • api_procedures_consumeAuthorizationRequests.ConsumeParams
    • api_procedures_consumeJoinOrRotateAuthorization.Storage
    • api_procedures_controllerTransfer.ControllerTransferParams
    • api_procedures_controllerTransfer.Storage
    • api_procedures_createAsset.CreateAssetParams
    • api_procedures_createAsset.CreateAssetWithTickerParams
    • api_procedures_createCheckpointSchedule.CreateCheckpointScheduleParams
    • api_procedures_createGroup.CreateGroupParams
    • api_procedures_createVenue.CreateVenueParams
    • api_procedures_deletePortfolio.DeletePortfolioParams
    • api_procedures_investInOffering.InvestInOfferingParams
    • api_procedures_inviteAccount.InviteAccountParams
    • api_procedures_inviteExternalAgent.InviteExternalAgentParams
    • api_procedures_issueTokens.IssueTokensParams
    • api_procedures_issueTokens.Storage
    • api_procedures_linkCaDocs.LinkCaDocsParams
    • api_procedures_modifyAllowance.DecreaseAllowanceParams
    • api_procedures_modifyAllowance.IncreaseAllowanceParams
    • api_procedures_modifyAllowance.SetAllowanceParams
    • api_procedures_modifyAssetTrustedClaimIssuers.ModifyAssetTrustedClaimIssuersAddSetParams
    • api_procedures_modifyAssetTrustedClaimIssuers.ModifyAssetTrustedClaimIssuersRemoveParams
    • api_procedures_modifyCorporateActionsAgent.ModifyCorporateActionsAgentParams
    • api_procedures_modifyInstructionAffirmation.AffirmInstructionParams
    • api_procedures_modifyInstructionAffirmation.ModifyInstructionAffirmationParams
    • api_procedures_modifyInstructionAffirmation.Storage
    • api_procedures_modifyPrimaryIssuanceAgent.ModifyPrimaryIssuanceAgentParams
    • api_procedures_modifySignerPermissions.ModifySignerPermissionsParams
    • api_procedures_moveFunds.MoveFundsParams
    • api_procedures_payDividends.PayDividendsParams
    • api_procedures_quitCustody.Storage
    • api_procedures_quitSubsidy.QuitSubsidyParams
    • api_procedures_redeemTokens.RedeemTokensParams
    • api_procedures_registerIdentity.RegisterIdentityParams
    • api_procedures_removeAssetRequirement.RemoveAssetRequirementParams
    • api_procedures_removeCheckpointSchedule.RemoveCheckpointScheduleParams
    • api_procedures_removeCorporateAction.RemoveCorporateActionParams
    • api_procedures_removeExternalAgent.RemoveExternalAgentParams
    • api_procedures_removeSecondaryAccounts.RemoveSecondaryAccountsParams
    • api_procedures_renamePortfolio.RenamePortfolioParams
    • api_procedures_reserveTicker.ReserveTickerParams
    • api_procedures_setAssetDocuments.SetAssetDocumentsParams
    • api_procedures_setAssetDocuments.Storage
    • api_procedures_setAssetRequirements.SetAssetRequirementsParams
    • api_procedures_setCustodian.SetCustodianParams
    • api_procedures_setGroupPermissions.SetGroupPermissionsParams
    • api_procedures_setPermissionGroup.SetPermissionGroupParams
    • api_procedures_setTransferRestrictions.SetCountTransferRestrictionsParams
    • api_procedures_setTransferRestrictions.SetPercentageTransferRestrictionsParams
    • api_procedures_subsidizeAccount.SubsidizeAccountParams
    • api_procedures_toggleFreezeOffering.ToggleFreezeOfferingParams
    • api_procedures_toggleFreezeSecondaryAccounts.ToggleFreezeSecondaryAccountsParams
    • api_procedures_toggleFreezeTransfers.ToggleFreezeTransfersParams
    • api_procedures_togglePauseRequirements.TogglePauseRequirementsParams
    • api_procedures_transferAssetOwnership.TransferAssetOwnershipParams
    • api_procedures_transferPolyx.TransferPolyxParams
    • api_procedures_transferTickerOwnership.TransferTickerOwnershipParams
    • api_procedures_waivePermissions.WaivePermissionsParams
    • types.AccreditedClaim
    • types.ActiveTransferRestrictions
    • types.AffiliateClaim
    • types.ArrayTransactionArgument
    • types.AssetDocument
    • types.AssetWithGroup
    • types.Balance
    • types.BlockedClaim
    • types.BuyLockupClaim
    • types.CalendarPeriod
    • types.CddClaim
    • types.CddProviderRole
    • types.CheckPermissionsResult
    • types.CheckRolesResult
    • types.CheckpointWithData
    • types.ClaimData
    • types.ClaimScope
    • types.ClaimTarget
    • types.ComplexTransactionArgument
    • types.Compliance
    • types.ComplianceRequirements
    • types.ConditionBase
    • types.ConditionCompliance
    • types.CountTransferRestriction
    • types.CountTransferRestrictionInput
    • types.DistributionPayment
    • types.DistributionWithDetails
    • types.EventIdentifier
    • types.ExemptKey
    • types.ExemptedClaim
    • types.ExternalAgentCondition
    • types.ExtrinsicData
    • types.ExtrinsicDataWithFees
    • types.Fees
    • types.FeesBreakdown
    • types.GroupedInstructions
    • types.HistoricAgentOperation
    • types.IdentityCondition
    • types.IdentityRole
    • types.IdentityWithClaims
    • types.InvestorUniquenessClaim
    • types.InvestorUniquenessV2Claim
    • types.JurisdictionClaim
    • types.KycClaim
    • types.MiddlewareConfig
    • types.MultiClaimCondition
    • types.NetworkProperties
    • types.NoArgsProcedureMethod
    • types.NoDataClaim
    • types.NoTypeClaim
    • types.OfferingWithDetails
    • types.PaginationOptions
    • types.PayingAccount
    • types.PercentageTransferRestriction
    • types.PercentageTransferRestrictionInput
    • types.PermissionGroups
    • types.PermissionedAccount
    • types.Permissions
    • types.PlainTransactionArgument
    • types.PortfolioCustodianRole
    • types.PortfolioMovement
    • types.ProcedureAuthorizationStatus
    • types.ProcedureMethod
    • types.ProcedureOpts
    • types.ProtocolFees
    • types.Requirement
    • types.RequirementCompliance
    • types.ResultSet
    • types.ScheduleWithDetails
    • types.Scope
    • types.SectionPermissions
    • types.SecurityIdentifier
    • types.SellLockupClaim
    • types.SignerValue
    • types.SimpleEnumTransactionArgument
    • types.SimplePermissions
    • types.SingleClaimCondition
    • types.ThirdPartyFees
    • types.TickerOwnerRole
    • types.TransactionPermissions
    • types.TransferRestriction
    • types.TrustedClaimIssuer
    • types.VenueOwnerRole
  • modules
    • api_client_AccountManagement
    • api_client_Assets
    • api_client_Claims
    • api_client_Identities
    • api_client_Network
    • api_client_Polymesh
    • api_client_Settlements
    • api_entities_Account
    • api_entities_Asset
    • api_entities_Asset_AssetHolders
    • api_entities_Asset_Checkpoints
    • api_entities_Asset_Checkpoints_Schedules
    • api_entities_Asset_Checkpoints_types
    • api_entities_Asset_Compliance
    • api_entities_Asset_Compliance_Requirements
    • api_entities_Asset_Compliance_TrustedClaimIssuers
    • api_entities_Asset_CorporateActions
    • api_entities_Asset_CorporateActions_Distributions
    • api_entities_Asset_CorporateActions_types
    • api_entities_Asset_Documents
    • api_entities_Asset_Issuance
    • api_entities_Asset_Offerings
    • api_entities_Asset_Permissions
    • api_entities_Asset_Settlements
    • api_entities_Asset_TransferRestrictions
    • api_entities_Asset_TransferRestrictions_Count
    • api_entities_Asset_TransferRestrictions_Percentage
    • api_entities_Asset_TransferRestrictions_TransferRestrictionBase
    • api_entities_Asset_types
    • api_entities_AuthorizationRequest
    • api_entities_Checkpoint
    • api_entities_CheckpointSchedule
    • api_entities_CheckpointSchedule_types
    • api_entities_CorporateAction
    • api_entities_CorporateActionBase
    • api_entities_CorporateActionBase_types
    • api_entities_CustomPermissionGroup
    • api_entities_DefaultPortfolio
    • api_entities_DefaultTrustedClaimIssuer
    • api_entities_DividendDistribution
    • api_entities_DividendDistribution_types
    • api_entities_Entity
    • api_entities_Identity
    • api_entities_Identity_AssetPermissions
    • api_entities_Identity_IdentityAuthorizations
    • api_entities_Identity_Portfolios
    • api_entities_Instruction
    • api_entities_Instruction_types
    • api_entities_KnownPermissionGroup
    • api_entities_Namespace
    • api_entities_NumberedPortfolio
    • api_entities_Offering
    • api_entities_Offering_types
    • api_entities_PermissionGroup
    • api_entities_Portfolio
    • api_entities_Portfolio_types
    • api_entities_Subsidy
    • api_entities_Subsidy_types
    • api_entities_TickerReservation
    • api_entities_TickerReservation_types
    • api_entities_Venue
    • api_entities_Venue_types
    • api_entities_common_namespaces_Authorizations
    • api_procedures_addAssetRequirement
    • api_procedures_addInstruction
    • api_procedures_addInvestorUniquenessClaim
    • api_procedures_addTransferRestriction
    • api_procedures_claimClassicTicker
    • api_procedures_claimDividends
    • api_procedures_closeOffering
    • api_procedures_configureDividendDistribution
    • api_procedures_consumeAddMultiSigSignerAuthorization
    • api_procedures_consumeAuthorizationRequests
    • api_procedures_consumeJoinOrRotateAuthorization
    • api_procedures_controllerTransfer
    • api_procedures_createAsset
    • api_procedures_createCheckpoint
    • api_procedures_createCheckpointSchedule
    • api_procedures_createGroup
    • api_procedures_createPortfolio
    • api_procedures_createVenue
    • api_procedures_deletePortfolio
    • api_procedures_investInOffering
    • api_procedures_inviteAccount
    • api_procedures_inviteExternalAgent
    • api_procedures_issueTokens
    • api_procedures_launchOffering
    • api_procedures_leaveIdentity
    • api_procedures_linkCaDocs
    • api_procedures_modifyAllowance
    • api_procedures_modifyAsset
    • api_procedures_modifyAssetTrustedClaimIssuers
    • api_procedures_modifyCaCheckpoint
    • api_procedures_modifyCaDefaultConfig
    • api_procedures_modifyClaims
    • api_procedures_modifyComplianceRequirement
    • api_procedures_modifyCorporateActionsAgent
    • api_procedures_modifyDistributionCheckpoint
    • api_procedures_modifyInstructionAffirmation
    • api_procedures_modifyOfferingTimes
    • api_procedures_modifyPrimaryIssuanceAgent
    • api_procedures_modifySignerPermissions
    • api_procedures_modifyVenue
    • api_procedures_moveFunds
    • api_procedures_payDividends
    • api_procedures_quitCustody
    • api_procedures_quitSubsidy
    • api_procedures_reclaimDividendDistributionFunds
    • api_procedures_redeemTokens
    • api_procedures_registerIdentity
    • api_procedures_removeAssetRequirement
    • api_procedures_removeCheckpointSchedule
    • api_procedures_removeCorporateAction
    • api_procedures_removeCorporateActionsAgent
    • api_procedures_removeExternalAgent
    • api_procedures_removePrimaryIssuanceAgent
    • api_procedures_removeSecondaryAccounts
    • api_procedures_renamePortfolio
    • api_procedures_rescheduleInstruction
    • api_procedures_reserveTicker
    • api_procedures_setAssetDocuments
    • api_procedures_setAssetRequirements
    • api_procedures_setCustodian
    • api_procedures_setGroupPermissions
    • api_procedures_setPermissionGroup
    • api_procedures_setTransferRestrictions
    • api_procedures_subsidizeAccount
    • api_procedures_toggleFreezeOffering
    • api_procedures_toggleFreezeSecondaryAccounts
    • api_procedures_toggleFreezeTransfers
    • api_procedures_togglePauseRequirements
    • api_procedures_transferAssetOwnership
    • api_procedures_transferPolyx
    • api_procedures_transferTickerOwnership
    • api_procedures_utils
    • api_procedures_waivePermissions
    • types
    • types_utils
Powered by GitBook
On this page
  • Class: DividendDistribution
  • Hierarchy
  • Table of contents
  • Properties
  • Methods

Was this helpful?

  1. @polymathnetwork/polymesh-sdk

api_entities_DividendDistribution.DividendDistribution

Previousapi_entities_DefaultTrustedClaimIssuer.DefaultTrustedClaimIssuerNextapi_entities_Entity.Entity

Last updated 2 years ago

Was this helpful?

/ / / DividendDistribution

Class: DividendDistribution

.DividendDistribution

Represents a Corporate Action via which an Asset issuer wishes to distribute dividends between a subset of the Asset Holders (targets)

Hierarchy

  • ↳ DividendDistribution

Table of contents

Properties

Methods

Properties

asset

Asset affected by this Corporate Action

Inherited from

Defined in


currency

• currency: string

ticker of the currency in which dividends are being distributed

Defined in


declarationDate

• declarationDate: Date

date at which the Corporate Action was created

Inherited from

Defined in


defaultTaxWithholding

• defaultTaxWithholding: BigNumber

default percentage (0-100) of tax withholding for this Corporate Action

Inherited from

Defined in


description

• description: string

brief text description of the Corporate Action

Inherited from

Defined in


expiryDate

• expiryDate: null | Date

date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires

Defined in


id

• id: BigNumber

internal Corporate Action ID

Inherited from

Defined in


maxAmount

• 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


origin

Portfolio from which the dividends will be distributed

Defined in


paymentDate

• paymentDate: Date

date starting from which dividends can be paid/reclaimed

Defined in


perShare

• perShare: BigNumber

amount of currency to pay for each share held by the Asset Holders

Defined in


targets

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


taxWithholdings

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

• uuid: string

Inherited from

Defined in

Methods

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

Returns

Overrides

Defined in


claim

â–¸ 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

Name
Type

opts?

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in


details

Retrieve details associated with this Dividend Distribution

Returns

Defined in


exists

â–¸ exists(): Promise<boolean>

Retrieve whether the Distribution exists

Returns

Promise<boolean>

Overrides

Defined in


getParticipant

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
Description

args?

Object

-

args.identity

defaults to the signing Identity

Returns

Defined in


getParticipants

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


getPaymentHistory

Retrieve the payment history for this Distribution

note uses the middleware

note supports pagination

Parameters

Name
Type

opts

Object

opts.size?

BigNumber

opts.start?

BigNumber

Returns

Defined in


getWithheldTax

â–¸ 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

â–¸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name
Type

entity

Returns

boolean

Inherited from

Defined in


linkDocuments

â–¸ 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

Name
Type

args

opts?

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Inherited from

Defined in


modifyCheckpoint

â–¸ modifyCheckpoint(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>

Modify the Distribution's Checkpoint

Parameters

Name
Type

args

opts?

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Overrides

Defined in


pay

â–¸ 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

Name
Type

args

opts?

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in


reclaimFunds

â–¸ 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

Name
Type

opts?

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in


toHuman

â–¸ toHuman(): HumanReadable

Return the Dividend Distribution's static data

Returns

HumanReadable

Overrides

Defined in


generateUuid

â–¸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name

Identifiers

Parameters

Name
Type

identifiers

Identifiers

Returns

string

Inherited from

Defined in


unserialize

â–¸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name

Identifiers

Parameters

Name
Type
Description

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

.

.

.

Asset
api/entities/CorporateActionBase/index.ts:77
api/entities/DividendDistribution/index.ts:100
api/entities/CorporateActionBase/index.ts:82
api/entities/CorporateActionBase/index.ts:98
api/entities/CorporateActionBase/index.ts:87
api/entities/DividendDistribution/index.ts:116
api/entities/CorporateActionBase/index.ts:72
api/entities/DividendDistribution/index.ts:111
NumberedPortfolio
DefaultPortfolio
api/entities/DividendDistribution/index.ts:95
api/entities/DividendDistribution/index.ts:121
api/entities/DividendDistribution/index.ts:105
CorporateActionTargets
api/entities/CorporateActionBase/index.ts:93
TaxWithholding
api/entities/CorporateActionBase/index.ts:104
api/entities/Entity.ts:46
CheckpointSchedule
Checkpoint
CheckpointSchedule
Checkpoint
api/entities/DividendDistribution/index.ts:246
api/entities/DividendDistribution/index.ts:195
DividendDistributionDetails
DividendDistributionDetails
api/entities/DividendDistribution/index.ts:274
api/entities/DividendDistribution/index.ts:265
DistributionParticipant
DistributionParticipant
api/entities/DividendDistribution/index.ts:355
DistributionParticipant
DistributionParticipant
api/entities/DividendDistribution/index.ts:300
ResultSet
DistributionPayment
ResultSet
DistributionPayment
api/entities/DividendDistribution/index.ts:492
api/entities/DividendDistribution/index.ts:457
api/entities/Entity.ts:61
api/entities/CorporateActionBase/index.ts:152
api/entities/DividendDistribution/index.ts:205
api/entities/DividendDistribution/index.ts:223
api/entities/DividendDistribution/index.ts:238
api/entities/DividendDistribution/index.ts:622
api/entities/Entity.ts:14
api/entities/Entity.ts:23
@polymeshassociation/polymesh-sdk
Modules
api/entities/DividendDistribution
api/entities/DividendDistribution
CorporateActionBase
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
ProcedureOpts
Identity
Entity
LinkCaDocsParams
ProcedureOpts
ProcedureOpts
PayDividendsParams
ProcedureOpts
ProcedureOpts
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
CorporateActionBase
NoArgsProcedureMethod
CorporateActionBase
CorporateActionBase
ProcedureMethod
CorporateActionBase
ProcedureMethod
CorporateActionBase
ProcedureMethod
NoArgsProcedureMethod
CorporateActionBase
CorporateActionBase
CorporateActionBase
asset
declarationDate
defaultTaxWithholding
description
id
targets
taxWithholdings
uuid
checkpoint
exists
isEqual
linkDocuments
modifyCheckpoint
toHuman
generateUuid
unserialize
claim.checkAuthorization
reclaimFunds.checkAuthorization
InputCaCheckpoint
Modify
linkDocuments.checkAuthorization
modifyCheckpoint.checkAuthorization
pay.checkAuthorization