# api\_client\_Settlements.Settlements

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/client/Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_settlements) / Settlements

## Class: Settlements

[api/client/Settlements](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_settlements).Settlements

Handles all Settlement related functionality

### Table of contents

#### Methods

* [addInstruction](#addinstruction)
* [affirmInstruction](#affirminstruction)
* [createVenue](#createvenue)
* [getInstruction](#getinstruction)
* [getVenue](#getvenue)

### Methods

#### addInstruction

▸ **addInstruction**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction)\[], [`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), `unknown`\[]\[]>>

Create an Instruction to exchange Assets

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [addInstruction.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                                                                                    |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [`AddInstructionWithVenueIdParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_addinstruction.addinstructionwithvenueidparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                                                             |

**Returns**

`Promise`<`TransactionQueue`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction)\[], [`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), `unknown`\[]\[]>>

**Defined in**

[api/client/Settlements.ts:118](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Settlements.ts#L118)

***

#### affirmInstruction

▸ **affirmInstruction**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), [`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), `unknown`\[]\[]>>

Affirm an Instruction (authorize)

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [affirmInstruction.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                                                                                  |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [`AffirmInstructionParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_modifyinstructionaffirmation.affirminstructionparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                                                           |

**Returns**

`Promise`<`TransactionQueue`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), [`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction), `unknown`\[]\[]>>

**Defined in**

[api/client/Settlements.ts:128](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Settlements.ts#L128)

***

#### createVenue

▸ **createVenue**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue), [`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue), `unknown`\[]\[]>>

Create a Venue under the ownership of the signing Identity

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [createVenue.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                                                     |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [`CreateVenueParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_createvenue.createvenueparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                              |

**Returns**

`Promise`<`TransactionQueue`<[`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue), [`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue), `unknown`\[]\[]>>

**Defined in**

[api/client/Settlements.ts:108](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Settlements.ts#L108)

***

#### getInstruction

▸ **getInstruction**(`args`): `Promise`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction)>

Retrieve an Instruction by its ID

**Parameters**

| Name      | Type        | Description                          |
| --------- | ----------- | ------------------------------------ |
| `args`    | `Object`    | -                                    |
| `args.id` | `BigNumber` | identifier number of the Instruction |

**Returns**

`Promise`<[`Instruction`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_instruction.instruction)>

**Defined in**

[api/client/Settlements.ts:86](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Settlements.ts#L86)

***

#### getVenue

▸ **getVenue**(`args`): `Promise`<[`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue)>

Retrieve a Venue by its ID

**Parameters**

| Name      | Type        | Description                    |
| --------- | ----------- | ------------------------------ |
| `args`    | `Object`    | -                              |
| `args.id` | `BigNumber` | identifier number of the Venue |

**Returns**

`Promise`<[`Venue`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_venue.venue)>

**Defined in**

[api/client/Settlements.ts:65](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Settlements.ts#L65)