> 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/external-modules/_entities_securitytoken_dividends_.dividends.md).

# Dividends

Namespace that handles all Dividend related functionality

## Hierarchy

* [SubModule](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)

  ↳ **Dividends**

## Index

### Constructors

* [constructor](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#constructor)

### Properties

* [context](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#protected-context)
* [securityToken](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#protected-securitytoken)

### Methods

* [createErc20Distribution](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#createerc20distribution)
* [createPolyDistribution](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#createpolydistribution)
* [getDefaultExclusionList](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#getdefaultexclusionlist)
* [getDistribution](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#getdistribution)
* [getDistributions](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#getdistributions)
* [getTaxWithholdingList](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#gettaxwithholdinglist)
* [modifyDefaultExclusionList](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#modifydefaultexclusionlist)
* [modifyStorageWallet](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#modifystoragewallet)
* [modifyTaxWithholdingList](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md#modifytaxwithholdinglist)

## Constructors

### constructor

\+ **new Dividends**(`securityToken`: [SecurityToken](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](/classic-sdk/classes/_context_.context.md)): [*Dividends*](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*constructor*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#constructor)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:10*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)

Create a new SubModule instance

**Parameters:**

| Name            | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| `securityToken` | [SecurityToken](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md) |
| `context`       | [Context](/classic-sdk/classes/_context_.context.md)                                          |

**Returns:** [*Dividends*](/classic-sdk/classes/_entities_securitytoken_dividends_.dividends.md)

## Properties

### `Protected` context

• **context**: [*Context*](/classic-sdk/classes/_context_.context.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*context*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#protected-context)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:10*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)

### `Protected` securityToken

• **securityToken**: [*SecurityToken*](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*securityToken*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:8*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)

## Methods

### createErc20Distribution

▸ **createErc20Distribution**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*CreateDividendDistributionProcedureArgs*](/classic-sdk/interfaces/_types_index_.createdividenddistributionprocedureargs.md)*,* [*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*››*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:79*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L79)

Distribute dividends in a specified ERC20 token

**Parameters:**

▪ **args**: *object*

| Name                 | Type                                                                                   |
| -------------------- | -------------------------------------------------------------------------------------- |
| `amount`             | BigNumber                                                                              |
| `checkpointId`       | string                                                                                 |
| `erc20Address`       | string                                                                                 |
| `excludedAddresses?` | string\[]                                                                              |
| `expiryDate`         | Date                                                                                   |
| `maturityDate`       | Date                                                                                   |
| `name`               | string                                                                                 |
| `taxWithholdings?`   | [TaxWithholdingEntry](/classic-sdk/interfaces/_types_index_.taxwithholdingentry.md)\[] |

**Returns:** *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*CreateDividendDistributionProcedureArgs*](/classic-sdk/interfaces/_types_index_.createdividenddistributionprocedureargs.md)*,* [*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*››*

### createPolyDistribution

▸ **createPolyDistribution**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*CreateDividendDistributionProcedureArgs*](/classic-sdk/interfaces/_types_index_.createdividenddistributionprocedureargs.md)*,* [*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*››*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:40*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L40)

Distribute dividends in POLY

**Parameters:**

▪ **args**: *object*

| Name                 | Type                                                                                   |
| -------------------- | -------------------------------------------------------------------------------------- |
| `amount`             | BigNumber                                                                              |
| `checkpointId`       | string                                                                                 |
| `excludedAddresses?` | string\[]                                                                              |
| `expiryDate`         | Date                                                                                   |
| `maturityDate`       | Date                                                                                   |
| `name`               | string                                                                                 |
| `taxWithholdings?`   | [TaxWithholdingEntry](/classic-sdk/interfaces/_types_index_.taxwithholdingentry.md)\[] |

**Returns:** *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*CreateDividendDistributionProcedureArgs*](/classic-sdk/interfaces/_types_index_.createdividenddistributionprocedureargs.md)*,* [*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*››*

### getDefaultExclusionList

▸ **getDefaultExclusionList**(): *Promise‹string\[]›*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:278*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L278)

Retrieve the list of addresses which are excluded from receiving dividend payments by default

**Returns:** *Promise‹string\[]›*

### getDistribution

▸ **getDistribution**(`args`: [GetDistributionParams](/classic-sdk/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) | string): *Promise‹*[*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*›*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:254*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L254)

Retrieve a particular dividend distribution by type and index or UUID

**Parameters:**

| Name   | Type                                                                                                                   | Description                                  |
| ------ | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `args` | [GetDistributionParams](/classic-sdk/interfaces/_entities_securitytoken_dividends_.getdistributionparams.md) \| string | dividend uuid or object containing its index |

**Returns:** *Promise‹*[*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*›*

### getDistributions

▸ **getDistributions**(`args`: object): *Promise‹*[*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*\[]›*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:222*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L222)

Retrieve all dividend distributions at a certain checkpoint

**Parameters:**

▪ **args**: *object*

| Name           | Type   |
| -------------- | ------ |
| `checkpointId` | string |

**Returns:** *Promise‹*[*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*\[]›*

### getTaxWithholdingList

▸ **getTaxWithholdingList**(): *Promise‹*[*TaxWithholding*](/classic-sdk/classes/_entities_taxwithholding_.taxwithholding.md)*\[]›*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:169*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L169)

Retrieve a list of investor addresses and their corresponding tax withholding percentages

**Returns:** *Promise‹*[*TaxWithholding*](/classic-sdk/classes/_entities_taxwithholding_.taxwithholding.md)*\[]›*

### modifyDefaultExclusionList

▸ **modifyDefaultExclusionList**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*ModifyDividendsDefaultExclusionListProcedureArgs*](/classic-sdk/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)*, void››*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:152*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L152)

Set default exclusion list for a type of dividends. Addresses on this list won't be considered for dividend distribution. This operation overrides the previous default exclusion list

**Parameters:**

▪ **args**: *object*

| Name                   | Type      |
| ---------------------- | --------- |
| `tokenholderAddresses` | string\[] |

**Returns:** *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*ModifyDividendsDefaultExclusionListProcedureArgs*](/classic-sdk/interfaces/_types_index_.modifydividendsdefaultexclusionlistprocedureargs.md)*, void››*

### modifyStorageWallet

▸ **modifyStorageWallet**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*SetDividendsWalletProcedureArgs*](/classic-sdk/interfaces/_types_index_.setdividendswalletprocedureargs.md)*, void››*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:135*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L135)

Change dividends storage wallet address

**Parameters:**

▪ **args**: *object*

| Name      | Type   |
| --------- | ------ |
| `address` | string |

**Returns:** *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*SetDividendsWalletProcedureArgs*](/classic-sdk/interfaces/_types_index_.setdividendswalletprocedureargs.md)*, void››*

### modifyTaxWithholdingList

▸ **modifyTaxWithholdingList**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*UpdateDividendsTaxWithholdingListProcedureArgs*](/classic-sdk/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)*, void››*

*Defined in* [*src/entities/SecurityToken/Dividends.ts:109*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Dividends.ts#L109)

Set default tax withtholding list for a type of dividends

**Parameters:**

▪ **args**: *object*

| Name              | Type                                                                                   |
| ----------------- | -------------------------------------------------------------------------------------- |
| `taxWithholdings` | [TaxWithholdingEntry](/classic-sdk/interfaces/_types_index_.taxwithholdingentry.md)\[] |

**Returns:** *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*UpdateDividendsTaxWithholdingListProcedureArgs*](/classic-sdk/interfaces/_types_index_.updatedividendstaxwithholdinglistprocedureargs.md)*, void››*