@polymeshassociation/polymesh-sdk / api/entities/CorporateAction

Defined in: api/entities/CorporateAction.ts:42

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

• CorporateActionBase

asset: FungibleAsset

Defined in: api/entities/CorporateActionBase/index.ts:85

Asset affected by this Corporate Action

CorporateActionBase.asset

declarationDate: Date

Defined in: api/entities/CorporateActionBase/index.ts:90

date at which the Corporate Action was created

CorporateActionBase.declarationDate

defaultTaxWithholding: BigNumber

Defined in: api/entities/CorporateActionBase/index.ts:106

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

CorporateActionBase.defaultTaxWithholding

description: string

Defined in: api/entities/CorporateActionBase/index.ts:95

brief text description of the Corporate Action

CorporateActionBase.description

id: BigNumber

Defined in: api/entities/CorporateActionBase/index.ts:80

internal Corporate Action ID

CorporateActionBase.id

targets: CorporateActionTargets

Defined in: api/entities/CorporateActionBase/index.ts:101

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

CorporateActionBase.targets

taxWithholdings: TaxWithholding[]

Defined in: api/entities/CorporateActionBase/index.ts:112

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

CorporateActionBase.taxWithholdings

uuid: string

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

CorporateActionBase.uuid

checkpoint(): Promise<Checkpoint | CheckpointSchedule | null>

Defined in: api/entities/CorporateActionBase/index.ts:229

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

Promise<Checkpoint | CheckpointSchedule | null>

CorporateActionBase.checkpoint

exists(): Promise<boolean>

Defined in: api/entities/CorporateActionBase/index.ts:218

Determine whether this Corporate Action exists on chain

Promise<boolean>

CorporateActionBase.exists

getDocuments(): Promise<AssetDocumentWithId[]>

Defined in: api/entities/CorporateActionBase/index.ts:167

Retrieve the documents linked to this Corporate Action

Promise<AssetDocumentWithId[]>

CorporateActionBase.getDocuments

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

CorporateActionBase.isEqual

linkDocuments(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/CorporateActionBase/index.ts:162

Link a list of documents to this corporate action

Parameter	Type
args	LinkCaDocsParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

any previous links are removed in favor of the new list

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

CorporateActionBase.linkDocuments

modifyCheckpoint(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/CorporateAction.ts:63

Modify the Corporate Action's Checkpoint

Parameter	Type
args	ModifyCaCheckpointParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

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

CorporateActionBase.modifyCheckpoint

toHuman(): HumanReadable

Defined in: api/entities/CorporateActionBase/index.ts:315

Return the Corporate Action's static data

HumanReadable

CorporateActionBase.toHuman

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

CorporateActionBase.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

CorporateActionBase.unserialize

Defined in: api/entities/CorporateAction.ts:19

• HumanReadable

assetId: string

Defined in: api/entities/CorporateAction.ts:21

declarationDate: string

Defined in: api/entities/CorporateAction.ts:22

defaultTaxWithholding: string

Defined in: api/entities/CorporateAction.ts:25

description: string

Defined in: api/entities/CorporateAction.ts:23

id: string

Defined in: api/entities/CorporateAction.ts:20

targets: object

Defined in: api/entities/CorporateAction.ts:24

identities: string[]

treatment: TargetTreatment

taxWithholdings: object[]

Defined in: api/entities/CorporateAction.ts:26

identity: string

percentage: string

---

Defined in: api/entities/CorporateAction.ts:29

declarationDate: Date

Defined in: api/entities/CorporateAction.ts:31

defaultTaxWithholding: BigNumber

Defined in: api/entities/CorporateAction.ts:34

description: string

Defined in: api/entities/CorporateAction.ts:32

kind: CorporateActionKind

Defined in: api/entities/CorporateAction.ts:30

targets: CorporateActionTargets

Defined in: api/entities/CorporateAction.ts:33

taxWithholdings: TaxWithholding[]

Defined in: api/entities/CorporateAction.ts:35

---

Defined in: api/entities/CorporateAction.ts:14

assetId: string

Defined in: api/entities/CorporateAction.ts:16

id: BigNumber

Defined in: api/entities/CorporateAction.ts:15