> 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-beta/classes/venue.md).

# Venue

Represents a Venue through which settlements are handled

## Hierarchy

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

  ↳ **Venue**

## Index

### Properties

* [context](#protected-context)
* [id](#id)
* [uuid](#uuid)

### Methods

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

## Properties

### `Protected` context

• **context**: *Context*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#protected-context)

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

***

### id

• **id**: *BigNumber*

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

identifier number of the Venue

***

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#uuid)

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

## Methods

### addInstruction

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

*Defined in* [*src/api/entities/Venue/index.ts:214*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Venue/index.ts#L214)

Creates a settlement Instruction in this Venue

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [addInstruction.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinstructionparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)               |

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

***

### addInstructions

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

*Defined in* [*src/api/entities/Venue/index.ts:227*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Venue/index.ts#L227)

Creates a batch of settlement Instructions in this Venue

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [addInstructions.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/addinstructionsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)                 |

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

***

### details

▸ **details**(): *Promise‹*[*VenueDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/venuedetails.md)*›*

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

Retrieve information specific to this Venue

**Returns:** *Promise‹*[*VenueDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/venuedetails.md)*›*

***

### exists

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

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

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

Determine whether this Venue exists on chain

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

***

### getInstructions

▸ **getInstructions**(): *Promise‹Pick‹*[*GroupedInstructions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/groupedinstructions.md)*, "pending" | "failed"››*

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

Retrieve all pending and failed Instructions in this Venue

**Returns:** *Promise‹Pick‹*[*GroupedInstructions*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/groupedinstructions.md)*, "pending" | "failed"››*

***

### getPendingInstructions

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

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

Retrieve all pending Instructions in this Venue

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

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

***

### isEqual

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#isequal)

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

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                |
| -------- | ----------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-beta/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

***

### modify

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

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

Modify description and type

**`note`** required role:

* Venue Owner

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [modify.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#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](/polymesh-sdk-api-reference/docs-beta/globals.md#modifyvenueparams)                          |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md) |

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

***

### toHuman

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

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-beta/classes/entity.md)*.*[*toHuman*](/polymesh-sdk-api-reference/docs-beta/classes/entity.md#abstract-tohuman)

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

Return the Venue's ID

**Returns:** *string*

***

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-beta/classes/checkpointschedule.md#static-generateuuid)

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

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