> 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-v6/classes/portfolio.md).

# Portfolio

Represents a base Portfolio for a specific Identity in the Polymesh blockchain

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v6/classes/entity.md)‹UniqueIdentifiers›

  ↳ **Portfolio**

  ↳ [DefaultPortfolio](/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md)

  ↳ [NumberedPortfolio](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)

## Index

### Properties

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

### Methods

* [getCustodian](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#getcustodian)
* [getTokenBalances](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#gettokenbalances)
* [getTransactionHistory](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#gettransactionhistory)
* [isCustodiedBy](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#iscustodiedby)
* [isEqual](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#isequal)
* [isOwnedBy](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#isownedby)
* [moveFunds](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#movefunds)
* [setCustodian](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#setcustodian)
* [generateUuid](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v6/classes/portfolio.md#static-unserialize)

## Properties

### `Protected` `Optional` \_id

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

*Defined in* [*src/api/entities/Portfolio/index.ts:59*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L59)

internal Portfolio identifier (unused for default Portfolio)

### `Protected` context

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#protected-context)

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

### owner

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

*Defined in* [*src/api/entities/Portfolio/index.ts:54*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L54)

identity of the Portfolio's owner

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#uuid)

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

## Methods

### getCustodian

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

*Defined in* [*src/api/entities/Portfolio/index.ts:220*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L220)

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

### getTokenBalances

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

*Defined in* [*src/api/entities/Portfolio/index.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L119)

Retrieve the balances of all assets in this Portfolio

**Parameters:**

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

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

### getTransactionHistory

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

*Defined in* [*src/api/entities/Portfolio/index.ts:255*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L255)

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-v6/interfaces/resultset.md)*‹*[*HistoricSettlement*](/polymesh-sdk-api-reference/docs-v6/interfaces/historicsettlement.md)*››*

### isCustodiedBy

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

*Defined in* [*src/api/entities/Portfolio/index.ts:103*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L103)

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-v6/classes/entity.md)‹unknown›): *boolean*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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-v6/classes/entity.md)‹unknown› |

**Returns:** *boolean*

### isOwnedBy

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

*Defined in* [*src/api/entities/Portfolio/index.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L87)

Return whether an Identity is the Portfolio owner

**Parameters:**

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

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

### moveFunds

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

*Defined in* [*src/api/entities/Portfolio/index.ts:211*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L211)

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-v6/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-v6/interfaces/movefundsparams.md) |

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

### setCustodian

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

*Defined in* [*src/api/entities/Portfolio/index.ts:198*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Portfolio/index.ts#L198)

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-v6/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-v6/interfaces/setcustodianparams.md) |

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

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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*