# NumberedPortfolio

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

## Hierarchy

↳ [Portfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)

↳ **NumberedPortfolio**

## Index

### Properties

* [\_id](#protected-optional-_id)
* [context](#protected-context)
* [id](#id)
* [owner](#owner)
* [uuid](#uuid)

### Methods

* [createdAt](#createdat)
* [delete](#delete)
* [exists](#exists)
* [getCustodian](#getcustodian)
* [getName](#getname)
* [getTokenBalances](#gettokenbalances)
* [getTransactionHistory](#gettransactionhistory)
* [isCustodiedBy](#iscustodiedby)
* [isEqual](#isequal)
* [isOwnedBy](#isownedby)
* [modifyName](#modifyname)
* [moveFunds](#movefunds)
* [quitCustody](#quitcustody)
* [setCustodian](#setcustodian)
* [toJson](#tojson)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` `Optional` \_id

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*\_id*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/context)

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/identity)

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*owner*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/eventidentifier) *| 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/eventidentifier) *| null›*

### delete

▸ **delete**(`args`: void, `opts?`: [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue)*‹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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue)*‹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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/identity)*›*

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*getCustodian*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/identity)*›*

### 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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliobalance)*\[]›*

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*getTokenBalances*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/portfoliobalance)*\[]›*

### getTransactionHistory

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*getTransactionHistory*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/resultset)*‹*[*HistoricSettlement*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/historicsettlement)*››*

### isCustodiedBy

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*isCustodiedBy*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

### isOwnedBy

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*isOwnedBy*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/renameportfolioparams), `opts?`: [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/transactionqueue)*‹*[*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/numberedportfolio)*››*

*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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/renameportfolioparams) |
| `opts?` | [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts)                 |

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

### moveFunds

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*moveFunds*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/movefundsparams) |
| `opts?` | [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts)     |

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

### quitCustody

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*quitCustody*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts) |

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

### setCustodian

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*setCustodian*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/proceduremethod), 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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/setcustodianparams) |
| `opts?` | [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/procedureopts)           |

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

### toJson

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

*Inherited from* [*Portfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/portfolio)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/portfolio#tojson)

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/interfaces/humanreadable)

### `Static` generateUuid

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v8/entity#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*