# Distributions

Handles all Security Token Distributions related functionality

## Hierarchy

* Namespace‹[SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/securitytoken)›

  ↳ **Distributions**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)

### Methods

* [configureDividendDistribution](#configuredividenddistribution)
* [get](#get)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/context)

*Inherited from void*

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

### `Protected` parent

• **parent**: [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/securitytoken)

*Inherited from void*

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

## Methods

### configureDividendDistribution

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

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

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

**`note`** required role:

* Origin Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/globals#configuredividenddistributionparams) |
| `opts?` | [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts)                                          |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue)*‹*[*DividendDistribution*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/dividenddistribution)*››*

### get

▸ **get**(): *Promise‹*[*DistributionWithDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/distributionwithdetails)*\[]›*

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

Retrieve all Dividend Distributions associated to this Security Token

**Returns:** *Promise‹*[*DistributionWithDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/distributionwithdetails)*\[]›*