CorporateAction
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents an action initiated by the issuer of a Security Token which may affect the positions of the Tokenholders
‹UniqueIdentifiers, unknown›
↳ CorporateAction
↳
Protected context• declarationDate: Date
date at which the Corporate Action was created
• defaultTaxWithholding: BigNumber
default percentage of tax withholding for this Corporate Action
• description: string
brief text description of the Corporate Action
• id: BigNumber
internal Corporate Action ID
Protected kindtokenholder 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
percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
• ticker: string
ticker of the Security Token
• uuid: string
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
▸ exists(): Promise‹boolean›
Retrieve whether the Corporate Action exists
Returns: Promise‹boolean›
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
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
Parameters:
Name
Type
args
opts?
Modify the Corporate Action's Checkpoint
Parameters:
Name
Type
args
ModifyCaCheckpointParams
opts?
â–¸ toJson(): HumanReadable
Return the Corporate Action's static data
Returns: HumanReadable
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
• context:
Inherited from .
Defined in
Defined in
Defined in
Defined in
Defined in
• kind:
Defined in
• targets:
Defined in
• taxWithholdings: []
Defined in
Defined in
Inherited from .
Defined in
▸ checkpoint(): Promise‹ | | null›
Defined in
Returns: Promise‹ | | null›
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
▸ linkDocuments(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call linkDocuments.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ modifyCheckpoint(args: ModifyCaCheckpointParams, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call modifyCheckpoint.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Overrides .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in