# 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/v11.0.2/classes/corporateaction)

↳ **DividendDistribution**

## Index

### Properties

* [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)
* [ticker](#ticker)
* [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

### `Protected` context

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#protected-context)

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

***

### currency

• **currency**: *string*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:96*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L96)

ticker of the currency in which dividends are being distibuted

***

### declarationDate

• **declarationDate**: *Date*

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

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

date at which the Corporate Action was created

***

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

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

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

default percentage of tax withholding for this Corporate Action

***

### description

• **description**: *string*

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

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

brief text description of the Corporate Action

***

### expiryDate

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:112*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L112)

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/v11.0.2/classes/corporateaction)*.*[*id*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/corporateaction#id)

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

internal Corporate Action ID

***

### `Protected` kind

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

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:122*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L122)

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:107*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L107)

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

***

### origin

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

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

Portfolio from which the dividends will be distributed

***

### paymentDate

• **paymentDate**: *Date*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:117*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L117)

date starting from which dividends can be paid/reclaimed

***

### perShare

• **perShare**: *BigNumber*

*Defined in* [*src/api/entities/DividendDistribution/index.ts:101*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L101)

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

***

### targets

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

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

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

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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/taxwithholding.md)*\[]*

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

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

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/v11.0.2/classes/corporateaction)*.*[*ticker*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/corporateaction#ticker)

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

ticker of the Security Token

***

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#uuid)

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

## Methods

### checkpoint

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

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:236*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L236)

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

***

### claim

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

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

Claim the Dividends corresponding to the current 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 [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `claim.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

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

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

***

### details

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:264*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L264)

Retrieve details associated with this Dividend Distribution

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

***

### exists

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

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

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

Retrieve whether the Distribution exists

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

***

### getParticipant

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:350*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L350)

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/v11/docs/interfaces/distributionparticipant.md) *| null›*

***

### getParticipants

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:290*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L290)

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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionparticipant.md)*\[]›*

***

### getPaymentHistory

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:454*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L454)

Retrieve the payment history for this Distribution

**`note`** uses the middleware

**`note`** supports pagination

**Parameters:**

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

| Name     | Type                |
| -------- | ------------------- |
| `size?`  | undefined \| number |
| `start?` | undefined \| number |

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

***

### getWithheldTax

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:423*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L423)

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/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/v11.0.2/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

***

### linkDocuments

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

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

*Defined in* [*src/api/entities/CorporateAction/index.ts:162*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/CorporateAction/index.ts#L162)

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/v11/docs/interfaces/proceduremethod.md), which means you can call `linkDocuments.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

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

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

***

### modifyCheckpoint

▸ **modifyCheckpoint**(`args`: ModifyDistributionCheckpointParams, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/transactionqueue)*‹void››*

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:200*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L200)

Modify the Distribution's checkpoint

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

**Parameters:**

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

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

***

### pay

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:213*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L213)

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/v11/docs/interfaces/proceduremethod.md), which means you can call `pay.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

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

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

***

### reclaimFunds

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

*Defined in* [*src/api/entities/DividendDistribution/index.ts:228*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L228)

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 [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/proceduremethod.md), which means you can call `reclaimFunds.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

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

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

***

### toJson

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

*Overrides* [*CorporateAction*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/corporateaction)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/corporateaction#tojson)

*Defined in* [*src/api/entities/DividendDistribution/index.ts:564*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/DividendDistribution/index.ts#L564)

Return the Dividend Distribution's static data

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

***

### `Static` generateUuid

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

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

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

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