# Distributions

Handles all Security Token Distributions related functionality

## Hierarchy

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

  ↳ **Distributions**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

***

### `Protected` parent

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

*Inherited from void*

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

## Methods

### configureDividendDistribution

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

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

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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/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](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/globals#configuredividenddistributionparams) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/procedureopts.md)                                           |

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

***

### get

▸ **get**(): *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionwithdetails.md)*\[]›*

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

Retrieve all Dividend Distributions associated to this Security Token, along with their details

**Returns:** *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionwithdetails.md)*\[]›*

***

### getOne

▸ **getOne**(`args`: object): *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionwithdetails.md)*›*

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

Retrieve a single Dividend Distribution associated to this Security Token by its ID

**`throws`** if there is no Distribution with the passed ID

**Parameters:**

▪ **args**: *object*

| Name | Type      |
| ---- | --------- |
| `id` | BigNumber |

**Returns:** *Promise‹*[*DistributionWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/distributionwithdetails.md)*›*