api_entities_CorporateAction.CorporateAction
Previousapi_entities_CheckpointSchedule.CheckpointScheduleNextapi_entities_CorporateActionBase.CorporateActionBase
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / CorporateAction
.CorporateAction
Represents an action initiated by the issuer of an Asset which may affect the positions of the Asset Holders
↳ CorporateAction
Asset affected by this Corporate Action
Inherited from
Defined in
• declarationDate: Date
date at which the Corporate Action was created
Inherited from
Defined in
• defaultTaxWithholding: BigNumber
default percentage (0-100) of tax withholding for this Corporate Action
Inherited from
Defined in
• description: string
brief text description of the Corporate Action
Inherited from
Defined in
• id: BigNumber
internal Corporate Action ID
Inherited from
Defined in
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
Inherited from
Defined in
percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
Inherited from
Defined in
• uuid: string
Inherited from
Defined in
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
Inherited from
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Corporate Action exists on chain
Returns
Promise<boolean>
Inherited from
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ linkDocuments(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Link a list of documents to this corporate action
note any previous links are removed in favor of the new list
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Inherited from
Defined in
â–¸ modifyCheckpoint(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify the Corporate Action's Checkpoint
Parameters
args
ModifyCaCheckpointParams
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Overrides
Defined in
Return the Corporate Action's static data
Returns
Inherited from
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• asset:
.
.
.
.
.
• targets:
.
• taxWithholdings: []
.
.
â–¸ checkpoint(): Promise<null | | >
Promise<null | | >
.
.
<unknown, unknown>
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
.
â–¸ toHuman():
.
.
.