> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/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/classic-sdk/beta/external-modules/_entities_investment_.investment.md).

# Investment

Used to manage an Investment in a Security Token Offering

## Hierarchy

* [Entity](broken://pages/-M-tw-_WeBJcuS0_s0nR)‹[Params](broken://pages/-M-tw-bW4VvZPauRigKN)›

  ↳ **Investment**

## Index

### Constructors

* [constructor](broken://pages/-M-tw-_YeXyeoVULDYhp#constructor)

### Properties

* [address](broken://pages/-M-tw-_YeXyeoVULDYhp#address)
* [index](broken://pages/-M-tw-_YeXyeoVULDYhp#index)
* [investedFunds](broken://pages/-M-tw-_YeXyeoVULDYhp#investedfunds)
* [securityTokenId](broken://pages/-M-tw-_YeXyeoVULDYhp#securitytokenid)
* [securityTokenSymbol](broken://pages/-M-tw-_YeXyeoVULDYhp#securitytokensymbol)
* [stoId](broken://pages/-M-tw-_YeXyeoVULDYhp#stoid)
* [tokenAmount](broken://pages/-M-tw-_YeXyeoVULDYhp#tokenamount)
* [uid](broken://pages/-M-tw-_YeXyeoVULDYhp#uid)

### Methods

* [\_refresh](broken://pages/-M-tw-_YeXyeoVULDYhp#_refresh)
* [toPojo](broken://pages/-M-tw-_YeXyeoVULDYhp#topojo)
* [generateId](broken://pages/-M-tw-_YeXyeoVULDYhp#static-generateid)
* [unserialize](broken://pages/-M-tw-_YeXyeoVULDYhp#static-unserialize)

## Constructors

### constructor

\+ **new Investment**(`params`: [Params](broken://pages/-M-tw-bW4VvZPauRigKN) & [UniqueIdentifiers](broken://pages/-M-tw-bX919FyV5GCiW3)): [*Investment*](broken://pages/-M-tw-_YeXyeoVULDYhp)

*Defined in* [*src/entities/Investment.ts:103*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L103)

Create an Investment instance

**Parameters:**

| Name     | Type                                                                                                     |
| -------- | -------------------------------------------------------------------------------------------------------- |
| `params` | [Params](broken://pages/-M-tw-bW4VvZPauRigKN) & [UniqueIdentifiers](broken://pages/-M-tw-bX919FyV5GCiW3) |

**Returns:** [*Investment*](broken://pages/-M-tw-_YeXyeoVULDYhp)

## Properties

### address

• **address**: *string*

*Defined in* [*src/entities/Investment.ts:88*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L88)

wallet address of token holder

### index

• **index**: *number*

*Defined in* [*src/entities/Investment.ts:93*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L93)

index of the Investment

### investedFunds

• **investedFunds**: *BigNumber*

*Defined in* [*src/entities/Investment.ts:103*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L103)

amount of funds used to make Investment

### securityTokenId

• **securityTokenId**: *string*

*Defined in* [*src/entities/Investment.ts:76*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L76)

### securityTokenSymbol

• **securityTokenSymbol**: *string*

*Defined in* [*src/entities/Investment.ts:83*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L83)

### stoId

• **stoId**: *string*

*Defined in* [*src/entities/Investment.ts:81*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L81)

unique ID for the Investment

### tokenAmount

• **tokenAmount**: *BigNumber*

*Defined in* [*src/entities/Investment.ts:98*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L98)

total amount of tokens involved in the Investment

### uid

• **uid**: *string*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*uid*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-uid)

*Defined in* [*src/entities/Investment.ts:74*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L74)

unique generated identifier for an Investment

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](broken://pages/-M-tw-bW4VvZPauRigKN)›): *void*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*\_refresh*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-_refresh)

*Defined in* [*src/entities/Investment.ts:165*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L165)

Hydrate the entity

**Parameters:**

| Name     | Type                                                   |
| -------- | ------------------------------------------------------ |
| `params` | Partial‹[Params](broken://pages/-M-tw-bW4VvZPauRigKN)› |

**Returns:** *void*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*toPojo*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-topojo)

*Defined in* [*src/entities/Investment.ts:138*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L138)

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **address**: *string*
* **index**: *number*
* **investedFunds**: *BigNumber*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **stoId**: *string*
* **tokenAmount**: *BigNumber*
* **uid**: *string*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

*Defined in* [*src/entities/Investment.ts:45*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L45)

Generate the Investment's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name              | Type   |
| ----------------- | ------ |
| `index`           | number |
| `securityTokenId` | string |
| `stoId`           | string |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](broken://pages/-M-tw-bX919FyV5GCiW3)

*Defined in* [*src/entities/Investment.ts:58*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Investment.ts#L58)

Unserialize a serialized Investment entity

**Parameters:**

| Name         | Type   | Description                               |
| ------------ | ------ | ----------------------------------------- |
| `serialized` | string | string with Investment entity information |

**Returns:** [*UniqueIdentifiers*](broken://pages/-M-tw-bX919FyV5GCiW3)