Polymesh SDK API Reference
v7.0.0
v7.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • Agent
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownPermissionGroup
    • KnownTokenType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenPiaRole
    • TransactionPermissions
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Properties
  • complexity
  • currency
  • data
  • declarationDate
  • defaultTaxWithholding
  • description
  • did
  • expiry
  • expiryDate
  • id
  • issuer
  • maxAmount
  • origin
  • paymentDate
  • perShare
  • period
  • start
  • target
  • targets
  • taxWithholdings
  • ticker

Was this helpful?

  1. Interfaces

HumanReadable

PreviousHistoricSettlementNextIdentityBalance

Last updated 3 years ago

Was this helpful?

Hierarchy

  • HumanReadable

    ↳ HumanReadable

Index

Properties

Properties

complexity

• complexity: number

currency

• currency: string

data

declarationDate

• declarationDate: string

defaultTaxWithholding

• defaultTaxWithholding: string

description

• description: string

did

• did: string

expiry

• expiry: string | null

expiryDate

• expiryDate: string | null

id

• id: string

Overrides void

issuer

maxAmount

• maxAmount: string

origin

paymentDate

• paymentDate: string

perShare

• perShare: string

period

start

• start: string

target

targets

taxWithholdings

ticker

• ticker: string

Overrides void

Defined in

Defined in

• data: ‹›

Defined in

Overrides .

Defined in

Overrides .

Defined in

Overrides .

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

• issuer: ‹›

Defined in

Defined in

• origin: ‹ | ›

Defined in

Defined in

Defined in

• period: | null

Defined in

Defined in

• target:

Defined in

• targets: ‹›

Overrides .

Defined in

• taxWithholdings: ‹[]›

Overrides .

Defined in

Defined in

Defined in

Defined in

Defined in

complexity
currency
data
declarationDate
defaultTaxWithholding
description
did
expiry
expiryDate
id
issuer
maxAmount
origin
paymentDate
perShare
period
start
target
targets
taxWithholdings
ticker
src/api/entities/CheckpointSchedule/index.ts:26
src/api/entities/DividendDistribution/index.ts:63
HumanReadableType
Authorization
src/api/entities/AuthorizationRequest.ts:27
HumanReadable
declarationDate
src/api/entities/CorporateAction/index.ts:38
HumanReadable
defaultTaxWithholding
src/api/entities/CorporateAction/index.ts:41
HumanReadable
description
src/api/entities/CorporateAction/index.ts:39
src/api/entities/Portfolio/index.ts:40
src/api/entities/AuthorizationRequest.ts:25
src/api/entities/CheckpointSchedule/index.ts:25
src/api/entities/DividendDistribution/index.ts:66
src/api/entities/AuthorizationRequest.ts:28
src/api/entities/Sto/index.ts:40
src/api/entities/Portfolio/index.ts:41
src/api/entities/Checkpoint.ts:26
src/api/entities/CheckpointSchedule/index.ts:21
src/api/entities/CorporateAction/index.ts:36
HumanReadableType
Identity
src/api/entities/AuthorizationRequest.ts:24
src/api/entities/DividendDistribution/index.ts:65
HumanReadableType
DefaultPortfolio
NumberedPortfolio
src/api/entities/DividendDistribution/index.ts:62
src/api/entities/DividendDistribution/index.ts:67
src/api/entities/DividendDistribution/index.ts:64
CalendarPeriod
src/api/entities/CheckpointSchedule/index.ts:23
src/api/entities/CheckpointSchedule/index.ts:24
SignerValue
src/api/entities/AuthorizationRequest.ts:26
HumanReadableType
CorporateActionTargets
HumanReadable
targets
src/api/entities/CorporateAction/index.ts:40
HumanReadableType
TaxWithholding
HumanReadable
taxWithholdings
src/api/entities/CorporateAction/index.ts:42
src/api/entities/Sto/index.ts:41
src/api/entities/Checkpoint.ts:27
src/api/entities/CheckpointSchedule/index.ts:22
src/api/entities/CorporateAction/index.ts:37