# DividendDistribution

Represents a Corporate Action via which a Security Token issuer wishes to distribute dividends between a subset of the Tokenholders (targets)

## Hierarchy

↳ [CorporateAction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)

↳ **DividendDistribution**

## Index

### Properties

* [claim](#claim)
* [context](#protected-context)
* [currency](#currency)
* [declarationDate](#declarationdate)
* [defaultTaxWithholding](#defaulttaxwithholding)
* [description](#description)
* [expiryDate](#expirydate)
* [id](#id)
* [kind](#protected-kind)
* [linkDocuments](#linkdocuments)
* [maxAmount](#maxamount)
* [modifyCheckpoint](#modifycheckpoint)
* [origin](#origin)
* [pay](#pay)
* [paymentDate](#paymentdate)
* [perShare](#pershare)
* [reclaimFunds](#reclaimfunds)
* [targets](#targets)
* [taxWithholdings](#taxwithholdings)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [checkpoint](#checkpoint)
* [details](#details)
* [exists](#exists)
* [getParticipants](#getparticipants)
* [getWithheldTax](#getwithheldtax)
* [isEqual](#isequal)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### claim

• **claim**: *ProcedureMethod‹void, void›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:154*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L154)

Claim the dividends corresponding to the current Identity

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/context)

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L48)

### currency

• **currency**: *string*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:70*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L70)

ticker of the currency in which dividends are being distibuted

### declarationDate

• **declarationDate**: *Date*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*declarationDate*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#declarationdate)

*Defined in* [*src/api/entities/CorporateAction/index.ts:70*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L70)

date at which the Corporate Action was created

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*defaultTaxWithholding*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#defaulttaxwithholding)

*Defined in* [*src/api/entities/CorporateAction/index.ts:86*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L86)

default percentage of tax withholding for this Corporate Action

### description

• **description**: *string*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*description*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#description)

*Defined in* [*src/api/entities/CorporateAction/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L75)

brief text description of the Corporate Action

### expiryDate

• **expiryDate**: *null | Date*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:86*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L86)

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

### id

• **id**: *BigNumber*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*id*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#id)

*Defined in* [*src/api/entities/CorporateAction/index.ts:60*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L60)

internal Corporate Action ID

### `Protected` kind

• **kind**: [*UnpredictableBenefit*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/enums/corporateactionkind#unpredictablebenefit)

*Overrides* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*kind*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#protected-kind)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:93*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L93)

### linkDocuments

• **linkDocuments**: *ProcedureMethod‹*[*LinkCaDocsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/linkcadocsparams)*, void›*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*linkDocuments*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#linkdocuments)

*Defined in* [*src/api/entities/CorporateAction/index.ts:148*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L148)

Link a list of documents to this corporate action

**`param`** list of documents

**`note`** any previous links are removed in favor of the new list

**`note`** required role:

* Corporate Actions Agent

### maxAmount

• **maxAmount**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L81)

maximum amount of `currency` to be distributed. Distributions are "first come, first served", so funds can be depleted before every Tokenholder receives their corresponding amount

### modifyCheckpoint

• **modifyCheckpoint**: *ProcedureMethod‹ModifyDistributionCheckpointParams, void›*

*Overrides* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*modifyCheckpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#modifycheckpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:159*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L159)

Modify the Distribution's checkpoint

### origin

• **origin**: [*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L65)

Portfolio from which the dividends will be distributed

### pay

• **pay**: *ProcedureMethod‹*[*PayDividendsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/paydividendsparams)*, void›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:164*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L164)

Transfer the corresponding share of the dividends to a list of Identities

### paymentDate

• **paymentDate**: *Date*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L91)

date starting from which dividends can be paid/reclaimed

### perShare

• **perShare**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L75)

amount of `currency` to pay for each share the Tokenholder holds

### reclaimFunds

• **reclaimFunds**: *ProcedureMethod‹void, void›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:174*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L174)

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

### targets

• **targets**: [*CorporateActionTargets*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/corporateactiontargets)

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*targets*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#targets)

*Defined in* [*src/api/entities/CorporateAction/index.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L81)

tokenholder identities related to this Corporate action. If the treatment is `Exclude`, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

### taxWithholdings

• **taxWithholdings**: [*TaxWithholding*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/taxwithholding)*\[]*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*taxWithholdings*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#taxwithholdings)

*Defined in* [*src/api/entities/CorporateAction/index.ts:92*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L92)

percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

### ticker

• **ticker**: *string*

*Inherited from* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*ticker*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#ticker)

*Defined in* [*src/api/entities/CorporateAction/index.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/CorporateAction/index.ts#L65)

ticker of the Security Token

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L46)

## Methods

### checkpoint

▸ **checkpoint**(): *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpoint) *|* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*›*

*Overrides* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#checkpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:180*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L180)

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:** *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpoint) *|* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*›*

### details

▸ **details**(): *Promise‹*[*DividendDistributionDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/dividenddistributiondetails)*›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:199*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L199)

Retrieve details associated with this Dividend Distribution

**Returns:** *Promise‹*[*DividendDistributionDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/dividenddistributiondetails)*›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Overrides* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateaction)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/corporateaction#exists)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:190*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L190)

Retrieve whether the Distribution exists

**Returns:** *Promise‹boolean›*

### getParticipants

▸ **getParticipants**(): *Promise‹*[*DistributionParticipant*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/distributionparticipant)*\[]›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:225*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L225)

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 Tokenholders

**`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:** *Promise‹*[*DistributionParticipant*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/distributionparticipant)*\[]›*

### getWithheldTax

▸ **getWithheldTax**(): *Promise‹BigNumber›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:292*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/DividendDistribution/index.ts#L292)

Retrieve the amount of taxes that have been withheld up to this point in this Distribution

**`note`** uses the middleware

**Returns:** *Promise‹BigNumber›*

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object›): *boolean*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                    |
| -------- | ------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object› |

**Returns:** *boolean*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*