# Venue

Represents a Venue through which settlements are handled

## Hierarchy

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

  ↳ **Venue**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#protected-context)
* [id](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#id)
* [uuid](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#uuid)

### Methods

* [addInstruction](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#addinstruction)
* [addInstructions](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#addinstructions)
* [details](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#details)
* [exists](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#exists)
* [getInstructions](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#getinstructions)
* [getPendingInstructions](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#getpendinginstructions)
* [isEqual](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#isequal)
* [modify](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#modify)
* [toJson](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v7/classes/venue.md#static-unserialize)

## Properties

### `Protected` context

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

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

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

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Venue/index.ts:58*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L58)

Identifier number of the venue

### uuid

• **uuid**: *string*

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

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

## Methods

### addInstruction

▸ **addInstruction**(`args`: [AddInstructionParams](/polymesh-sdk-api-reference/docs-v7/interfaces/addinstructionparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[],* [*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*››*

*Defined in* [*src/api/entities/Venue/index.ts:243*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L243)

Creates a settlement Instruction in this Venue

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v7/interfaces/proceduremethod.md), which means you can call `addInstruction.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                           |
| ------- | ---------------------------------------------------------------------------------------------- |
| `args`  | [AddInstructionParams](/polymesh-sdk-api-reference/docs-v7/interfaces/addinstructionparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)               |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[],* [*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*››*

### addInstructions

▸ **addInstructions**(`args`: [AddInstructionsParams](/polymesh-sdk-api-reference/docs-v7/interfaces/addinstructionsparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[]››*

*Defined in* [*src/api/entities/Venue/index.ts:256*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L256)

Creates a batch of settlement Instructions in this Venue

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v7/interfaces/proceduremethod.md), which means you can call `addInstructions.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                             |
| ------- | ------------------------------------------------------------------------------------------------ |
| `args`  | [AddInstructionsParams](/polymesh-sdk-api-reference/docs-v7/interfaces/addinstructionsparams.md) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)                 |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[]››*

### details

▸ **details**(): *Promise‹*[*VenueDetails*](/polymesh-sdk-api-reference/docs-v7/interfaces/venuedetails.md)*›*

*Defined in* [*src/api/entities/Venue/index.ts:111*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L111)

Retrieve information specific to this venue

**Returns:** *Promise‹*[*VenueDetails*](/polymesh-sdk-api-reference/docs-v7/interfaces/venuedetails.md)*›*

### exists

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

*Defined in* [*src/api/entities/Venue/index.ts:92*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L92)

Retrieve whether the Venue exists

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

### getInstructions

▸ **getInstructions**(): *Promise‹Pick‹*[*GroupedInstructions*](/polymesh-sdk-api-reference/docs-v7/interfaces/groupedinstructions.md)*, "pending" | "failed"››*

*Defined in* [*src/api/entities/Venue/index.ts:145*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L145)

Retrieve all pending and failed Instructions in this Venue

**Returns:** *Promise‹Pick‹*[*GroupedInstructions*](/polymesh-sdk-api-reference/docs-v7/interfaces/groupedinstructions.md)*, "pending" | "failed"››*

### getPendingInstructions

▸ **getPendingInstructions**(): *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[]›*

*Defined in* [*src/api/entities/Venue/index.ts:199*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L199)

Retrieve all pending Instructions in this Venue

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

**Returns:** *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v7/classes/instruction.md)*\[]›*

### isEqual

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

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

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

**Returns:** *boolean*

### modify

▸ **modify**(`args`: [ModifyVenueParams](/polymesh-sdk-api-reference/docs-v7/globals.md#modifyvenueparams), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Venue/index.ts:269*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L269)

Modify description and type

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v7/interfaces/proceduremethod.md), which means you can call `modify.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                  |
| ------- | ------------------------------------------------------------------------------------- |
| `args`  | [ModifyVenueParams](/polymesh-sdk-api-reference/docs-v7/globals.md#modifyvenueparams) |
| `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)      |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹void››*

### toJson

▸ **toJson**(): *string*

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

*Defined in* [*src/api/entities/Venue/index.ts:276*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/Venue/index.ts#L276)

Return the Venue's ID

**Returns:** *string*

### `Static` generateUuid

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

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

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

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


---

# 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-v7/classes/venue.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.