# api\_entities\_DividendDistribution.DividendDistribution

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/entities/DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution) / DividendDistribution

## Class: DividendDistribution

[api/entities/DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution).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/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase)

  ↳ **`DividendDistribution`**

### Table of contents

#### Properties

* [asset](#asset)
* [currency](#currency)
* [declarationDate](#declarationdate)
* [defaultTaxWithholding](#defaulttaxwithholding)
* [description](#description)
* [expiryDate](#expirydate)
* [id](#id)
* [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)
* [toHuman](#tohuman)
* [generateUuid](#generateuuid)
* [unserialize](#unserialize)

### Properties

#### asset

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

Asset affected by this Corporate Action

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[asset](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#asset)

**Defined in**

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

***

#### currency

• **currency**: `string`

ticker of the currency in which dividends are being distributed

**Defined in**

[api/entities/DividendDistribution/index.ts:100](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L100)

***

#### declarationDate

• **declarationDate**: `Date`

date at which the Corporate Action was created

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[declarationDate](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#declarationdate)

**Defined in**

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

***

#### defaultTaxWithholding

• **defaultTaxWithholding**: `BigNumber`

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

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[defaultTaxWithholding](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#defaulttaxwithholding)

**Defined in**

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

***

#### description

• **description**: `string`

brief text description of the Corporate Action

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[description](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#description)

**Defined in**

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

***

#### expiryDate

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

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

**Defined in**

[api/entities/DividendDistribution/index.ts:116](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L116)

***

#### id

• **id**: `BigNumber`

internal Corporate Action ID

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[id](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#id)

**Defined in**

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

***

#### maxAmount

• **maxAmount**: `BigNumber`

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

**Defined in**

[api/entities/DividendDistribution/index.ts:111](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L111)

***

#### origin

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

Portfolio from which the dividends will be distributed

**Defined in**

[api/entities/DividendDistribution/index.ts:95](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L95)

***

#### paymentDate

• **paymentDate**: `Date`

date starting from which dividends can be paid/reclaimed

**Defined in**

[api/entities/DividendDistribution/index.ts:121](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L121)

***

#### perShare

• **perShare**: `BigNumber`

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

**Defined in**

[api/entities/DividendDistribution/index.ts:105](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L105)

***

#### targets

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

Asset Holder Identities related to this Corporate action. If the treatment is `Exclude`, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[targets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#targets)

**Defined in**

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

***

#### taxWithholdings

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

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

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[taxWithholdings](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#taxwithholdings)

**Defined in**

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

***

#### uuid

• **uuid**: `string`

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[uuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#uuid)

**Defined in**

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

### Methods

#### checkpoint

▸ **checkpoint**(): `Promise`<[`CheckpointSchedule`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpointschedule.checkpointschedule) | [`Checkpoint`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpoint.checkpoint)>

Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead

**Returns**

`Promise`<[`CheckpointSchedule`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpointschedule.checkpointschedule) | [`Checkpoint`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_checkpoint.checkpoint)>

**Overrides**

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

**Defined in**

[api/entities/DividendDistribution/index.ts:246](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L246)

***

#### claim

▸ **claim**(`opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Claim the Dividends corresponding to the signing Identity

**`note`** if `currency` is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)

**`note`** this method is of type [NoArgsProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod), which means you can call [claim.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod#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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) |

**Returns**

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

**Defined in**

[api/entities/DividendDistribution/index.ts:195](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L195)

***

#### details

▸ **details**(): `Promise`<[`DividendDistributionDetails`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.dividenddistributiondetails)>

Retrieve details associated with this Dividend Distribution

**Returns**

`Promise`<[`DividendDistributionDetails`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.dividenddistributiondetails)>

**Defined in**

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

***

#### exists

▸ **exists**(): `Promise`<`boolean`>

Retrieve whether the Distribution exists

**Returns**

`Promise`<`boolean`>

**Overrides**

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

**Defined in**

[api/entities/DividendDistribution/index.ts:265](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L265)

***

#### getParticipant

▸ **getParticipant**(`args?`): `Promise`<`null` | [`DistributionParticipant`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant)>

Retrieve an Identity that is entitled to dividends in this Distribution (participant), the amount it is entitled to and whether it has been paid or not

**`note`** if the Distribution Checkpoint hasn't been created yet, the result will be null. This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint

**Parameters**

| Name            | Type                                                                                                                                       | Description                      |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
| `args?`         | `Object`                                                                                                                                   | -                                |
| `args.identity` | `string` \| [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | defaults to the signing Identity |

**Returns**

`Promise`<`null` | [`DistributionParticipant`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant)>

**Defined in**

[api/entities/DividendDistribution/index.ts:355](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L355)

***

#### getParticipants

▸ **getParticipants**(): `Promise`<[`DistributionParticipant`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant)\[]>

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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant)\[]>

**Defined in**

[api/entities/DividendDistribution/index.ts:300](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L300)

***

#### getPaymentHistory

▸ **getPaymentHistory**(`opts?`): `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`DistributionPayment`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionpayment)>>

Retrieve the payment history for this Distribution

**`note`** uses the middleware

**`note`** supports pagination

**Parameters**

| Name          | Type        |
| ------------- | ----------- |
| `opts`        | `Object`    |
| `opts.size?`  | `BigNumber` |
| `opts.start?` | `BigNumber` |

**Returns**

`Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`DistributionPayment`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionpayment)>>

**Defined in**

[api/entities/DividendDistribution/index.ts:492](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L492)

***

#### getWithheldTax

▸ **getWithheldTax**(): `Promise`<`BigNumber`>

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

**`note`** uses the middleware

**Returns**

`Promise`<`BigNumber`>

**Defined in**

[api/entities/DividendDistribution/index.ts:457](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L457)

***

#### isEqual

▸ **isEqual**(`entity`): `boolean`

Determine whether this Entity is the same as another one

**Parameters**

| Name     | Type                                                                                                                                           |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity` | [`Entity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity)<`unknown`, `unknown`> |

**Returns**

`boolean`

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[isEqual](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#isequal)

**Defined in**

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

***

#### linkDocuments

▸ **linkDocuments**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Link a list of documents to this corporate action

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

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [linkDocuments.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_linkcadocs.linkcadocsparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                           |

**Returns**

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

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[linkDocuments](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#linkdocuments)

**Defined in**

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

***

#### modifyCheckpoint

▸ **modifyCheckpoint**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Modify the Distribution's Checkpoint

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [modifyCheckpoint.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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/docs-alpha/modules-1/types_utils#modify)<`ModifyCaCheckpointParams`, { `checkpoint`: [`InputCaCheckpoint`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_types#inputcacheckpoint) }> |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                                                                                                                                                                                                         |

**Returns**

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

**Overrides**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[modifyCheckpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#modifycheckpoint)

**Defined in**

[api/entities/DividendDistribution/index.ts:205](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L205)

***

#### pay

▸ **pay**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

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

**`note`** due to performance issues, we do not validate that the distribution has enough remaining funds to pay the corresponding amount to the supplied Identities

**`note`** if `currency` is indivisible, the Identity's share will be rounded down to the nearest integer (after taxes are withheld)

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [pay.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_paydividends.paydividendsparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                                 |

**Returns**

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

**Defined in**

[api/entities/DividendDistribution/index.ts:223](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L223)

***

#### reclaimFunds

▸ **reclaimFunds**(`opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired

**`note`** withheld taxes are also reclaimed in the same transaction

**`note`** required roles:

* Origin Portfolio Custodian

**`note`** this method is of type [NoArgsProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod), which means you can call [reclaimFunds.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod#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://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) |

**Returns**

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

**Defined in**

[api/entities/DividendDistribution/index.ts:238](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L238)

***

#### toHuman

▸ **toHuman**(): `HumanReadable`

Return the Dividend Distribution's static data

**Returns**

`HumanReadable`

**Overrides**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[toHuman](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#tohuman)

**Defined in**

[api/entities/DividendDistribution/index.ts:622](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/DividendDistribution/index.ts#L622)

***

#### generateUuid

▸ `Static` **generateUuid**<`Identifiers`>(`identifiers`): `string`

Generate the Entity's UUID from its identifying properties

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`string`

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[generateUuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#generateuuid)

**Defined in**

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

***

#### unserialize

▸ `Static` **unserialize**<`Identifiers`>(`serialized`): `Identifiers`

Unserialize a UUID into its Unique Identifiers

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`Identifiers`

**Inherited from**

[CorporateActionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_corporateactionbase.corporateactionbase).[unserialize](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase.corporateactionbase#unserialize)

**Defined in**

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