# DividendDistribution

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

## Hierarchy

↳ [CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)

↳ **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)
* [getWithheldTax](#getwithheldtax)
* [isEqual](#isequal)
* [linkDocuments](#linkdocuments)
* [modifyCheckpoint](#modifycheckpoint)
* [pay](#pay)
* [reclaimFunds](#reclaimfunds)
* [toJson](#tojson)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### asset

• **asset**: [*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*asset*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#asset)

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

Asset affected by this Corporate Action

***

### `Protected` context

• **context**: *Context*

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

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

***

### currency

• **currency**: *string*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:100*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L100)

ticker of the currency in which dividends are being distributed

***

### declarationDate

• **declarationDate**: *Date*

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*declarationDate*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#declarationdate)

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

date at which the Corporate Action was created

***

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*defaultTaxWithholding*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#defaulttaxwithholding)

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

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

***

### description

• **description**: *string*

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*description*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#description)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:87*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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:116*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L116)

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

***

### id

• **id**: *BigNumber*

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*id*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#id)

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

internal Corporate Action ID

***

### `Protected` kind

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

*Overrides* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*kind*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#protected-kind)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:126*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L126)

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:111*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L111)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/defaultportfolio) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/numberedportfolio)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:95*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L95)

Portfolio from which the dividends will be distributed

***

### paymentDate

• **paymentDate**: *Date*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:121*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L121)

date starting from which dividends can be paid/reclaimed

***

### perShare

• **perShare**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:105*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L105)

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

***

### targets

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

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*targets*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#targets)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:93*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/taxwithholding.md)*\[]*

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*taxWithholdings*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#taxwithholdings)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:104*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpointschedule)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/checkpointschedule#uuid)

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

## Methods

### checkpoint

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

*Overrides* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#checkpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:246*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L246)

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

***

### claim

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:195*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L195)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/noargsproceduremethod.md), which means you can call [claim.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

***

### details

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

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

Retrieve details associated with this Dividend Distribution

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

***

### exists

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

*Overrides* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#exists)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:265*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L265)

Retrieve whether the Distribution exists

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

***

### getParticipant

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:360*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L360)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/distributionparticipant.md) *| null›*

***

### getParticipants

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:300*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L300)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/distributionparticipant.md)*\[]›*

***

### getPaymentHistory

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:470*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L470)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/resultset.md)*‹*[*DistributionPayment*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/distributionpayment.md)*››*

***

### getWithheldTax

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:435*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L435)

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/classes/entity)‹unknown, unknown›): *boolean*

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

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

Determine whether this Entity is the same as another one

**Parameters:**

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

**Returns:** *boolean*

***

### linkDocuments

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

*Inherited from* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*linkDocuments*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#linkdocuments)

*Defined in* [*src/api/entities/CorporateActionBase/index.ts:152*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [linkDocuments.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/linkcadocsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)       |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

***

### modifyCheckpoint

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

*Overrides* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*modifyCheckpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#abstract-modifycheckpoint)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:205*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L205)

Modify the Distribution's Checkpoint

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [modifyCheckpoint.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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](https://developers.polymath.network/polymesh-sdk-api-reference/globals#modify)‹ModifyCaCheckpointParams, object› |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)       |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

***

### pay

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:223*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L223)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/proceduremethod.md), which means you can call [pay.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/paydividendsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)           |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

***

### reclaimFunds

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:238*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L238)

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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/noargsproceduremethod.md), which means you can call [reclaimFunds.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/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/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹void››*

***

### toJson

▸ **toJson**(): [*HumanReadable*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/humanreadable.md)

*Overrides* [*CorporateActionBase*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/corporateactionbase)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/corporateactionbase#tojson)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:600*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/DividendDistribution/index.ts#L600)

Return the Dividend Distribution's static data

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

***

### `Static` generateUuid

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

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

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/checkpointschedule#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/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*