# DividendDistribution

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

## Hierarchy

↳ [CorporateActionBase](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)

↳ **DividendDistribution**

## Index

### Properties

* [asset](#asset)
* [context](#protected-context)
* [currency](#currency)
* [declarationDate](#declarationdate)
* [defaultTaxWithholding](#defaulttaxwithholding)
* [description](#description)
* [expiryDate](#expirydate)
* [id](#id)
* [kind](#protected-kind)
* [maxAmount](#maxamount)
* [origin](#origin)
* [paymentDate](#paymentdate)
* [perShare](#pershare)
* [targets](#targets)
* [taxWithholdings](#taxwithholdings)
* [uuid](#uuid)

### Methods

* [checkpoint](#checkpoint)
* [claim](#claim)
* [details](#details)
* [exists](#exists)
* [getParticipant](#getparticipant)
* [getParticipants](#getparticipants)
* [getPaymentHistory](#getpaymenthistory)
* [getPaymentHistoryV2](#getpaymenthistoryv2)
* [getWithheldTax](#getwithheldtax)
* [getWithheldTaxV2](#getwithheldtaxv2)
* [isEqual](#isequal)
* [linkDocuments](#linkdocuments)
* [modifyCheckpoint](#modifycheckpoint)
* [pay](#pay)
* [reclaimFunds](#reclaimfunds)
* [toHuman](#tohuman)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### asset

• **asset**: [*Asset*](/polymesh-sdk-api-reference/docs-beta/classes/asset.md)

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*asset*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#asset)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L77)

Asset affected by this Corporate Action

***

### `Protected` context

• **context**: *Context*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#protected-context)

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

***

### currency

• **currency**: *string*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:109*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L109)

ticker of the currency in which dividends are being distributed

***

### declarationDate

• **declarationDate**: *Date*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*declarationDate*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#declarationdate)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L82)

date at which the Corporate Action was created

***

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*defaultTaxWithholding*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#defaulttaxwithholding)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:98*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L98)

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

***

### description

• **description**: *string*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*description*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#description)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L87)

brief text description of the Corporate Action

***

### expiryDate

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:125*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L125)

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

***

### id

• **id**: *BigNumber*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*id*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#id)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L72)

internal Corporate Action ID

***

### `Protected` kind

• **kind**: [*UnpredictableBenefit*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/corporateactionkind.md#unpredictablebenefit) *|* [*PredictableBenefit*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/enums/corporateactionkind.md#predictablebenefit)

*Overrides* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*kind*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#protected-kind)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:135*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L135)

type of dividend distribution being represented. The chain enforces it to be either PredictableBenefit or UnpredictableBenefit

***

### maxAmount

• **maxAmount**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:120*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L120)

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

***

### origin

• **origin**: [*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-beta/classes/defaultportfolio.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-beta/classes/numberedportfolio.md)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:104*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L104)

Portfolio from which the dividends will be distributed

***

### paymentDate

• **paymentDate**: *Date*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:130*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L130)

date starting from which dividends can be paid/reclaimed

***

### perShare

• **perShare**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L114)

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

***

### targets

• **targets**: [*CorporateActionTargets*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/corporateactiontargets.md)

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*targets*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#targets)

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

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

***

### taxWithholdings

• **taxWithholdings**: [*TaxWithholding*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/taxwithholding.md)*\[]*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*taxWithholdings*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#taxwithholdings)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:104*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L104)

percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

***

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#uuid)

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

## Methods

### checkpoint

▸ **checkpoint**(): *Promise‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-beta/classes/checkpoint.md) *|* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*›*

*Overrides* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*checkpoint*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#checkpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:255*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L255)

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*](/polymesh-sdk-api-reference/docs-beta/classes/checkpoint.md) *|* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*›*

***

### claim

▸ **claim**(`opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:204*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L204)

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)

**`note`** this method is of type [NoArgsProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md), which means you can call [claim.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                             |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

***

### details

▸ **details**(): *Promise‹*[*DividendDistributionDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/dividenddistributiondetails.md)*›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:283*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L283)

Retrieve details associated with this Dividend Distribution

**Returns:** *Promise‹*[*DividendDistributionDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/dividenddistributiondetails.md)*›*

***

### exists

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

*Overrides* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*exists*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#exists)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:274*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L274)

Retrieve whether the Distribution exists

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

***

### getParticipant

▸ **getParticipant**(`args?`: undefined | object): *Promise‹*[*DistributionParticipant*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionparticipant.md) *| null›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:364*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L364)

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                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹*[*DistributionParticipant*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionparticipant.md) *| null›*

***

### getParticipants

▸ **getParticipants**(): *Promise‹*[*DistributionParticipant*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionparticipant.md)*\[]›*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:309*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L309)

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:** *Promise‹*[*DistributionParticipant*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionparticipant.md)*\[]›*

***

### getPaymentHistory

▸ **getPaymentHistory**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*DistributionPayment*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionpayment.md)*››*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:538*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L538)

Retrieve the payment history for this Distribution

**`note`** uses the middleware

**`note`** supports pagination

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name     | Type      |
| -------- | --------- |
| `size?`  | BigNumber |
| `start?` | BigNumber |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*DistributionPayment*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionpayment.md)*››*

***

### getPaymentHistoryV2

▸ **getPaymentHistoryV2**(`opts`: object): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*DistributionPayment*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionpayment.md)*››*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:624*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L624)

Retrieve the payment history for this Distribution

**`note`** uses the middleware V2

**`note`** supports pagination

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name     | Type      |
| -------- | --------- |
| `size?`  | BigNumber |
| `start?` | BigNumber |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/resultset.md)*‹*[*DistributionPayment*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/distributionpayment.md)*››*

***

### getWithheldTax

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:466*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L466)

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

**`note`** uses the middleware

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

***

### getWithheldTaxV2

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:500*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L500)

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

**`note`** uses the middlewareV2

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

***

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-beta/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#isequal)

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

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                |
| -------- | ----------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-beta/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

***

### linkDocuments

▸ **linkDocuments**(`args`: [LinkCaDocsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/linkcadocsparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Inherited from* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*linkDocuments*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#linkdocuments)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:152*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/CorporateActionBase/index.ts#L152)

Link a list of documents to this corporate action

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

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [linkDocuments.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                                   |
| ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `args`  | [LinkCaDocsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/linkcadocsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)       |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

***

### modifyCheckpoint

▸ **modifyCheckpoint**(`args`: [Modify](/polymesh-sdk-api-reference/docs-beta/globals.md#modify)‹ModifyCaCheckpointParams, object›, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Overrides* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*modifyCheckpoint*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#abstract-modifycheckpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L214)

Modify the Distribution's Checkpoint

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [modifyCheckpoint.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                             |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| `args`  | [Modify](/polymesh-sdk-api-reference/docs-beta/globals.md#modify)‹ModifyCaCheckpointParams, object›              |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

***

### pay

▸ **pay**(`args`: [PayDividendsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/paydividendsparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:232*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L232)

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)

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [pay.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                                       |
| ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [PayDividendsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/paydividendsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)           |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

***

### reclaimFunds

▸ **reclaimFunds**(`opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:247*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L247)

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

**`note`** this method is of type [NoArgsProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md), which means you can call [reclaimFunds.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/noargsproceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                             |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

***

### toHuman

▸ **toHuman**(): [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/humanreadable.md)

*Overrides* [*CorporateActionBase*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md)*.*[*toHuman*](/polymesh-sdk-api-reference/docs-beta/classes/corporateactionbase.md#tohuman)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:739*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/DividendDistribution/index.ts#L739)

Return the Dividend Distribution's static data

**Returns:** [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/humanreadable.md)

***

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#static-generateuuid)

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

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

**Returns:** *string*

***

### `Static` unserialize

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#static-unserialize)

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

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

**Returns:** *Identifiers*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-beta/classes/dividenddistribution.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.