# CorporateAction

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

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/entity)‹UniqueIdentifiers›

  ↳ **CorporateAction**

  ↳ [DividendDistribution](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/dividenddistribution)

## Index

### Properties

* [context](#protected-context)
* [declarationDate](#declarationdate)
* [defaultTaxWithholding](#defaulttaxwithholding)
* [description](#description)
* [id](#id)
* [kind](#protected-kind)
* [targets](#targets)
* [taxWithholdings](#taxwithholdings)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [checkpoint](#checkpoint)
* [exists](#exists)
* [isEqual](#isequal)
* [linkDocuments](#linkdocuments)
* [modifyCheckpoint](#modifycheckpoint)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

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

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#protected-context)

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

### declarationDate

• **declarationDate**: *Date*

*Defined in* [*src/api/entities/CorporateAction/index.ts:70*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L70)

date at which the Corporate Action was created

### defaultTaxWithholding

• **defaultTaxWithholding**: *BigNumber*

*Defined in* [*src/api/entities/CorporateAction/index.ts:86*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L86)

default percentage of tax withholding for this Corporate Action

### description

• **description**: *string*

*Defined in* [*src/api/entities/CorporateAction/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L75)

brief text description of the Corporate Action

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/CorporateAction/index.ts:60*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L60)

internal Corporate Action ID

### `Protected` kind

• **kind**: [*CorporateActionKind*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/corporateactionkind)

*Defined in* [*src/api/entities/CorporateAction/index.ts:94*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L94)

### targets

• **targets**: [*CorporateActionTargets*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/corporateactiontargets)

*Defined in* [*src/api/entities/CorporateAction/index.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L81)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/taxwithholding)*\[]*

*Defined in* [*src/api/entities/CorporateAction/index.ts:92*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L92)

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:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L65)

ticker of the Security Token

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#uuid)

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

## Methods

### checkpoint

▸ **checkpoint**(): *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint) *|* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule) *| null›*

*Defined in* [*src/api/entities/CorporateAction/index.ts:177*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L177)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint) *|* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule) *| null›*

### exists

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

*Defined in* [*src/api/entities/CorporateAction/index.ts:166*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L166)

Retrieve whether the Corporate Action exists

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

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/entity)‹unknown›): *boolean*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#isequal)

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

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                     |
| -------- | -------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/entity)‹unknown› |

**Returns:** *boolean*

### linkDocuments

▸ **linkDocuments**(`args`: [LinkCaDocsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/linkcadocsparams)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹void››*

*Defined in* [*src/api/entities/CorporateAction/index.ts:149*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/CorporateAction/index.ts#L149)

Link a list of documents to this corporate action

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

**`note`** required role:

* Corporate Actions Agent

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/linkcadocsparams) |

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

### modifyCheckpoint

▸ **modifyCheckpoint**(`args`: ModifyCaCheckpointParams): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹void››*

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

Modify the Corporate Action's Checkpoint

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

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

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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*