> 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-alpha/modules-1/api_entities_instruction_types.md).

# api\_entities\_Instruction\_types

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / api/entities/Instruction/types

## Module: api/entities/Instruction/types

### Table of contents

#### Enumerations

* [AffirmationStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.affirmationstatus.md)
* [InstructionStatus](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md)
* [InstructionType](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructiontype.md)

#### Interfaces

* [InstructionAffirmation](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.instructionaffirmation.md)
* [Leg](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_instruction_types.leg.md)

#### Type Aliases

* [InstructionDetails](#instructiondetails)
* [InstructionStatusResult](#instructionstatusresult)

### Type Aliases

#### InstructionDetails

Ƭ **InstructionDetails**: { `createdAt`: `Date` ; `status`: [`InstructionStatus`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md) ; `tradeDate`: `Date` | `null` ; `valueDate`: `Date` | `null` ; `venue`: [`Venue`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue.md) } & { `type`: [`SettleOnAffirmation`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructiontype.md#settleonaffirmation) } | { `endBlock`: `BigNumber` ; `type`: [`SettleOnBlock`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructiontype.md#settleonblock) }

**Defined in**

[api/entities/Instruction/types.ts:17](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Instruction/types.ts#L17)

***

#### InstructionStatusResult

Ƭ **InstructionStatusResult**: { `status`: [`Pending`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md#pending) } | { `eventIdentifier`: [`EventIdentifier`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.eventidentifier.md) ; `status`: `Exclude`<[`InstructionStatus`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md), [`Pending`](/polymesh-sdk-api-reference/docs-alpha/enums/api_entities_instruction_types.instructionstatus.md#pending)> }

**Defined in**

[api/entities/Instruction/types.ts:57](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Instruction/types.ts#L57)
