> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> API reference for Booqable: every `booqable.api.*` operation with input and output types.

Every `booqable.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

<Info>
  **New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
</Info>

## Barcodes

### listBarcodes

`barcodes.listBarcodes`

Retrieve a list of barcodes.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.barcodes.listBarcodes({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: barcodes,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Bundle Items

### listBundleItems

`bundleItems.listBundleItems`

Retrieve a list of bundle items.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.bundleItems.listBundleItems({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: bundle_items,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Bundles

### searchBundles

`bundles.searchBundles`

Search bundles with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.bundles.searchBundles({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: bundles,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Clusters

### listClusters

`clusters.listClusters`

Retrieve a list of clusters.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.clusters.listClusters({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: clusters,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Companies

### updateCompany

`companies.updateCompany`

Update the current company information.

**Risk:** `write`

```ts theme={null}
await corsair.booqable.api.companies.updateCompany({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: companies,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Coupons

### listCoupons

`coupons.listCoupons`

Retrieve a list of coupons.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.coupons.listCoupons({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: coupons,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Customers

### createCustomer

`customers.createCustomer`

Create a new customer in Booqable.

**Risk:** `write`

```ts theme={null}
await corsair.booqable.api.customers.createCustomer({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: customers,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### deleteCustomer

`customers.deleteCustomer`

Delete (archive) a customer by ID.

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.booqable.api.customers.deleteCustomer({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output:** `object`

<AccordionGroup>
  <Accordion title="Output full type">
    ```ts theme={null}
    {
      data: {
        id: string,
        type: customers,
        attributes?: {
        },
        relationships?: {
        }
      },
      included?: {
        id: string,
        type: string,
        attributes?: {
        },
        relationships?: {
        }
      }[],
      links?: {
      },
      meta?: {
      }
    } | {
      data: null,
      links?: {
      },
      meta?: {
      }
    }
    ```
  </Accordion>
</AccordionGroup>

***

### getCustomer

`customers.getCustomer`

Fetch a specific customer by ID.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.customers.getCustomer({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: customers,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### getCustomers

`customers.getCustomers`

Retrieve a paginated list of customers.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.customers.getCustomers({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: customers,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### searchCustomers

`customers.searchCustomers`

Search customers with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.customers.searchCustomers({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: customers,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Default Properties

### listDefaultProperties

`defaultProperties.listDefaultProperties`

Retrieve default property definitions.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.defaultProperties.listDefaultProperties({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: default_properties,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Documents

### listDocuments

`documents.listDocuments`

Retrieve a list of documents.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.documents.listDocuments({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: documents,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### searchDocuments

`documents.searchDocuments`

Search documents with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.documents.searchDocuments({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: documents,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Email Templates

### listEmailTemplates

`emailTemplates.listEmailTemplates`

List email templates.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.emailTemplates.listEmailTemplates({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: email_templates,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Employees

### listEmployees

`employees.listEmployees`

Retrieve a list of employees.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.employees.listEmployees({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: employees,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Inventory Breakdowns

### listInventoryBreakdowns

`inventoryBreakdowns.listInventoryBreakdowns`

Retrieve inventory breakdowns by status and product.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.inventoryBreakdowns.listInventoryBreakdowns({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: inventory_breakdowns,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Inventory Levels

### getInventoryLevels

`inventoryLevels.getInventoryLevels`

Fetch inventory levels for products across locations.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.inventoryLevels.getInventoryLevels({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: inventory_levels,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Items

### listItems

`items.listItems`

Retrieve a list of items (products and product groups).

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.items.listItems({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: items,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### searchItems

`items.searchItems`

Search items with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.items.searchItems({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: items,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Lines

### listLines

`lines.listLines`

Retrieve a paginated list of order lines.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.lines.listLines({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: lines,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Locations

### listLocations

`locations.listLocations`

Retrieve a list of locations.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.locations.listLocations({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: locations,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Notes

### listNotes

`notes.listNotes`

Retrieve a list of notes.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.notes.listNotes({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: notes,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Orders

### createOrder

`orders.createOrder`

Create a new order.

**Risk:** `write`

```ts theme={null}
await corsair.booqable.api.orders.createOrder({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: orders,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### deleteOrder

`orders.deleteOrder`

Delete (archive) an order by ID.

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.booqable.api.orders.deleteOrder({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output:** `object`

<AccordionGroup>
  <Accordion title="Output full type">
    ```ts theme={null}
    {
      data: {
        id: string,
        type: orders,
        attributes?: {
        },
        relationships?: {
        }
      },
      included?: {
        id: string,
        type: string,
        attributes?: {
        },
        relationships?: {
        }
      }[],
      links?: {
      },
      meta?: {
      }
    } | {
      data: null,
      links?: {
      },
      meta?: {
      }
    }
    ```
  </Accordion>
</AccordionGroup>

***

### getNewOrder

`orders.getNewOrder`

Retrieve a new order template with default values.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.orders.getNewOrder({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: orders,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### getOrder

`orders.getOrder`

Retrieve a specific order by ID.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.orders.getOrder({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: orders,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### listOrders

`orders.listOrders`

Retrieve a paginated list of orders.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.orders.listOrders({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: orders,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### searchOrders

`orders.searchOrders`

Search orders with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.orders.searchOrders({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: orders,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Payment Methods

### listPaymentMethods

`paymentMethods.listPaymentMethods`

Retrieve a list of payment methods.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.paymentMethods.listPaymentMethods({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: payment_methods,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Payments

### listPayments

`payments.listPayments`

List all payments.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.payments.listPayments({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: payments,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Photos

### listPhotos

`photos.listPhotos`

Retrieve a paginated list of photos.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.photos.listPhotos({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: photos,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Plannings

### listPlannings

`plannings.listPlannings`

Retrieve planning records for reservations.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.plannings.listPlannings({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: plannings,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### searchPlannings

`plannings.searchPlannings`

Search plannings with advanced filtering.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.plannings.searchPlannings({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: plannings,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Price Rulesets

### listPriceRulesets

`priceRulesets.listPriceRulesets`

List price rulesets.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.priceRulesets.listPriceRulesets({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: price_rulesets,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Price Structures

### listPriceStructures

`priceStructures.listPriceStructures`

List price structures.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.priceStructures.listPriceStructures({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: price_structures,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Product Groups

### createProductGroup

`productGroups.createProductGroup`

Create a new product group.

**Risk:** `write`

```ts theme={null}
await corsair.booqable.api.productGroups.createProductGroup({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: product_groups,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### deleteProductGroup

`productGroups.deleteProductGroup`

Delete a product group by ID.

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.booqable.api.productGroups.deleteProductGroup({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output:** `object`

<AccordionGroup>
  <Accordion title="Output full type">
    ```ts theme={null}
    {
      data: {
        id: string,
        type: product_groups,
        attributes?: {
        },
        relationships?: {
        }
      },
      included?: {
        id: string,
        type: string,
        attributes?: {
        },
        relationships?: {
        }
      }[],
      links?: {
      },
      meta?: {
      }
    } | {
      data: null,
      links?: {
      },
      meta?: {
      }
    }
    ```
  </Accordion>
</AccordionGroup>

***

### getProductGroup

`productGroups.getProductGroup`

Fetch a specific product group by ID.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.productGroups.getProductGroup({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: product_groups,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### listProductGroups

`productGroups.listProductGroups`

List product groups with filtering and pagination.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.productGroups.listProductGroups({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: product_groups,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Products

### getProduct

`products.getProduct`

Fetch a specific product by ID.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.products.getProduct({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `id`          | `string` | Yes      | —           |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object`   | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: products,
      attributes?: {
      },
      relationships?: {
      }
    }
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

### listProducts

`products.listProducts`

Retrieve a paginated list of products.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.products.listProducts({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: products,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Properties

### listProperties

`properties.listProperties`

Retrieve a list of custom properties.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.properties.listProperties({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: properties,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Provinces

### listProvinces

`provinces.listProvinces`

Retrieve a list of provinces.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.provinces.listProvinces({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: provinces,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Stock Item Plannings

### listStockItemPlannings

`stockItemPlannings.listStockItemPlannings`

Retrieve stock item plannings.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.stockItemPlannings.listStockItemPlannings({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: stock_item_plannings,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Stock Items

### listStockItems

`stockItems.listStockItems`

Retrieve a list of stock items.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.stockItems.listStockItems({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: stock_items,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Tax Rates

### listTaxRates

`taxRates.listTaxRates`

Retrieve a list of tax rates.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.taxRates.listTaxRates({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: tax_rates,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Tax Values

### listTaxValues

`taxValues.listTaxValues`

Retrieve a list of tax values.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.taxValues.listTaxValues({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: tax_values,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Users

### listUsers

`users.listUsers`

Retrieve a list of users.

**Risk:** `read`

```ts theme={null}
await corsair.booqable.api.users.listUsers({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `companySlug` | `string` | No       | —           |
| `body`        | `any`    | No       | —           |
| `query`       | `object` | No       | —           |
| `headers`     | `object` | No       | —           |

<AccordionGroup>
  <Accordion title="query full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="headers full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

**Output**

| Name       | Type       | Required | Description |
| ---------- | ---------- | -------- | ----------- |
| `data`     | `object[]` | Yes      | —           |
| `included` | `object[]` | No       | —           |
| `links`    | `object`   | No       | —           |
| `meta`     | `object`   | No       | —           |

<AccordionGroup>
  <Accordion title="data full type">
    ```ts theme={null}
    {
      id: string,
      type: users,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="included full type">
    ```ts theme={null}
    {
      id: string,
      type: string,
      attributes?: {
      },
      relationships?: {
      }
    }[]
    ```
  </Accordion>

  <Accordion title="links full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>

  <Accordion title="meta full type">
    ```ts theme={null}
    {
    }
    ```
  </Accordion>
</AccordionGroup>

***