# Instruction

Represents a settlement Instruction to be executed on a certain Venue

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v4/classes/entity.md)‹UniqueIdentifiers›

  ↳ **Instruction**

## Index

### Properties

* [affirm](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#affirm)
* [context](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#protected-context)
* [id](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#id)
* [reject](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#reject)
* [uuid](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#uuid)
* [withdraw](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#withdraw)

### Methods

* [details](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#details)
* [getAffirmations](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#getaffirmations)
* [getLegs](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#getlegs)
* [generateUuid](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md#static-unserialize)

## Properties

### affirm

• **affirm**: *ProcedureMethod‹void,* [*Instruction*](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md)*›*

*Defined in* [*src/api/entities/Instruction/index.ts:221*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L221)

Affirm this instruction (authorize)

### `Protected` context

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

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

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

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Instruction/index.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L50)

Identifier number of the venue

### reject

• **reject**: *ProcedureMethod‹void,* [*Instruction*](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md)*›*

*Defined in* [*src/api/entities/Instruction/index.ts:215*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L215)

Reject this instruction

**`note`** reject on `SettleOnAffirmation` will execute the settlement and it will fail immediately.

**`note`** reject on `SettleOnBlock` behaves just like unauthorize

### uuid

• **uuid**: *string*

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

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

### withdraw

• **withdraw**: *ProcedureMethod‹void,* [*Instruction*](/polymesh-sdk-api-reference/docs-v4/classes/instruction.md)*›*

*Defined in* [*src/api/entities/Instruction/index.ts:226*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L226)

Withdraw affirmation from this instruction (unauthorize)

## Methods

### details

▸ **details**(): *Promise‹*[*InstructionDetails*](/polymesh-sdk-api-reference/docs-v4/globals.md#instructiondetails)*›*

*Defined in* [*src/api/entities/Instruction/index.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L87)

Retrieve information specific to this Instruction

**Returns:** *Promise‹*[*InstructionDetails*](/polymesh-sdk-api-reference/docs-v4/globals.md#instructiondetails)*›*

### getAffirmations

▸ **getAffirmations**(`paginationOpts?`: [PaginationOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v4/interfaces/resultset.md)*‹*[*InstructionAffirmation*](/polymesh-sdk-api-reference/docs-v4/interfaces/instructionaffirmation.md)*››*

*Defined in* [*src/api/entities/Instruction/index.ts:134*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L134)

Retrieve every authorization generated by this Instruction (status and authorizing Identity)

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v4/interfaces/resultset.md)*‹*[*InstructionAffirmation*](/polymesh-sdk-api-reference/docs-v4/interfaces/instructionaffirmation.md)*››*

### getLegs

▸ **getLegs**(`paginationOpts?`: [PaginationOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v4/interfaces/resultset.md)*‹*[*Leg*](/polymesh-sdk-api-reference/docs-v4/interfaces/leg.md)*››*

*Defined in* [*src/api/entities/Instruction/index.ts:171*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Instruction/index.ts#L171)

Retrieve all legs of this Instruction

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v4/interfaces/resultset.md)*‹*[*Leg*](/polymesh-sdk-api-reference/docs-v4/interfaces/leg.md)*››*

### `Static` generateUuid

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

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

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

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

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/instruction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.