> 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-v7/classes/distributions.md).

# Distributions

Handles all Security Token Distributions related functionality

## Hierarchy

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

  ↳ **Distributions**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

## Methods

### configureDividendDistribution

▸ **configureDividendDistribution**(`args`: [ConfigureDividendDistributionParams](/polymesh-sdk-api-reference/docs-v7/globals.md#configuredividenddistributionparams), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*DividendDistribution*](/polymesh-sdk-api-reference/docs-v7/classes/dividenddistribution.md)*››*

*Defined in* [*src/api/entities/SecurityToken/CorporateActions/Distributions.ts:43*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/SecurityToken/CorporateActions/Distributions.ts#L43)

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

**`note`** required roles:

* Security Token Corporate Actions Agent
* Origin Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v7/interfaces/proceduremethod.md), which means you can call `configureDividendDistribution.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                      |
| ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [ConfigureDividendDistributionParams](/polymesh-sdk-api-reference/docs-v7/globals.md#configuredividenddistributionparams) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)                                          |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*DividendDistribution*](/polymesh-sdk-api-reference/docs-v7/classes/dividenddistribution.md)*››*

### get

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

*Defined in* [*src/api/entities/SecurityToken/CorporateActions/Distributions.ts:64*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/SecurityToken/CorporateActions/Distributions.ts#L64)

Retrieve all Dividend Distributions associated to this Security Token

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