> 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-v3/classes/numberedportfolio.md).

# NumberedPortfolio

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

## Hierarchy

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

↳ **NumberedPortfolio**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` `Optional` \_id

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:53*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L53)

internal Portfolio identifier (unused for default Portfolio)

### `Protected` context

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

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

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

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L38)

portfolio identifier number

### owner

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L48)

identity of the Portfolio's owner

### uuid

• **uuid**: *string*

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

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

## Methods

### createdAt

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

*Defined in* [*src/api/entities/NumberedPortfolio.ts:102*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L102)

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-v3/interfaces/eventidentifier.md) *| null›*

### delete

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

*Defined in* [*src/api/entities/NumberedPortfolio.ts:54*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L54)

Delete this Portfolio

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

### exists

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

*Defined in* [*src/api/entities/NumberedPortfolio.ts:135*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L135)

Return whether this Portfolio exists

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

### getCustodian

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:199*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L199)

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-v3/classes/identity.md)*›*

### getName

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

*Defined in* [*src/api/entities/NumberedPortfolio.ts:79*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L79)

Return the Portfolio name

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

### getTokenBalances

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:104*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L104)

Retrieve the balances of all assets in this Portfolio

**Parameters:**

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

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

### isCustodiedBy

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:88*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L88)

Return whether an Identity is the Portfolio custodian

**Parameters:**

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

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

### isOwnedBy

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L72)

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-v3/interfaces/renameportfolioparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md)*››*

*Defined in* [*src/api/entities/NumberedPortfolio.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/NumberedPortfolio.ts#L65)

Rename portfolio

**Parameters:**

| Name   | Type                                                                                             |
| ------ | ------------------------------------------------------------------------------------------------ |
| `args` | [RenamePortfolioParams](/polymesh-sdk-api-reference/docs-v3/interfaces/renameportfolioparams.md) |

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

### moveFunds

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:190*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L190)

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

**Parameters:**

| Name   | Type                                                                                 |
| ------ | ------------------------------------------------------------------------------------ |
| `args` | [MoveFundsParams](/polymesh-sdk-api-reference/docs-v3/interfaces/movefundsparams.md) |

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

### setCustodian

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

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

*Defined in* [*src/api/entities/Portfolio/index.ts:174*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Portfolio/index.ts#L174)

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`

**Parameters:**

| Name   | Type                                                                                       |
| ------ | ------------------------------------------------------------------------------------------ |
| `args` | [SetCustodianParams](/polymesh-sdk-api-reference/docs-v3/interfaces/setcustodianparams.md) |

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

### `Static` generateUuid

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

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

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

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

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *Identifiers*