> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/classic-sdk/beta/external-modules/_entities_dividenddistribution_.dividenddistribution.md).

# DividendDistribution

Class used to manage the dividend distribution functionality

## Hierarchy

* [Entity](broken://pages/-M-tw-_WeBJcuS0_s0nR)‹[Params](broken://pages/-M-tw-bS3sZThss4LErM)›

  ↳ **DividendDistribution**

## Index

### Constructors

* [constructor](broken://pages/-M-tw-_VZF8SRmWdakUB#constructor)

### Properties

* [amount](broken://pages/-M-tw-_VZF8SRmWdakUB#amount)
* [checkpointId](broken://pages/-M-tw-_VZF8SRmWdakUB#checkpointid)
* [claimedAmount](broken://pages/-M-tw-_VZF8SRmWdakUB#claimedamount)
* [context](broken://pages/-M-tw-_VZF8SRmWdakUB#protected-context)
* [created](broken://pages/-M-tw-_VZF8SRmWdakUB#created)
* [currency](broken://pages/-M-tw-_VZF8SRmWdakUB#currency)
* [expiry](broken://pages/-M-tw-_VZF8SRmWdakUB#expiry)
* [index](broken://pages/-M-tw-_VZF8SRmWdakUB#index)
* [maturity](broken://pages/-M-tw-_VZF8SRmWdakUB#maturity)
* [name](broken://pages/-M-tw-_VZF8SRmWdakUB#name)
* [reclaimed](broken://pages/-M-tw-_VZF8SRmWdakUB#reclaimed)
* [securityTokenId](broken://pages/-M-tw-_VZF8SRmWdakUB#securitytokenid)
* [securityTokenSymbol](broken://pages/-M-tw-_VZF8SRmWdakUB#securitytokensymbol)
* [tokenholders](broken://pages/-M-tw-_VZF8SRmWdakUB#tokenholders)
* [totalSupply](broken://pages/-M-tw-_VZF8SRmWdakUB#totalsupply)
* [totalWithheld](broken://pages/-M-tw-_VZF8SRmWdakUB#totalwithheld)
* [totalWithheldWithdrawn](broken://pages/-M-tw-_VZF8SRmWdakUB#totalwithheldwithdrawn)
* [uid](broken://pages/-M-tw-_VZF8SRmWdakUB#uid)

### Methods

* [\_refresh](broken://pages/-M-tw-_VZF8SRmWdakUB#_refresh)
* [pullPayment](broken://pages/-M-tw-_VZF8SRmWdakUB#pullpayment)
* [pushPayment](broken://pages/-M-tw-_VZF8SRmWdakUB#pushpayment)
* [toPojo](broken://pages/-M-tw-_VZF8SRmWdakUB#topojo)
* [withdrawTaxes](broken://pages/-M-tw-_VZF8SRmWdakUB#withdrawtaxes)
* [generateId](broken://pages/-M-tw-_VZF8SRmWdakUB#static-generateid)
* [unserialize](broken://pages/-M-tw-_VZF8SRmWdakUB#static-unserialize)

## Constructors

### constructor

\+ **new DividendDistribution**(`params`: [Params](broken://pages/-M-tw-bS3sZThss4LErM) & [UniqueIdentifiers](broken://pages/-M-tw-bTiLSy349BNsDv), `context`: [Context](broken://pages/-M-tw-_Q7PZbtE8P8eVD)): [*DividendDistribution*](broken://pages/-M-tw-_VZF8SRmWdakUB)

*Defined in* [*src/entities/DividendDistribution.ts:146*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L146)

Create a new Dividend Distribution instance

**Parameters:**

| Name      | Type                                                                                                     |
| --------- | -------------------------------------------------------------------------------------------------------- |
| `params`  | [Params](broken://pages/-M-tw-bS3sZThss4LErM) & [UniqueIdentifiers](broken://pages/-M-tw-bTiLSy349BNsDv) |
| `context` | [Context](broken://pages/-M-tw-_Q7PZbtE8P8eVD)                                                           |

**Returns:** [*DividendDistribution*](broken://pages/-M-tw-_VZF8SRmWdakUB)

## Properties

### amount

• **amount**: *BigNumber*

*Defined in* [*src/entities/DividendDistribution.ts:128*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L128)

### checkpointId

• **checkpointId**: *string*

*Defined in* [*src/entities/DividendDistribution.ts:116*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L116)

### claimedAmount

• **claimedAmount**: *BigNumber*

*Defined in* [*src/entities/DividendDistribution.ts:130*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L130)

### `Protected` context

• **context**: [*Context*](broken://pages/-M-tw-_Q7PZbtE8P8eVD)

*Defined in* [*src/entities/DividendDistribution.ts:146*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L146)

### created

• **created**: *Date*

*Defined in* [*src/entities/DividendDistribution.ts:122*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L122)

### currency

• **currency**: *string | null*

*Defined in* [*src/entities/DividendDistribution.ts:144*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L144)

### expiry

• **expiry**: *Date*

*Defined in* [*src/entities/DividendDistribution.ts:126*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L126)

### index

• **index**: *number*

*Defined in* [*src/entities/DividendDistribution.ts:114*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L114)

### maturity

• **maturity**: *Date*

*Defined in* [*src/entities/DividendDistribution.ts:124*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L124)

### name

• **name**: *string*

*Defined in* [*src/entities/DividendDistribution.ts:142*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L142)

### reclaimed

• **reclaimed**: *boolean*

*Defined in* [*src/entities/DividendDistribution.ts:134*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L134)

### securityTokenId

• **securityTokenId**: *string*

*Defined in* [*src/entities/DividendDistribution.ts:120*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L120)

### securityTokenSymbol

• **securityTokenSymbol**: *string*

*Defined in* [*src/entities/DividendDistribution.ts:118*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L118)

### tokenholders

• **tokenholders**: [*DividendTokenholderStatus*](broken://pages/-M2_0qxcWArD8wouUwQW)*\[]*

*Defined in* [*src/entities/DividendDistribution.ts:140*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L140)

### totalSupply

• **totalSupply**: *BigNumber*

*Defined in* [*src/entities/DividendDistribution.ts:132*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L132)

### totalWithheld

• **totalWithheld**: *BigNumber*

*Defined in* [*src/entities/DividendDistribution.ts:136*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L136)

### totalWithheldWithdrawn

• **totalWithheldWithdrawn**: *BigNumber*

*Defined in* [*src/entities/DividendDistribution.ts:138*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L138)

### uid

• **uid**: *string*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*uid*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-uid)

*Defined in* [*src/entities/DividendDistribution.ts:112*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L112)

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](broken://pages/-M-tw-bS3sZThss4LErM)›): *void*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*\_refresh*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-_refresh)

*Defined in* [*src/entities/DividendDistribution.ts:290*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L290)

Hydrate the Dividend Distribution entity

**Parameters:**

| Name     | Type                                                   |
| -------- | ------------------------------------------------------ |
| `params` | Partial‹[Params](broken://pages/-M-tw-bS3sZThss4LErM)› |

**Returns:** *void*

### pullPayment

▸ **pullPayment**(): *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*PullDividendPaymentProcedureArgs*](broken://pages/-M-tw-cj0FfPHVRaPyK6)*, void››*

*Defined in* [*src/entities/DividendDistribution.ts:215*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L215)

Pull payment from this dividend distribution to the current address

**Returns:** *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*PullDividendPaymentProcedureArgs*](broken://pages/-M-tw-cj0FfPHVRaPyK6)*, void››*

### pushPayment

▸ **pushPayment**(): *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*PushDividendPaymentProcedureArgs*](broken://pages/-M-tw-ckyqhUTrItO1a_)*, void››*

*Defined in* [*src/entities/DividendDistribution.ts:200*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L200)

Push payment for this dividend distribution

**Returns:** *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*PushDividendPaymentProcedureArgs*](broken://pages/-M-tw-ckyqhUTrItO1a_)*, void››*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*toPojo*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-topojo)

*Defined in* [*src/entities/DividendDistribution.ts:245*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L245)

Convert entity to POJO (Plain Old Javascript Object)

**Returns:** *object*

* **amount**: *BigNumber*
* **checkpointId**: *string*
* **claimedAmount**: *BigNumber*
* **created**: *Date*
* **currency**: *null | string*
* **expiry**: *Date*
* **index**: *number*
* **maturity**: *Date*
* **name**: *string*
* **reclaimed**: *boolean*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **tokenholders**: [*DividendTokenholderStatus*](broken://pages/-M2_0qxcWArD8wouUwQW)*\[]*
* **totalSupply**: *BigNumber*
* **totalWithheld**: *BigNumber*
* **totalWithheldWithdrawn**: *BigNumber*
* **uid**: *string*

### withdrawTaxes

▸ **withdrawTaxes**(): *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*WithdrawTaxesProcedureArgs*](broken://pages/-M-tw-d8r_E4Wsx93c_r)*, void››*

*Defined in* [*src/entities/DividendDistribution.ts:230*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L230)

Withdraw collected taxes from this dividend distribution

**Returns:** *Promise‹*[*TransactionQueue*](broken://pages/-M-tw-_ttRjEt_eA5M8H)*‹*[*WithdrawTaxesProcedureArgs*](broken://pages/-M-tw-d8r_E4Wsx93c_r)*, void››*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

*Defined in* [*src/entities/DividendDistribution.ts:87*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L87)

Generate the Dividend Distribution's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name              | Type   |
| ----------------- | ------ |
| `index`           | number |
| `securityTokenId` | string |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](broken://pages/-M-tw-bTiLSy349BNsDv)

*Defined in* [*src/entities/DividendDistribution.ts:99*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/DividendDistribution.ts#L99)

Unserialize string to a Dividend Distribution object representation

**Parameters:**

| Name         | Type   |
| ------------ | ------ |
| `serialized` | string |

**Returns:** [*UniqueIdentifiers*](broken://pages/-M-tw-bTiLSy349BNsDv)