> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/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/polymesh-sdk-api-reference/docs-v5/classes/distributions.md).

# Distributions

Handles all Security Token Distributions related functionality

## Hierarchy

* Namespace‹[SecurityToken](/polymesh-sdk-api-reference/docs-v5/classes/securitytoken.md)›

  ↳ **Distributions**

## Index

### Properties

* [configureDividendDistribution](/polymesh-sdk-api-reference/docs-v5/classes/distributions.md#configuredividenddistribution)
* [context](/polymesh-sdk-api-reference/docs-v5/classes/distributions.md#protected-context)
* [parent](/polymesh-sdk-api-reference/docs-v5/classes/distributions.md#protected-parent)

### Methods

* [get](/polymesh-sdk-api-reference/docs-v5/classes/distributions.md#get)

## Properties

### configureDividendDistribution

• **configureDividendDistribution**: *ProcedureMethod‹*[*ConfigureDividendDistributionParams*](/polymesh-sdk-api-reference/docs-v5/globals.md#configuredividenddistributionparams)*,* [*DividendDistribution*](/polymesh-sdk-api-reference/docs-v5/classes/dividenddistribution.md)*›*

*Defined in* [*src/api/entities/SecurityToken/CorporateActions/Distributions.ts:52*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/Distributions.ts#L52)

Create a Dividend Distribution for a subset of the Tokenholders at a certain (existing or future) Checkpoint

**`param`** date at which the issuer publicly declared the Distribution. Optional, defaults to the current date

**`param`** checkpoint to be used to calculate Dividends. If a Schedule is passed, the next Checkpoint it creates will be used. If a Date is passed, a Checkpoint will be created at that date and used

**`param`** tokenholder identities to be included (or excluded) from the distribution. Inclusion/exclusion is controlled by the `treatment` property. When the value is `Include`, all tokenholders not present in the array are excluded, and vice-versa

**`param`** default percentage of the Dividends to be held for tax purposes

**`param`** percentage of the Dividends to be held for tax purposes from individual tokenholder Identities. This overrides the value of `defaultTaxWithholding`

**`param`** portfolio from which the Dividends will be distributed. Optional, defaults to the Corporate Actions Agent's Default Portfolio

**`param`** ticker of the currency in which Dividends will be distributed

**`param`** amount of `currency` to distribute per each share of the Security Token held

**`param`** maximum amount of `currency` to distribute in total

**`param`** date from which Tokenholders can claim their Dividends

**`param`** a null value means the Distribution never expires

**`note`** required roles:

* Security Token Corporate Actions Agent
* Origin Portfolio Custodian

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v5/classes/context.md)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Namespace.ts#L11)

### `Protected` parent

• **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/docs-v5/classes/securitytoken.md)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Namespace.ts#L9)

## Methods

### get

▸ **get**(): *Promise‹*[*DistributionWithDetails*](/polymesh-sdk-api-reference/docs-v5/interfaces/distributionwithdetails.md)*\[]›*

*Defined in* [*src/api/entities/SecurityToken/CorporateActions/Distributions.ts:74*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/Distributions.ts#L74)

Retrieve all Dividend Distributions associated to this Security Token

**Returns:** *Promise‹*[*DistributionWithDetails*](/polymesh-sdk-api-reference/docs-v5/interfaces/distributionwithdetails.md)*\[]›*