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

# api\_entities\_NumberedPortfolio.NumberedPortfolio

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / [api/entities/NumberedPortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_numberedportfolio.md) / NumberedPortfolio

## Class: NumberedPortfolio

[api/entities/NumberedPortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_numberedportfolio.md).NumberedPortfolio

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

### Hierarchy

* [`Portfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md)

  ↳ **`NumberedPortfolio`**

### Table of contents

#### Properties

* [id](#id)
* [owner](#owner)
* [uuid](#uuid)

#### Methods

* [createdAt](#createdat)
* [exists](#exists)
* [getAssetBalances](#getassetbalances)
* [getCustodian](#getcustodian)
* [getName](#getname)
* [getTransactionHistory](#gettransactionhistory)
* [isCustodiedBy](#iscustodiedby)
* [isEqual](#isequal)
* [isOwnedBy](#isownedby)
* [modifyName](#modifyname)
* [moveFunds](#movefunds)
* [quitCustody](#quitcustody)
* [setCustodian](#setcustodian)
* [toHuman](#tohuman)
* [generateUuid](#generateuuid)
* [unserialize](#unserialize)

### Properties

#### id

• **id**: `BigNumber`

Portfolio identifier number

**Defined in**

[api/entities/NumberedPortfolio.ts:46](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/NumberedPortfolio.ts#L46)

***

#### owner

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

Identity of the Portfolio's owner

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[owner](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#owner)

**Defined in**

[api/entities/Portfolio/index.ts:75](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L75)

***

#### uuid

• **uuid**: `string`

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[uuid](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#uuid)

**Defined in**

[api/entities/Entity.ts:46](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L46)

### Methods

#### createdAt

▸ **createdAt**(): `Promise`<`null` | [`EventIdentifier`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.eventidentifier.md)>

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`<`null` | [`EventIdentifier`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.eventidentifier.md)>

**Defined in**

[api/entities/NumberedPortfolio.ts:112](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/NumberedPortfolio.ts#L112)

***

#### exists

▸ **exists**(): `Promise`<`boolean`>

Return whether this Portfolio exists

**Returns**

`Promise`<`boolean`>

**Overrides**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[exists](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#exists)

**Defined in**

[api/entities/NumberedPortfolio.ts:136](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/NumberedPortfolio.ts#L136)

***

#### getAssetBalances

▸ **getAssetBalances**(`args?`): `Promise`<[`PortfolioBalance`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.portfoliobalance.md)\[]>

Retrieve the balances of all Assets in this Portfolio

**Parameters**

| Name          | Type                                                                                                   | Description                                                                                                   |
| ------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| `args?`       | `Object`                                                                                               | -                                                                                                             |
| `args.assets` | (`string` \| [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md))\[] | array of Assets (or tickers) for which to fetch balances (optional, all balances are retrieved if not passed) |

**Returns**

`Promise`<[`PortfolioBalance`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.portfoliobalance.md)\[]>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[getAssetBalances](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#getassetbalances)

**Defined in**

[api/entities/Portfolio/index.ts:141](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L141)

***

#### getCustodian

▸ **getCustodian**(): `Promise`<[`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md)>

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-alpha/classes/api_entities_identity.identity.md)>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[getCustodian](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#getcustodian)

**Defined in**

[api/entities/Portfolio/index.ts:271](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L271)

***

#### getName

▸ **getName**(): `Promise`<`string`>

Return the Portfolio name

**Returns**

`Promise`<`string`>

**Defined in**

[api/entities/NumberedPortfolio.ts:80](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/NumberedPortfolio.ts#L80)

***

#### getTransactionHistory

▸ **getTransactionHistory**(`filters?`): `Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`HistoricSettlement`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.historicsettlement.md)>>

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

**`note`** supports pagination

**`note`** uses the middleware

**Parameters**

| Name               | Type        | Description                        |
| ------------------ | ----------- | ---------------------------------- |
| `filters`          | `Object`    | -                                  |
| `filters.account?` | `string`    | Account involved in the settlement |
| `filters.size?`    | `BigNumber` | page size                          |
| `filters.start?`   | `BigNumber` | page offset                        |
| `filters.ticker?`  | `string`    | ticker involved in the transaction |

**Returns**

`Promise`<[`ResultSet`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset.md)<[`HistoricSettlement`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_portfolio_types.historicsettlement.md)>>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[getTransactionHistory](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#gettransactionhistory)

**Defined in**

[api/entities/Portfolio/index.ts:316](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L316)

***

#### isCustodiedBy

▸ **isCustodiedBy**(`args?`): `Promise`<`boolean`>

Return whether an Identity is the Portfolio custodian

**Parameters**

| Name            | Type                                                                                                       | Description                                |
| --------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `args?`         | `Object`                                                                                                   | -                                          |
| `args.identity` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | optional, defaults to the signing Identity |

**Returns**

`Promise`<`boolean`>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[isCustodiedBy](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#iscustodiedby)

**Defined in**

[api/entities/Portfolio/index.ts:125](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L125)

***

#### isEqual

▸ **isEqual**(`entity`): `boolean`

Determine whether this Entity is the same as another one

**Parameters**

| Name     | Type                                                                                                           |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| `entity` | [`Entity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity.md)<`unknown`, `unknown`> |

**Returns**

`boolean`

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[isEqual](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#isequal)

**Defined in**

[api/entities/Entity.ts:61](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L61)

***

#### isOwnedBy

▸ **isOwnedBy**(`args?`): `Promise`<`boolean`>

Return whether an Identity is the Portfolio owner

**Parameters**

| Name            | Type                                                                                                       | Description                      |
| --------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `args?`         | `Object`                                                                                                   | -                                |
| `args.identity` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | defaults to the signing Identity |

**Returns**

`Promise`<`boolean`>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[isOwnedBy](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#isownedby)

**Defined in**

[api/entities/Portfolio/index.ts:112](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L112)

***

#### modifyName

▸ **modifyName**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md), [`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md), `unknown`\[]\[]>>

Rename portfolio

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [modifyName.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

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

**Returns**

`Promise`<`TransactionQueue`<[`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md), [`NumberedPortfolio`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio.md), `unknown`\[]\[]>>

**Defined in**

[api/entities/NumberedPortfolio.ts:73](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/NumberedPortfolio.ts#L73)

***

#### moveFunds

▸ **moveFunds**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

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-alpha/interfaces/types.proceduremethod.md), which means you can call [moveFunds.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

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

**Returns**

`Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[moveFunds](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#movefunds)

**Defined in**

[api/entities/Portfolio/index.ts:249](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L249)

***

#### quitCustody

▸ **quitCustody**(`opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Returns the custody of the portfolio to the portfolio owner unilaterally

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [NoArgsProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod.md), which means you can call [quitCustody.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.noargsproceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

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

**Returns**

`Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[quitCustody](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#quitcustody)

**Defined in**

[api/entities/Portfolio/index.ts:262](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L262)

***

#### setCustodian

▸ **setCustodian**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), [`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), `unknown`\[]\[]>>

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

**`note`** this will create an [Authorization Request](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md) which has to be accepted by the `targetIdentity`. An [Account](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_account.account.md) or [Identity](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) can fetch its pending Authorization Requests by calling [authorizations.getReceived](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_common_namespaces_authorizations.authorizations.md#getreceived). Also, an Account or Identity can directly fetch the details of an Authorization Request by calling [authorizations.getOne](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_common_namespaces_authorizations.authorizations.md#getone)

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [setCustodian.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

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

**Returns**

`Promise`<`TransactionQueue`<[`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), [`AuthorizationRequest`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_authorizationrequest.authorizationrequest.md), `unknown`\[]\[]>>

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[setCustodian](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#setcustodian)

**Defined in**

[api/entities/Portfolio/index.ts:236](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L236)

***

#### toHuman

▸ **toHuman**(): `HumanReadable`

Return the Portfolio ID and owner DID

**Returns**

`HumanReadable`

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[toHuman](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#tohuman)

**Defined in**

[api/entities/Portfolio/index.ts:413](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Portfolio/index.ts#L413)

***

#### generateUuid

▸ `Static` **generateUuid**<`Identifiers`>(`identifiers`): `string`

Generate the Entity's UUID from its identifying properties

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`string`

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[generateUuid](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#generateuuid)

**Defined in**

[api/entities/Entity.ts:14](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L14)

***

#### unserialize

▸ `Static` **unserialize**<`Identifiers`>(`serialized`): `Identifiers`

Unserialize a UUID into its Unique Identifiers

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`Identifiers`

**Inherited from**

[Portfolio](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md).[unserialize](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_portfolio.portfolio.md#unserialize)

**Defined in**

[api/entities/Entity.ts:23](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L23)