> ## 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.

# Database

> Altoviz local sync: searchable entities, `.search()` filters, and operators.

The Altoviz plugin syncs data locally. Use `corsair.altoviz.db.<entity>.search({ data, limit?, offset? })` with the filters listed per entity.

<Info>
  **New to Corsair?** See [database operations](/concepts/database), [data synchronization](/concepts/integrations), and [multi-tenancy](/concepts/multi-tenancy).
</Info>

## Classifications

Path: `altoviz.db.classifications.search`

```ts theme={null}
const rows = await corsair.altoviz.db.classifications.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field                          | Type      | Operators                                  |
| ------------------------------ | --------- | ------------------------------------------ |
| `entity_id`                    | `string`  | equals, contains, startsWith, endsWith, in |
| `id`                           | `number`  | equals, gt, gte, lt, lte, in               |
| `accountNumber`                | `string`  | equals, contains, startsWith, endsWith, in |
| `description`                  | `string`  | equals, contains, startsWith, endsWith, in |
| `isProduct`                    | `boolean` | equals                                     |
| `isService`                    | `boolean` | equals                                     |
| `label`                        | `string`  | equals, contains, startsWith, endsWith, in |
| `microBusinessDeclarationType` | `string`  | equals, contains, startsWith, endsWith, in |
| `type`                         | `string`  | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Contacts

Path: `altoviz.db.contacts.search`

```ts theme={null}
const rows = await corsair.altoviz.db.contacts.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field                 | Type     | Operators                                  |
| --------------------- | -------- | ------------------------------------------ |
| `entity_id`           | `string` | equals, contains, startsWith, endsWith, in |
| `id`                  | `number` | equals, gt, gte, lt, lte, in               |
| `cellPhone`           | `string` | equals, contains, startsWith, endsWith, in |
| `companyName`         | `string` | equals, contains, startsWith, endsWith, in |
| `displayName`         | `string` | equals, contains, startsWith, endsWith, in |
| `email`               | `string` | equals, contains, startsWith, endsWith, in |
| `firstName`           | `string` | equals, contains, startsWith, endsWith, in |
| `function`            | `string` | equals, contains, startsWith, endsWith, in |
| `internalId`          | `string` | equals, contains, startsWith, endsWith, in |
| `invertedDisplayName` | `string` | equals, contains, startsWith, endsWith, in |
| `lastName`            | `string` | equals, contains, startsWith, endsWith, in |
| `phone`               | `string` | equals, contains, startsWith, endsWith, in |
| `service`             | `string` | equals, contains, startsWith, endsWith, in |
| `title`               | `string` | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Customer Families

Path: `altoviz.db.customerFamilies.search`

```ts theme={null}
const rows = await corsair.altoviz.db.customerFamilies.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field        | Type     | Operators                                  |
| ------------ | -------- | ------------------------------------------ |
| `entity_id`  | `string` | equals, contains, startsWith, endsWith, in |
| `id`         | `number` | equals, gt, gte, lt, lte, in               |
| `internalId` | `string` | equals, contains, startsWith, endsWith, in |
| `label`      | `string` | equals, contains, startsWith, endsWith, in |
| `number`     | `string` | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Customers

Path: `altoviz.db.customers.search`

```ts theme={null}
const rows = await corsair.altoviz.db.customers.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field           | Type      | Operators                                  |
| --------------- | --------- | ------------------------------------------ |
| `entity_id`     | `string`  | equals, contains, startsWith, endsWith, in |
| `id`            | `number`  | equals, gt, gte, lt, lte, in               |
| `active`        | `boolean` | equals                                     |
| `cellPhone`     | `string`  | equals, contains, startsWith, endsWith, in |
| `companyName`   | `string`  | equals, contains, startsWith, endsWith, in |
| `email`         | `string`  | equals, contains, startsWith, endsWith, in |
| `firstName`     | `string`  | equals, contains, startsWith, endsWith, in |
| `internalId`    | `string`  | equals, contains, startsWith, endsWith, in |
| `internalNotes` | `string`  | equals, contains, startsWith, endsWith, in |
| `lastName`      | `string`  | equals, contains, startsWith, endsWith, in |
| `name`          | `string`  | equals, contains, startsWith, endsWith, in |
| `number`        | `string`  | equals, contains, startsWith, endsWith, in |
| `phone`         | `string`  | equals, contains, startsWith, endsWith, in |
| `title`         | `string`  | equals, contains, startsWith, endsWith, in |
| `type`          | `string`  | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Product Families

Path: `altoviz.db.productFamilies.search`

```ts theme={null}
const rows = await corsair.altoviz.db.productFamilies.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field       | Type     | Operators                                  |
| ----------- | -------- | ------------------------------------------ |
| `entity_id` | `string` | equals, contains, startsWith, endsWith, in |
| `id`        | `number` | equals, gt, gte, lt, lte, in               |
| `label`     | `string` | equals, contains, startsWith, endsWith, in |
| `number`    | `string` | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Products

Path: `altoviz.db.products.search`

```ts theme={null}
const rows = await corsair.altoviz.db.products.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field                    | Type      | Operators                                  |
| ------------------------ | --------- | ------------------------------------------ |
| `entity_id`              | `string`  | equals, contains, startsWith, endsWith, in |
| `id`                     | `number`  | equals, gt, gte, lt, lte, in               |
| `active`                 | `boolean` | equals                                     |
| `defaultQuantity`        | `number`  | equals, gt, gte, lt, lte, in               |
| `description`            | `string`  | equals, contains, startsWith, endsWith, in |
| `imageUrl`               | `string`  | equals, contains, startsWith, endsWith, in |
| `internalId`             | `string`  | equals, contains, startsWith, endsWith, in |
| `internalNotes`          | `string`  | equals, contains, startsWith, endsWith, in |
| `isUnitPriceTaxIncluded` | `boolean` | equals                                     |
| `name`                   | `string`  | equals, contains, startsWith, endsWith, in |
| `number`                 | `string`  | equals, contains, startsWith, endsWith, in |
| `purchasePrice`          | `number`  | equals, gt, gte, lt, lte, in               |
| `type`                   | `string`  | equals, contains, startsWith, endsWith, in |
| `unitPrice`              | `number`  | equals, gt, gte, lt, lte, in               |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Units

Path: `altoviz.db.units.search`

```ts theme={null}
const rows = await corsair.altoviz.db.units.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field        | Type     | Operators                                  |
| ------------ | -------- | ------------------------------------------ |
| `entity_id`  | `string` | equals, contains, startsWith, endsWith, in |
| `id`         | `number` | equals, gt, gte, lt, lte, in               |
| `code`       | `string` | equals, contains, startsWith, endsWith, in |
| `conversion` | `number` | equals, gt, gte, lt, lte, in               |
| `decimals`   | `number` | equals, gt, gte, lt, lte, in               |
| `name`       | `string` | equals, contains, startsWith, endsWith, in |
| `type`       | `string` | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***

## Vats

Path: `altoviz.db.vats.search`

```ts theme={null}
const rows = await corsair.altoviz.db.vats.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field       | Type      | Operators                                  |
| ----------- | --------- | ------------------------------------------ |
| `entity_id` | `string`  | equals, contains, startsWith, endsWith, in |
| `id`        | `number`  | equals, gt, gte, lt, lte, in               |
| `default`   | `boolean` | equals                                     |
| `label`     | `string`  | equals, contains, startsWith, endsWith, in |
| `rate`      | `number`  | equals, gt, gte, lt, lte, in               |
| `region`    | `string`  | equals, contains, startsWith, endsWith, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](/concepts/database).*

***