# types [@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / types ## Module: types ### Table of contents #### References * [AffirmationStatus](#affirmationstatus) * [AgentWithGroup](#agentwithgroup) * [AssetDetails](#assetdetails) * [CaCheckpointType](#cacheckpointtype) * [CheckpointScheduleParams](#checkpointscheduleparams) * [CorporateActionDefaultConfig](#corporateactiondefaultconfig) * [CorporateActionKind](#corporateactionkind) * [CorporateActionParams](#corporateactionparams) * [CorporateActionTargets](#corporateactiontargets) * [DistributionParticipant](#distributionparticipant) * [DividendDistributionDetails](#dividenddistributiondetails) * [DividendDistributionParams](#dividenddistributionparams) * [HistoricSettlement](#historicsettlement) * [IdentityBalance](#identitybalance) * [InputCaCheckpoint](#inputcacheckpoint) * [InputTargets](#inputtargets) * [InputTaxWithholding](#inputtaxwithholding) * [InstructionAffirmation](#instructionaffirmation) * [InstructionDetails](#instructiondetails) * [InstructionStatus](#instructionstatus) * [InstructionStatusResult](#instructionstatusresult) * [InstructionType](#instructiontype) * [Investment](#investment) * [Leg](#leg) * [OfferingBalanceStatus](#offeringbalancestatus) * [OfferingDetails](#offeringdetails) * [OfferingSaleStatus](#offeringsalestatus) * [OfferingStatus](#offeringstatus) * [OfferingTier](#offeringtier) * [OfferingTimingStatus](#offeringtimingstatus) * [PortfolioBalance](#portfoliobalance) * [ScheduleDetails](#scheduledetails) * [SettlementLeg](#settlementleg) * [SubsidyData](#subsidydata) * [SubsidyWithAllowance](#subsidywithallowance) * [TargetTreatment](#targettreatment) * [TaxWithholding](#taxwithholding) * [TickerReservationDetails](#tickerreservationdetails) * [TickerReservationStatus](#tickerreservationstatus) * [Tier](#tier) * [TransferBreakdown](#transferbreakdown) * [TransferRestrictionResult](#transferrestrictionresult) * [VenueDetails](#venuedetails) * [VenueType](#venuetype) #### Enumerations * [AuthorizationType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype) * [CalendarUnit](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.calendarunit) * [ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.claimtype) * [ConditionTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.conditiontarget) * [ConditionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.conditiontype) * [ErrorCode](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.errorcode) * [KnownAssetType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.knownassettype) * [PayingAccountType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.payingaccounttype) * [PermissionGroupType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.permissiongrouptype) * [PermissionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.permissiontype) * [RoleType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.roletype) * [ScopeType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.scopetype) * [SecurityIdentifierType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.securityidentifiertype) * [SignerType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.signertype) * [TransactionArgumentType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionargumenttype) * [TransactionQueueStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionqueuestatus) * [TransactionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transactionstatus) * [TransferError](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transfererror) * [TransferRestrictionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transferrestrictiontype) * [TransferStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.transferstatus) * [TxGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.txgroup) #### Interfaces * [AccreditedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.accreditedclaim) * [ActiveTransferRestrictions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.activetransferrestrictions) * [AffiliateClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.affiliateclaim) * [ArrayTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.arraytransactionargument) * [AssetDocument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.assetdocument) * [AssetWithGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.assetwithgroup) * [Balance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance) * [BlockedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.blockedclaim) * [BuyLockupClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.buylockupclaim) * [CalendarPeriod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.calendarperiod) * [CddClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim) * [CddProviderRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddproviderrole) * [CheckPermissionsResult](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpermissionsresult) * [CheckRolesResult](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkrolesresult) * [CheckpointWithData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.checkpointwithdata) * [ClaimData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimdata) * [ClaimScope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimscope) * [ClaimTarget](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.claimtarget) * [ComplexTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.complextransactionargument) * [Compliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.compliance) * [ComplianceRequirements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.compliancerequirements) * [ConditionBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase) * [ConditionCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditioncompliance) * [CountTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.counttransferrestriction) * [CountTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.counttransferrestrictioninput) * [DistributionPayment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionpayment) * [DistributionWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.distributionwithdetails) * [EventIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.eventidentifier) * [ExemptKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptkey) * [ExemptedClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptedclaim) * [ExternalAgentCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition) * [ExtrinsicData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdata) * [ExtrinsicDataWithFees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.extrinsicdatawithfees) * [Fees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.fees) * [FeesBreakdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.feesbreakdown) * [GroupedInstructions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.groupedinstructions) * [HistoricAgentOperation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.historicagentoperation) * [IdentityCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition) * [IdentityRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identityrole) * [IdentityWithClaims](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitywithclaims) * [InvestorUniquenessClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim) * [InvestorUniquenessV2Claim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessv2claim) * [JurisdictionClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.jurisdictionclaim) * [KycClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.kycclaim) * [MiddlewareConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.middlewareconfig) * [MultiClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition) * [NetworkProperties](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.networkproperties) * [NoArgsProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod) * [NoDataClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.nodataclaim) * [NoTypeClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.notypeclaim) * [OfferingWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.offeringwithdetails) * [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.paginationoptions) * [PayingAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.payingaccount) * [PercentageTransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.percentagetransferrestriction) * [PercentageTransferRestrictionInput](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.percentagetransferrestrictioninput) * [PermissionGroups](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissiongroups) * [PermissionedAccount](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissionedaccount) * [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions) * [PlainTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.plaintransactionargument) * [PortfolioCustodianRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliocustodianrole) * [PortfolioMovement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliomovement) * [ProcedureAuthorizationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureauthorizationstatus) * [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod) * [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts) * [ProtocolFees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.protocolfees) * [Requirement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirement) * [RequirementCompliance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirementcompliance) * [ResultSet](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset) * [ScheduleWithDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.schedulewithdetails) * [Scope](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.scope) * [SectionPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions) * [SecurityIdentifier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.securityidentifier) * [SellLockupClaim](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.selllockupclaim) * [SignerValue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.signervalue) * [SimpleEnumTransactionArgument](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simpleenumtransactionargument) * [SimplePermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simplepermissions) * [SingleClaimCondition](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition) * [ThirdPartyFees](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.thirdpartyfees) * [TickerOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.tickerownerrole) * [TransactionPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transactionpermissions) * [TransferRestriction](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transferrestriction) * [TrustedClaimIssuer](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.trustedclaimissuer) * [VenueOwnerRole](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.venueownerrole) #### Type Aliases * [AccountBalance](#accountbalance) * [AddRelayerPayingKeyAuthorizationData](#addrelayerpayingkeyauthorizationdata) * [Authorization](#authorization) * [BecomeAgentAuthorizationData](#becomeagentauthorizationdata) * [Claim](#claim) * [Condition](#condition) * [GenericAuthorizationData](#genericauthorizationdata) * [GroupPermissions](#grouppermissions) * [InputCondition](#inputcondition) * [InputConditionBase](#inputconditionbase) * [InputCorporateActionTargets](#inputcorporateactiontargets) * [InputCorporateActionTaxWithholdings](#inputcorporateactiontaxwithholdings) * [InputRequirement](#inputrequirement) * [InputTrustedClaimIssuer](#inputtrustedclaimissuer) * [JoinIdentityAuthorizationData](#joinidentityauthorizationdata) * [NextKey](#nextkey) * [PermissionsLike](#permissionslike) * [PortfolioCustodyAuthorizationData](#portfoliocustodyauthorizationdata) * [PortfolioLike](#portfoliolike) * [PrivateKey](#privatekey) * [Role](#role) * [RotatePrimaryKeyAuthorizationData](#rotateprimarykeyauthorizationdata) * [RotatePrimaryKeyToSecondaryData](#rotateprimarykeytosecondarydata) * [ScopedClaim](#scopedclaim) * [Signer](#signer) * [SubCallback](#subcallback) * [TransactionArgument](#transactionargument) * [UnscopedClaim](#unscopedclaim) * [UnsubCallback](#unsubcallback) ### References #### AffirmationStatus Re-exports [AffirmationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.affirmationstatus) *** #### AgentWithGroup Re-exports [AgentWithGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.agentwithgroup) *** #### AssetDetails Re-exports [AssetDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.assetdetails) *** #### CaCheckpointType Re-exports [CaCheckpointType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_asset_checkpoints_types.cacheckpointtype) *** #### CheckpointScheduleParams Re-exports [CheckpointScheduleParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_checkpointschedule_types#checkpointscheduleparams) *** #### CorporateActionDefaultConfig Re-exports [CorporateActionDefaultConfig](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_corporateactions_types.corporateactiondefaultconfig) *** #### CorporateActionKind Re-exports [CorporateActionKind](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_corporateactionbase_types.corporateactionkind) *** #### CorporateActionParams Renames and re-exports [Params](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase.params) *** #### CorporateActionTargets Re-exports [CorporateActionTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.corporateactiontargets) *** #### DistributionParticipant Re-exports [DistributionParticipant](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.distributionparticipant) *** #### DividendDistributionDetails Re-exports [DividendDistributionDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution_types.dividenddistributiondetails) *** #### DividendDistributionParams Re-exports [DividendDistributionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_dividenddistribution.dividenddistributionparams) *** #### HistoricSettlement Re-exports [HistoricSettlement](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.historicsettlement) *** #### IdentityBalance Re-exports [IdentityBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.identitybalance) *** #### InputCaCheckpoint Re-exports [InputCaCheckpoint](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_asset_checkpoints_types#inputcacheckpoint) *** #### InputTargets Re-exports [InputTargets](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase_types#inputtargets) *** #### InputTaxWithholding Re-exports [InputTaxWithholding](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_corporateactionbase_types#inputtaxwithholding) *** #### InstructionAffirmation Re-exports [InstructionAffirmation](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.instructionaffirmation) *** #### InstructionDetails Re-exports [InstructionDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_instruction_types#instructiondetails) *** #### InstructionStatus Re-exports [InstructionStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus) *** #### InstructionStatusResult Re-exports [InstructionStatusResult](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_instruction_types#instructionstatusresult) *** #### InstructionType Re-exports [InstructionType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructiontype) *** #### Investment Re-exports [Investment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.investment) *** #### Leg Re-exports [Leg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.leg) *** #### OfferingBalanceStatus Re-exports [OfferingBalanceStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringbalancestatus) *** #### OfferingDetails Re-exports [OfferingDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringdetails) *** #### OfferingSaleStatus Re-exports [OfferingSaleStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringsalestatus) *** #### OfferingStatus Re-exports [OfferingStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringstatus) *** #### OfferingTier Re-exports [OfferingTier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.offeringtier) *** #### OfferingTimingStatus Re-exports [OfferingTimingStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_offering_types.offeringtimingstatus) *** #### PortfolioBalance Re-exports [PortfolioBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.portfoliobalance) *** #### ScheduleDetails Re-exports [ScheduleDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_checkpointschedule_types.scheduledetails) *** #### SettlementLeg Re-exports [SettlementLeg](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.settlementleg) *** #### SubsidyData Re-exports [SubsidyData](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidydata) *** #### SubsidyWithAllowance Re-exports [SubsidyWithAllowance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidywithallowance) *** #### TargetTreatment Re-exports [TargetTreatment](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_corporateactionbase_types.targettreatment) *** #### TaxWithholding Re-exports [TaxWithholding](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.taxwithholding) *** #### TickerReservationDetails Re-exports [TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_tickerreservation_types.tickerreservationdetails) *** #### TickerReservationStatus Re-exports [TickerReservationStatus](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_tickerreservation_types.tickerreservationstatus) *** #### Tier Re-exports [Tier](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_offering_types.tier) *** #### TransferBreakdown Re-exports [TransferBreakdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.transferbreakdown) *** #### TransferRestrictionResult Re-exports [TransferRestrictionResult](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_asset_types.transferrestrictionresult) *** #### VenueDetails Re-exports [VenueDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_venue_types.venuedetails) *** #### VenueType Re-exports [VenueType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_venue_types.venuetype) ### Type Aliases #### AccountBalance Ƭ **AccountBalance**: [`Balance`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.balance) **Defined in** [types/index.ts:682](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L682) *** #### AddRelayerPayingKeyAuthorizationData Ƭ **AddRelayerPayingKeyAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`AddRelayerPayingKey`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#addrelayerpayingkey) | | `value` | [`SubsidyData`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_subsidy_types.subsidydata) | **Defined in** [types/index.ts:1062](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1062) *** #### Authorization Ƭ **Authorization**: [`RotatePrimaryKeyAuthorizationData`](#rotateprimarykeyauthorizationdata) | [`JoinIdentityAuthorizationData`](#joinidentityauthorizationdata) | [`PortfolioCustodyAuthorizationData`](#portfoliocustodyauthorizationdata) | [`BecomeAgentAuthorizationData`](#becomeagentauthorizationdata) | [`AddRelayerPayingKeyAuthorizationData`](#addrelayerpayingkeyauthorizationdata) | [`RotatePrimaryKeyToSecondaryData`](#rotateprimarykeytosecondarydata) | [`GenericAuthorizationData`](#genericauthorizationdata) Authorization request data corresponding to type **Defined in** [types/index.ts:1082](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1082) *** #### BecomeAgentAuthorizationData Ƭ **BecomeAgentAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`BecomeAgent`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#becomeagent) | | `value` | [`KnownPermissionGroup`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_knownpermissiongroup.knownpermissiongroup) \| [`CustomPermissionGroup`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_custompermissiongroup.custompermissiongroup) | **Defined in** [types/index.ts:1057](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1057) *** #### Claim Ƭ **Claim**: [`ScopedClaim`](#scopedclaim) | [`UnscopedClaim`](#unscopedclaim) **Defined in** [types/index.ts:307](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L307) *** #### Condition Ƭ **Condition**: [`SingleClaimCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition) | [`MultiClaimCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition) | [`IdentityCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition) | [`ExternalAgentCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition) & [`ConditionBase`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase) **Defined in** [types/index.ts:420](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L420) *** #### GenericAuthorizationData Ƭ **GenericAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | `Exclude`<[`AuthorizationType`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype), [`RotatePrimaryKey`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#rotateprimarykey) \| [`JoinIdentity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#joinidentity) \| [`PortfolioCustody`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#portfoliocustody) \| [`BecomeAgent`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#becomeagent) \| [`AddRelayerPayingKey`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#addrelayerpayingkey) \| [`RotatePrimaryKeyToSecondary`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#rotateprimarykeytosecondary)> | | `value` | `string` | **Defined in** [types/index.ts:1067](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1067) *** #### GroupPermissions Ƭ **GroupPermissions**: `Pick`<[`Permissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions), `"transactions"` | `"transactionGroups"`> Asset permissions shared by agents in a group **Defined in** [types/index.ts:945](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L945) *** #### InputCondition Ƭ **InputCondition**: [`SingleClaimCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.singleclaimcondition) | [`MultiClaimCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.multiclaimcondition) | [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`IdentityCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identitycondition), { `identity`: `string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) }> | [`ExternalAgentCondition`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.externalagentcondition) & [`InputConditionBase`](#inputconditionbase) **Defined in** [types/index.ts:428](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L428) *** #### InputConditionBase Ƭ **InputConditionBase**: [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`ConditionBase`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.conditionbase), { `trustedClaimIssuers?`: [`InputTrustedClaimIssuer`](#inputtrustedclaimissuer)\[] }> **Defined in** [types/index.ts:391](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L391) *** #### InputCorporateActionTargets Ƭ **InputCorporateActionTargets**: [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`CorporateActionTargets`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.corporateactiontargets), { `identities`: (`string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity))\[] }> Targets of a corporate action in a flexible structure for input purposes **Defined in** [types/index.ts:1419](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1419) *** #### InputCorporateActionTaxWithholdings Ƭ **InputCorporateActionTaxWithholdings**: [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`TaxWithholding`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_corporateactionbase_types.taxwithholding), { `identity`: `string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) }>\[] Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes **Defined in** [types/index.ts:1429](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1429) *** #### InputRequirement Ƭ **InputRequirement**: [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`Requirement`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.requirement), { `conditions`: [`InputCondition`](#inputcondition)\[] }> **Defined in** [types/index.ts:454](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L454) *** #### InputTrustedClaimIssuer Ƭ **InputTrustedClaimIssuer**: [`Modify`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/types_utils#modify)<[`TrustedClaimIssuer`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.trustedclaimissuer), { `identity`: `string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) }> **Defined in** [types/index.ts:367](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L367) *** #### JoinIdentityAuthorizationData Ƭ **JoinIdentityAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`JoinIdentity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#joinidentity) | | `value` | [`Permissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions) | **Defined in** [types/index.ts:1047](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1047) *** #### NextKey Ƭ **NextKey**: `string` | `BigNumber` | `null` **Defined in** [types/index.ts:689](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L689) *** #### PermissionsLike Ƭ **PermissionsLike**: { `assets?`: [`SectionPermissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions)<`string` | [`Asset`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset)> | `null` ; `portfolios?`: [`SectionPermissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.sectionpermissions)<[`PortfolioLike`](#portfoliolike)> | `null` } & { `transactions?`: [`TransactionPermissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.transactionpermissions) | `null` } | { `transactionGroups?`: [`TxGroup`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.txgroup)\[] } Permissions to grant to a Signer over an Identity [Permissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions) **`note`** TxGroups in the `transactionGroups` array will be transformed into their corresponding `TxTag`s **Defined in** [types/index.ts:1180](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1180) *** #### PortfolioCustodyAuthorizationData Ƭ **PortfolioCustodyAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`PortfolioCustody`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#portfoliocustody) | | `value` | [`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio) \| [`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio) | **Defined in** [types/index.ts:1052](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1052) *** #### PortfolioLike Ƭ **PortfolioLike**: `string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | [`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio) | [`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio) | { `id`: `BigNumber` ; `identity`: `string` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) } **Defined in** [types/index.ts:1166](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1166) *** #### PrivateKey Ƭ **PrivateKey**: { `uri`: `string` } | { `mnemonic`: `string` } | { `seed`: `string` } URI|mnemonic|hex representation of a private key **Defined in** [types/index.ts:1405](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1405) *** #### Role Ƭ **Role**: [`TickerOwnerRole`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.tickerownerrole) | [`CddProviderRole`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddproviderrole) | [`VenueOwnerRole`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.venueownerrole) | [`PortfolioCustodianRole`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.portfoliocustodianrole) | [`IdentityRole`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.identityrole) **Defined in** [types/index.ts:125](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L125) *** #### RotatePrimaryKeyAuthorizationData Ƭ **RotatePrimaryKeyAuthorizationData**: `Object` **Type declaration** | Name | Type | | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`RotatePrimaryKey`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#rotateprimarykey) | **Defined in** [types/index.ts:1038](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1038) *** #### RotatePrimaryKeyToSecondaryData Ƭ **RotatePrimaryKeyToSecondaryData**: `Object` **Type declaration** | Name | Type | | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [`RotatePrimaryKeyToSecondary`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/enums/types.authorizationtype#rotateprimarykeytosecondary) | | `value` | [`Permissions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.permissions) | **Defined in** [types/index.ts:1042](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1042) *** #### ScopedClaim Ƭ **ScopedClaim**: [`JurisdictionClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.jurisdictionclaim) | [`InvestorUniquenessClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessclaim) | [`AccreditedClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.accreditedclaim) | [`AffiliateClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.affiliateclaim) | [`BuyLockupClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.buylockupclaim) | [`SellLockupClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.selllockupclaim) | [`KycClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.kycclaim) | [`ExemptedClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.exemptedclaim) | [`BlockedClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.blockedclaim) **Defined in** [types/index.ts:294](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L294) *** #### Signer Ƭ **Signer**: [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity) | [`Account`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_account.account) **Defined in** [types/index.ts:1148](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1148) *** #### SubCallback Ƭ **SubCallback**<`T`>: (`result`: `T`) => `void` | `Promise`<`void`> **Type parameters** | Name | | ---- | | `T` | **Type declaration** ▸ (`result`): `void` | `Promise`<`void`> **Parameters** | Name | Type | | -------- | ---- | | `result` | `T` | **Returns** `void` | `Promise`<`void`> **Defined in** [types/index.ts:651](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L651) *** #### TransactionArgument Ƭ **TransactionArgument**: { `_rawType`: `TypeDef` ; `name`: `string` ; `optional`: `boolean` } & [`PlainTransactionArgument`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.plaintransactionargument) | [`ArrayTransactionArgument`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.arraytransactionargument) | [`SimpleEnumTransactionArgument`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.simpleenumtransactionargument) | [`ComplexTransactionArgument`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.complextransactionargument) **Defined in** [types/index.ts:1137](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L1137) *** #### UnscopedClaim Ƭ **UnscopedClaim**: [`NoDataClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.nodataclaim) | [`NoTypeClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.notypeclaim) | [`CddClaim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.cddclaim) | [`InvestorUniquenessV2Claim`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.investoruniquenessv2claim) **Defined in** [types/index.ts:305](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L305) *** #### UnsubCallback Ƭ **UnsubCallback**: () => `void` **Type declaration** ▸ (): `void` **Returns** `void` **Defined in** [types/index.ts:653](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/types/index.ts#L653)