> 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_checkpoint_.checkpoint.md).

# Checkpoint

Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time

## Hierarchy

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

  ↳ **Checkpoint**

## Index

### Constructors

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

### Properties

* [createdAt](broken://pages/-M-tw-_U_se_0xwFEJ0J#createdat)
* [dividendDistributions](broken://pages/-M-tw-_U_se_0xwFEJ0J#dividenddistributions)
* [index](broken://pages/-M-tw-_U_se_0xwFEJ0J#index)
* [securityTokenId](broken://pages/-M-tw-_U_se_0xwFEJ0J#securitytokenid)
* [securityTokenSymbol](broken://pages/-M-tw-_U_se_0xwFEJ0J#securitytokensymbol)
* [tokenholderBalances](broken://pages/-M-tw-_U_se_0xwFEJ0J#tokenholderbalances)
* [totalSupply](broken://pages/-M-tw-_U_se_0xwFEJ0J#totalsupply)
* [uid](broken://pages/-M-tw-_U_se_0xwFEJ0J#uid)

### Methods

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

## Constructors

### constructor

\+ **new Checkpoint**(`params`: [Params](broken://pages/-M-tw-bQOLGzKVRufZ7S) & [UniqueIdentifiers](broken://pages/-M-tw-bRu1RVQWkF8y1M)): [*Checkpoint*](broken://pages/-M-tw-_U_se_0xwFEJ0J)

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

Create a new Chekpoint instance

**Parameters:**

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

**Returns:** [*Checkpoint*](broken://pages/-M-tw-_U_se_0xwFEJ0J)

## Properties

### createdAt

• **createdAt**: *Date*

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

### dividendDistributions

• **dividendDistributions**: [*DividendDistribution*](broken://pages/-M-tw-_VZF8SRmWdakUB)*\[]*

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

dividend distributions associated to this snapshot

### index

• **index**: *number*

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

numerical index of the checkpoint associated to this snapshot

### securityTokenId

• **securityTokenId**: *string*

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

### securityTokenSymbol

• **securityTokenSymbol**: *string*

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

### tokenholderBalances

• **tokenholderBalances**: [*TokenholderBalance*](broken://pages/-M2_0qyI0IMUw06OXuLk)*\[]*

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

tokenholder balances at this specific checkpoint

### totalSupply

• **totalSupply**: *BigNumber*

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

### uid

• **uid**: *string*

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

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

## Methods

### \_refresh

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

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

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

Hydrate the entity

**Parameters:**

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

**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/Checkpoint.ts:137*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L137)

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **createdAt**: *Date*
* **dividendDistributions**: *object\[]* = dividendDistributions.map(distribution => distribution.toPojo())
* **index**: *number*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **tokenholderBalances**: [*TokenholderBalance*](broken://pages/-M2_0qyI0IMUw06OXuLk)*\[]*
* **totalSupply**: *BigNumber*
* **uid**: *string*

### `Static` generateId

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

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

Generate the Checkpoint's UUID from its identifying properties

**Parameters:**

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

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

**Returns:** *string*

### `Static` unserialize

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

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

Unserialize string to Checkpoint object

**Parameters:**

| Name         | Type   |
| ------------ | ------ |
| `serialized` | string |

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