CorporateAction

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

Hierarchy

• Entity‹UniqueIdentifiers, unknown›

  ↳ CorporateAction

  ↳ DividendDistribution

Index

Properties

• context

• declarationDate

• defaultTaxWithholding

• description

• id

• kind

• targets

• taxWithholdings

• ticker

• uuid

Methods

• checkpoint

• exists

• isEqual

• linkDocuments

• modifyCheckpoint

• toJson

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

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

declarationDate

• declarationDate: Date

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

date at which the Corporate Action was created

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

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

default percentage of tax withholding for this Corporate Action

description

• description: string

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

brief text description of the Corporate Action

id

• id: BigNumber

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

internal Corporate Action ID

Protected kind

• kind: CorporateActionKind

Defined in src/api/entities/CorporateAction/index.ts:106

targets

• targets: CorporateActionTargets

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

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[]

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

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

ticker of the Security Token

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

checkpoint

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

Defined in src/api/entities/CorporateAction/index.ts:189

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›

Defined in src/api/entities/CorporateAction/index.ts:178

Retrieve whether the Corporate Action exists

Returns: Promise‹boolean›

isEqual

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

Inherited from Entity.isEqual

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

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

Defined in src/api/entities/CorporateAction/index.ts:161

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, 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
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

modifyCheckpoint

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

Defined in src/api/entities/CorporateAction/index.ts:171

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 Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifyCaCheckpointParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

▸ toJson(): HumanReadable

Overrides Entity.toJson

Defined in src/api/entities/CorporateAction/index.ts:268

Return the Corporate Action's static data

Returns: HumanReadable

Static generateUuid

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

Inherited from Entity.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 Entity.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