# Portfolio Type

#### **Table of Contents**

- [Description](#bkmrk-description)
- [Examples](#bkmrk-examples)
- [Cookbook](#bkmrk-cookbook)
- [F.A.Q.](#bkmrk-api-documentation)
- [API Documentation](#bkmrk-api-documentation)

#### **Description**

##### *Financial meaning*

**Portfolio Type** has no specific financial meaning, it's a logical configure-defined classification of the portfolios, help to differentiate manual portfolios from transaction and position based portfolios.

##### *Platform abstraction*

**Portfolio Type** is an entity designed as a criterion for comparing portfolios against each other, defining configured-defined groups with the Portfolio Classes. **Portfolio Classes** represents the primary attribute, with pre-defined classes for reconciliation calculation and filtering purposes in the reports, entity viewers:

- `General Portfolio`: Consists of banking transactions and/or a combination of initial positions and banking transactions.
- `Manual Managed Portfolio`: Managed through manual transaction booking within the system or imported from the client's internal manual tracking systems for bank verification purposes.
- `Position Only Portfolio`: Focuses on importing balance states for a specific day using Daily Positions/Cash transaction types.

**It's used in:**

- [reconciliation](https://docs.finmars.com/books/reports/chapter/reconciliation "Reconciliation") using [portfolio](https://docs.finmars.com/books/entities/chapter/portfolio "Portfolio") and [portfolio reconcile group](https://docs.finmars.com/books/entities/page/portfolio-reconcile-group "Portfolio Reconcile Group").

#### **Examples**

<table border="1" id="bkmrk-user-code-portfolio-" style="border-collapse: collapse; width: 100%; height: 76.5452px;"><colgroup><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col><col style="width: 14.2857%;"></col></colgroup><tbody><tr style="height: 46.6667px;"><td style="height: 46.6667px;">**User code**</td><td style="height: 46.6667px;">**Portfolio class**</td><td style="height: 46.6667px;">**Short name**</td><td style="height: 46.6667px;">**Name**</td><td style="height: 46.6667px;">**Public name** </td><td style="height: 46.6667px;">**Notes** </td><td style="height: 46.6667px;">**Configuration code**</td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px;">com.finmars.standard-other:portfolios.portfoliotype:general</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">General Portfolio</td><td style="height: 29.8785px;">  
</td><td style="height: 29.8785px;">  
</td><td style="height: 29.8785px;">com.finmars.standard-other</td></tr></tbody></table>

- `<strong data-end="158" data-start="145">User code</strong>`: workspace-unique identifier of the portfolio type with source prefix
- `<strong data-end="288" data-start="269">Portfolio class</strong>`: classification used to define general behavior or usage category of the portfolio (e.g., General, Manual Managed)
- `<strong data-end="422" data-start="408">Short name</strong>`: compact label shown in lists and relations for easier navigation
- `<strong data-end="501" data-start="493">Name</strong>`: full descriptive name of the portfolio type
- `<strong data-end="566" data-start="551">Public name</strong>`: label shown to users without configuration access; often used in reports
- `<strong data-end="654" data-start="645">Notes</strong>`: optional custom description or comment field for internal purposes
- `<strong data-end="749" data-start="727">Configuration code</strong>`: reference to the configuration source that governs the behavior of this portfolio type

#### **Cookbook**

##### *CRUD* 

- **Create:** A new portfolio type can be created using the "+" button in the upper-right corner of the page. Users must provide the configuration code, user code, portfolio class, short name, name, public name, and optional notes.
- **Read:** The same page provides a list of all existing portfolio types. Users can search, filter, and review attributes such as class, names, and configuration references.
- **Update:** To edit a portfolio type, users can click on an existing entry to open the edit form. All fields—except those constrained by platform rules—can be modified, including the classification and public-facing labels.
- **Delete:** Portfolio types can be deleted directly from the management page.

##### *Use Cases*

- Portfolio Types help categorize portfolios by behavior, such as whether they are general-purpose, manually managed, or used solely for reconciliation. These classifications are leveraged in reporting filters and entity viewers.
- Fields like Short Name and Public Name allow different representations for internal use and external presentation. This is useful in environments where access permissions differ across user roles.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.