CorporateAction

Represents an action initiated by the issuer of an Asset which may affect the positions of the Asset Holders

Hierarchy

↳ CorporateActionBase

↳ CorporateAction

Index

Properties

• asset

• context

• declarationDate

• defaultTaxWithholding

• description

• id

• kind

• targets

• taxWithholdings

• uuid

Methods

• checkpoint

• exists

• isEqual

• linkDocuments

• modifyCheckpoint

• toHuman

• generateUuid

• unserialize

Properties

asset

• asset: Asset

Inherited from CorporateActionBase.asset

Defined in src/api/entities/CorporateActionBase/index.ts:77

Asset affected by this Corporate Action

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

declarationDate

• declarationDate: Date

Inherited from CorporateActionBase.declarationDate

Defined in src/api/entities/CorporateActionBase/index.ts:82

date at which the Corporate Action was created

---

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

Inherited from CorporateActionBase.defaultTaxWithholding

Defined in src/api/entities/CorporateActionBase/index.ts:98

default percentage (0-100) of tax withholding for this Corporate Action

---

description

• description: string

Inherited from CorporateActionBase.description

Defined in src/api/entities/CorporateActionBase/index.ts:87

brief text description of the Corporate Action

---

id

• id: BigNumber

Inherited from CorporateActionBase.id

Defined in src/api/entities/CorporateActionBase/index.ts:72

internal Corporate Action ID

---

Protected kind

• kind: CorporateActionKind

Inherited from CorporateActionBase.kind

Defined in src/api/entities/CorporateActionBase/index.ts:109

type of corporate action being represented

---

targets

• targets: CorporateActionTargets

Inherited from CorporateActionBase.targets

Defined in src/api/entities/CorporateActionBase/index.ts:93

Asset Holder Identities related to this Corporate action. If the treatment is Exclude, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa

---

taxWithholdings

• taxWithholdings: TaxWithholding[]

Inherited from CorporateActionBase.taxWithholdings

Defined in src/api/entities/CorporateActionBase/index.ts:104

percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

checkpoint

▸ checkpoint(): Promise‹Checkpoint | CheckpointSchedule | null›

Inherited from CorporateActionBase.checkpoint

Defined in src/api/entities/CorporateActionBase/index.ts:183

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 | CheckpointSchedule | null›

---

exists

▸ exists(): Promise‹boolean›

Inherited from CorporateActionBase.exists

Overrides Entity.exists

Defined in src/api/entities/CorporateActionBase/index.ts:172

Determine whether this Corporate Action exists on chain

Returns: Promise‹boolean›

---

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

linkDocuments

▸ linkDocuments(args: LinkCaDocsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Inherited from CorporateActionBase.linkDocuments

Defined in src/api/entities/CorporateActionBase/index.ts:152

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, which means you can call linkDocuments.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	LinkCaDocsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

modifyCheckpoint

▸ modifyCheckpoint(args: ModifyCaCheckpointParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Overrides CorporateActionBase.modifyCheckpoint

Defined in src/api/entities/CorporateAction.ts:72

Modify the Corporate Action's Checkpoint

note this method is of type ProcedureMethod, which means you can call modifyCheckpoint.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	ModifyCaCheckpointParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

toHuman

▸ toHuman(): HumanReadable

Inherited from CorporateActionBase.toHuman

Overrides Entity.toHuman

Defined in src/api/entities/CorporateActionBase/index.ts:262

Return the Corporate Action's static data

Returns: HumanReadable

---

Static generateUuid

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

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

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.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers