> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md).

# NumberedPortfolio

Represents a numbered (non-default) Portfolio for an Identity

## Hierarchy

↳ [Portfolio](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)

↳ **NumberedPortfolio**

## Index

### Properties

* [\_id](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#protected-optional-_id)
* [context](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#protected-context)
* [id](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#id)
* [owner](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#owner)
* [uuid](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#uuid)

### Methods

* [createdAt](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#createdat)
* [delete](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#delete)
* [exists](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#exists)
* [getCustodian](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#getcustodian)
* [getName](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#getname)
* [getTokenBalances](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#gettokenbalances)
* [getTransactionHistory](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#gettransactionhistory)
* [isCustodiedBy](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#iscustodiedby)
* [isEqual](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#isequal)
* [isOwnedBy](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#isownedby)
* [modifyName](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#modifyname)
* [moveFunds](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#movefunds)
* [quitCustody](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#quitcustody)
* [setCustodian](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#setcustodian)
* [toJson](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md#static-unserialize)

## Properties

### `Protected` `Optional` \_id

• **\_id**? : *BigNumber*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*\_id*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#protected-optional-_id)

*Defined in* [*src/api/entities/Portfolio/index.ts:66*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L66)

internal Portfolio identifier (unused for default Portfolio)

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v8/classes/context.md)

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L48)

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L45)

portfolio identifier number

### owner

• **owner**: [*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*owner*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#owner)

*Defined in* [*src/api/entities/Portfolio/index.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L61)

identity of the Portfolio's owner

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L46)

## Methods

### createdAt

▸ **createdAt**(): *Promise‹*[*EventIdentifier*](/polymesh-sdk-api-reference/docs-v8/interfaces/eventidentifier.md) *| null›*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L119)

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this portfolio was created

**`note`** uses the middleware

**`note`** there is a possibility that the data is not ready by the time it is requested. In that case, `null` is returned

**Returns:** *Promise‹*[*EventIdentifier*](/polymesh-sdk-api-reference/docs-v8/interfaces/eventidentifier.md) *| null›*

### delete

▸ **delete**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:76*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L76)

Delete this Portfolio

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod.md), which means you can call `delete.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                             |
| ------- | -------------------------------------------------------------------------------- |
| `args`  | void                                                                             |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:143*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L143)

Return whether this Portfolio exists

**Returns:** *Promise‹boolean›*

### getCustodian

▸ **getCustodian**(): *Promise‹*[*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*›*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*getCustodian*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#getcustodian)

*Defined in* [*src/api/entities/Portfolio/index.ts:244*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L244)

Retrieve the custodian Identity of this Portfolio

**`note`** if no custodian is set, the owner Identity is returned

**Returns:** *Promise‹*[*Identity*](/polymesh-sdk-api-reference/docs-v8/classes/identity.md)*›*

### getName

▸ **getName**(): *Promise‹string›*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:96*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L96)

Return the Portfolio name

**Returns:** *Promise‹string›*

### getTokenBalances

▸ **getTokenBalances**(`args?`: undefined | object): *Promise‹*[*PortfolioBalance*](/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliobalance.md)*\[]›*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*getTokenBalances*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#gettokenbalances)

*Defined in* [*src/api/entities/Portfolio/index.ts:130*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L130)

Retrieve the balances of all assets in this Portfolio

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹*[*PortfolioBalance*](/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliobalance.md)*\[]›*

### getTransactionHistory

▸ **getTransactionHistory**(`filters`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v8/interfaces/resultset.md)*‹*[*HistoricSettlement*](/polymesh-sdk-api-reference/docs-v8/interfaces/historicsettlement.md)*››*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*getTransactionHistory*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#gettransactionhistory)

*Defined in* [*src/api/entities/Portfolio/index.ts:279*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L279)

Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters

**`note`** supports pagination

**`note`** uses the middleware

**Parameters:**

▪`Default value` **filters**: *object*= {}

| Name       | Type                | Description                        |
| ---------- | ------------------- | ---------------------------------- |
| `account?` | undefined \| string | account involved in the settlement |
| `size?`    | undefined \| number | page size                          |
| `start?`   | undefined \| number | page offset                        |
| `ticker?`  | undefined \| string | ticker involved in the transaction |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v8/interfaces/resultset.md)*‹*[*HistoricSettlement*](/polymesh-sdk-api-reference/docs-v8/interfaces/historicsettlement.md)*››*

### isCustodiedBy

▸ **isCustodiedBy**(`args?`: undefined | object): *Promise‹boolean›*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*isCustodiedBy*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#iscustodiedby)

*Defined in* [*src/api/entities/Portfolio/index.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L114)

Return whether an Identity is the Portfolio custodian

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹boolean›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                              |
| -------- | --------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### isOwnedBy

▸ **isOwnedBy**(`args?`: undefined | object): *Promise‹boolean›*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*isOwnedBy*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#isownedby)

*Defined in* [*src/api/entities/Portfolio/index.ts:98*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L98)

Return whether an Identity is the Portfolio owner

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹boolean›*

### modifyName

▸ **modifyName**(`args`: [RenamePortfolioParams](/polymesh-sdk-api-reference/docs-v8/interfaces/renameportfolioparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md)*››*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:89*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/NumberedPortfolio.ts#L89)

Rename portfolio

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod.md), which means you can call `modifyName.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                             |
| ------- | ------------------------------------------------------------------------------------------------ |
| `args`  | [RenamePortfolioParams](/polymesh-sdk-api-reference/docs-v8/interfaces/renameportfolioparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)                 |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio.md)*››*

### moveFunds

▸ **moveFunds**(`args`: [MoveFundsParams](/polymesh-sdk-api-reference/docs-v8/interfaces/movefundsparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*moveFunds*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#movefunds)

*Defined in* [*src/api/entities/Portfolio/index.ts:222*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L222)

Moves funds from this Portfolio to another one owned by the same Identity

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod.md), which means you can call `moveFunds.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                 |
| ------- | ------------------------------------------------------------------------------------ |
| `args`  | [MoveFundsParams](/polymesh-sdk-api-reference/docs-v8/interfaces/movefundsparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)     |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

### quitCustody

▸ **quitCustody**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*quitCustody*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#quitcustody)

*Defined in* [*src/api/entities/Portfolio/index.ts:235*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L235)

Returns the custody of the portfolio to the portfolio owner unilaterally

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod.md), which means you can call `quitCustody.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                             |
| ------- | -------------------------------------------------------------------------------- |
| `args`  | void                                                                             |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

### setCustodian

▸ **setCustodian**(`args`: [SetCustodianParams](/polymesh-sdk-api-reference/docs-v8/interfaces/setcustodianparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*setCustodian*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#setcustodian)

*Defined in* [*src/api/entities/Portfolio/index.ts:209*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L209)

Send an invitation to an Identity to assign it as custodian for this Portfolio

**`note`** this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived`

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod.md), which means you can call `setCustodian.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                       |
| ------- | ------------------------------------------------------------------------------------------ |
| `args`  | [SetCustodianParams](/polymesh-sdk-api-reference/docs-v8/interfaces/setcustodianparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts.md)           |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue.md)*‹void››*

### toJson

▸ **toJson**(): [*HumanReadable*](/polymesh-sdk-api-reference/docs-v8/interfaces/humanreadable.md)

*Inherited from* [*Portfolio*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v8/classes/portfolio.md#tojson)

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/Portfolio/index.ts:353*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Portfolio/index.ts#L353)

Return the Portfolio ID and owner DID

**Returns:** [*HumanReadable*](/polymesh-sdk-api-reference/docs-v8/interfaces/humanreadable.md)

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L14)

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*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v8/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/7362b318/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*