Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • 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
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • 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
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
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
  • type

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: BigNumber

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

type

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

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

Defined in

Defined in

• type:

Defined in

src/api/entities/CheckpointSchedule/index.ts:26
src/api/entities/DividendDistribution/index.ts:63
src/api/entities/AuthorizationRequest.ts:32
src/api/entities/CorporateAction/index.ts:38
src/api/entities/CorporateAction/index.ts:41
src/api/entities/CorporateAction/index.ts:39
src/api/entities/Portfolio/index.ts:47
src/api/entities/AuthorizationRequest.ts:30
src/api/entities/CheckpointSchedule/index.ts:25
src/api/entities/DividendDistribution/index.ts:66
src/api/entities/AuthorizationRequest.ts:33
src/api/entities/Sto/index.ts:40
src/api/entities/Portfolio/index.ts:48
src/api/entities/Checkpoint.ts:26
src/api/entities/CheckpointSchedule/index.ts:21
src/api/entities/CorporateAction/index.ts:36
src/api/entities/CustomPermissionGroup.ts:22
src/api/entities/AuthorizationRequest.ts:29
src/api/entities/DividendDistribution/index.ts:65
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:31
src/api/entities/CorporateAction/index.ts:40
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/KnownPermissionGroup.ts:8
src/api/entities/CorporateAction/index.ts:37
src/api/entities/CustomPermissionGroup.ts:23
PermissionGroupType
src/api/entities/KnownPermissionGroup.ts:7
complexity
currency
data
declarationDate
defaultTaxWithholding
description
did
expiry
expiryDate
id
issuer
maxAmount
origin
paymentDate
perShare
period
start
target
targets
taxWithholdings
ticker
type
HumanReadable
declarationDate
HumanReadable
defaultTaxWithholding
HumanReadable
description
HumanReadable
targets
HumanReadable
taxWithholdings
Identity
DefaultPortfolio
NumberedPortfolio
CorporateActionTargets
TaxWithholding
HumanReadableType
Authorization
HumanReadableType
HumanReadableType
HumanReadableType
HumanReadableType