# api\_entities\_Venue.Venue

[@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/entities/Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue) / Venue

## Class: Venue

[api/entities/Venue](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue).Venue

Represents a Venue through which settlements are handled

### Hierarchy

* [`Entity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity)<[`UniqueIdentifiers`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_venue.uniqueidentifiers), `string`>

  ↳ **`Venue`**

### Table of contents

#### Properties

* [id](#id)
* [uuid](#uuid)

#### Methods

* [addInstruction](#addinstruction)
* [addInstructions](#addinstructions)
* [details](#details)
* [exists](#exists)
* [getInstructions](#getinstructions)
* [getPendingInstructions](#getpendinginstructions)
* [isEqual](#isequal)
* [modify](#modify)
* [toHuman](#tohuman)
* [generateUuid](#generateuuid)
* [unserialize](#unserialize)

### Properties

#### id

• **id**: `BigNumber`

identifier number of the Venue

**Defined in**

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

***

#### uuid

• **uuid**: `string`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[uuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#uuid)

**Defined in**

[api/entities/Entity.ts:46](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L46)

### 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`\[]\[]>>

Creates a settlement Instruction in this Venue

**`note`** required role:

* Venue Owner

**`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`  | [`AddInstructionParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_addinstruction.addinstructionparams) |
| `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/entities/Venue/index.ts:214](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L214)

***

#### addInstructions

▸ **addInstructions**(`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`\[]\[]>>

Creates a batch of settlement Instructions in this Venue

**`note`** required role:

* Venue Owner

**`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 [addInstructions.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`  | [`AddInstructionsParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_addinstruction.addinstructionsparams) |
| `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/entities/Venue/index.ts:227](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L227)

***

#### details

▸ **details**(): `Promise`<[`VenueDetails`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_venue_types.venuedetails)>

Retrieve information specific to this Venue

**Returns**

`Promise`<[`VenueDetails`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/api_entities_venue_types.venuedetails)>

**Defined in**

[api/entities/Venue/index.ts:110](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L110)

***

#### exists

▸ **exists**(): `Promise`<`boolean`>

Determine whether this Venue exists on chain

**Returns**

`Promise`<`boolean`>

**Overrides**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[exists](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#exists)

**Defined in**

[api/entities/Venue/index.ts:91](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L91)

***

#### getInstructions

▸ **getInstructions**(): `Promise`<`Pick`<[`GroupedInstructions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.groupedinstructions), `"pending"` | `"failed"`>>

Retrieve all pending and failed Instructions in this Venue

**Returns**

`Promise`<`Pick`<[`GroupedInstructions`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.groupedinstructions), `"pending"` | `"failed"`>>

**Defined in**

[api/entities/Venue/index.ts:139](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L139)

***

#### getPendingInstructions

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

Retrieve all pending Instructions in this Venue

**`deprecated`** in favor of `getInstructions`

**Returns**

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

**Defined in**

[api/entities/Venue/index.ts:168](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L168)

***

#### isEqual

▸ **isEqual**(`entity`): `boolean`

Determine whether this Entity is the same as another one

**Parameters**

| Name     | Type                                                                                                                                           |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity` | [`Entity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity)<`unknown`, `unknown`> |

**Returns**

`boolean`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[isEqual](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#isequal)

**Defined in**

[api/entities/Entity.ts:61](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L61)

***

#### modify

▸ **modify**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Modify description and type

**`note`** required role:

* Venue Owner

**`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 [modify.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`  | [`ModifyVenueParams`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyvenue#modifyvenueparams) |
| `opts?` | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                             |

**Returns**

`Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

**Defined in**

[api/entities/Venue/index.ts:240](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L240)

***

#### toHuman

▸ **toHuman**(): `string`

Return the Venue's ID

**Returns**

`string`

**Overrides**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[toHuman](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#tohuman)

**Defined in**

[api/entities/Venue/index.ts:247](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Venue/index.ts#L247)

***

#### generateUuid

▸ `Static` **generateUuid**<`Identifiers`>(`identifiers`): `string`

Generate the Entity's UUID from its identifying properties

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`string`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[generateUuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#generateuuid)

**Defined in**

[api/entities/Entity.ts:14](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L14)

***

#### unserialize

▸ `Static` **unserialize**<`Identifiers`>(`serialized`): `Identifiers`

Unserialize a UUID into its Unique Identifiers

**Type parameters**

| Name          |
| ------------- |
| `Identifiers` |

**Parameters**

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

**Returns**

`Identifiers`

**Inherited from**

[Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_entity.entity).[unserialize](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/api_entities_entity.entity#unserialize)

**Defined in**

[api/entities/Entity.ts:23](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/entities/Entity.ts#L23)