> 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-v9/classes/checkpointschedule.md).

# CheckpointSchedule

Represents a Schedule in which Checkpoints are created for a specific Security Token. Schedules can be set up to create checkpoints

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹UniqueIdentifiers, [HumanReadable](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)›

  ↳ **CheckpointSchedule**

## Index

### Properties

* [complexity](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#complexity)
* [context](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#protected-context)
* [expiryDate](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#expirydate)
* [id](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#id)
* [period](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#period)
* [start](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#start)
* [ticker](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#ticker)
* [uuid](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#uuid)

### Methods

* [details](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#details)
* [exists](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#exists)
* [getCheckpoints](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#getcheckpoints)
* [isEqual](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#isequal)
* [toJson](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v9/classes/checkpointschedule.md#static-unserialize)

## Properties

### complexity

• **complexity**: *number*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:83*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L83)

abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity

### `Protected` context

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context)

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

### expiryDate

• **expiryDate**: *Date | null*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:78*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L78)

date at which the last Checkpoint will be created with this Schedule. A null value means that this Schedule never expires

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:56*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L56)

schedule identifier number

### period

• **period**: [*CalendarPeriod*](/polymesh-sdk-api-reference/docs-v9/interfaces/calendarperiod.md) *| null*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:67*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L67)

how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires

### start

• **start**: *Date*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:72*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L72)

first Checkpoint creation date

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L61)

ticker of the Security Token for which Checkpoints are scheduled

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid)

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

## Methods

### details

▸ **details**(): *Promise‹*[*ScheduleDetails*](/polymesh-sdk-api-reference/docs-v9/interfaces/scheduledetails.md)*›*

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

Retrieve information specific to this Schedule

**Returns:** *Promise‹*[*ScheduleDetails*](/polymesh-sdk-api-reference/docs-v9/interfaces/scheduledetails.md)*›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:185*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L185)

Retrieve whether the Checkpoint Schedule still exists on chain

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

### getCheckpoints

▸ **getCheckpoints**(): *Promise‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v9/classes/checkpoint.md)*\[]›*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:153*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L153)

Retrieve all Checkpoints created by this Schedule

**Returns:** *Promise‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v9/classes/checkpoint.md)*\[]›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal)

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

**Returns:** *boolean*

### toJson

▸ **toJson**(): [*HumanReadable*](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:207*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/CheckpointSchedule/index.ts#L207)

Return the Schedule's ID and Token ticker

**Returns:** [*HumanReadable*](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)

### `Static` generateUuid

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid)

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

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