> 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-v8/classes/corporateaction.md).

# CorporateAction

Represents an action initiated by the issuer of a Security Token which may affect the positions of the Tokenholders

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)‹UniqueIdentifiers, unknown›

  ↳ **CorporateAction**

  ↳ [DividendDistribution](/polymesh-sdk-api-reference/docs-v8/classes/dividenddistribution.md)

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#protected-context)
* [declarationDate](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#declarationdate)
* [defaultTaxWithholding](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#defaulttaxwithholding)
* [description](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#description)
* [id](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#id)
* [kind](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#protected-kind)
* [targets](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#targets)
* [taxWithholdings](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#taxwithholdings)
* [ticker](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#ticker)
* [uuid](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#uuid)

### Methods

* [checkpoint](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#checkpoint)
* [exists](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#exists)
* [isEqual](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#isequal)
* [linkDocuments](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#linkdocuments)
* [modifyCheckpoint](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#modifycheckpoint)
* [toJson](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v8/classes/corporateaction.md#static-unserialize)

## Properties

### `Protected` context

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L48)

### declarationDate

• **declarationDate**: *Date*

*Defined in* [*src/api/entities/CorporateAction/index.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L82)

date at which the Corporate Action was created

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

*Defined in* [*src/api/entities/CorporateAction/index.ts:98*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L98)

default percentage of tax withholding for this Corporate Action

### description

• **description**: *string*

*Defined in* [*src/api/entities/CorporateAction/index.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L87)

brief text description of the Corporate Action

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/CorporateAction/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L72)

internal Corporate Action ID

### `Protected` kind

• **kind**: [*CorporateActionKind*](/polymesh-sdk-api-reference/docs-v8/enums/corporateactionkind.md)

*Defined in* [*src/api/entities/CorporateAction/index.ts:106*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L106)

### targets

• **targets**: [*CorporateActionTargets*](/polymesh-sdk-api-reference/docs-v8/interfaces/corporateactiontargets.md)

*Defined in* [*src/api/entities/CorporateAction/index.ts:93*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L93)

tokenholder identities related to this Corporate action. If the treatment is `Exclude`, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

### taxWithholdings

• **taxWithholdings**: [*TaxWithholding*](/polymesh-sdk-api-reference/docs-v8/interfaces/taxwithholding.md)*\[]*

*Defined in* [*src/api/entities/CorporateAction/index.ts:104*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L104)

percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/CorporateAction/index.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L77)

ticker of the Security Token

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L46)

## Methods

### checkpoint

▸ **checkpoint**(): *Promise‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v8/classes/checkpoint.md) *|* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v8/classes/checkpointschedule.md) *| null›*

*Defined in* [*src/api/entities/CorporateAction/index.ts:187*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L187)

Retrieve the Checkpoint associated with this Corporate Action. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead. A null value means the Corporate Action was created without an associated Checkpoint

**Returns:** *Promise‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v8/classes/checkpoint.md) *|* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v8/classes/checkpointschedule.md) *| null›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/CorporateAction/index.ts:176*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L176)

Retrieve whether the Corporate Action exists

**Returns:** *Promise‹boolean›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                              |
| -------- | --------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### linkDocuments

▸ **linkDocuments**(`args`: [LinkCaDocsParams](/polymesh-sdk-api-reference/docs-v8/interfaces/linkcadocsparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/CorporateAction/index.ts:159*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L159)

Link a list of documents to this corporate action

**`note`** any previous links are removed in favor of the new list

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

**Parameters:**

| Name    | Type                                                                                   |
| ------- | -------------------------------------------------------------------------------------- |
| `args`  | [LinkCaDocsParams](/polymesh-sdk-api-reference/docs-v8/interfaces/linkcadocsparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)       |

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

### modifyCheckpoint

▸ **modifyCheckpoint**(`args`: ModifyCaCheckpointParams, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/CorporateAction/index.ts:169*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L169)

Modify the Corporate Action's Checkpoint

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

**Parameters:**

| Name    | Type                                                                             |
| ------- | -------------------------------------------------------------------------------- |
| `args`  | ModifyCaCheckpointParams                                                         |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md) |

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

### toJson

▸ **toJson**(): *HumanReadable*

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/CorporateAction/index.ts:266*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/CorporateAction/index.ts#L266)

Return the Corporate Action's static data

**Returns:** *HumanReadable*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*