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

# ForceManager API reference

> API reference for the ForceManager plugin in Corsair: every `forcemanager.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Account Addresses

### accountAddressesSchema

`accountAddresses.accountAddressesSchema`

Account Addresses schema (GET /accountAddresses/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.accountAddressesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   address1?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   address2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   city?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   countryId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   postcode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   region?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createAccountAddress

`accountAddresses.createAccountAddress`

Create Account Address (POST /accountAddresses)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.createAccountAddress({
	body: { accountId: 1, address1: 'Main office' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId?: number,
>   address1?: string,
>   address2?: string,
>   city?: string,
>   countryId?: number,
>   description?: string,
>   postcode?: string,
>   region?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteAccountAddress

`accountAddresses.deleteAccountAddress`

Delete Account Address (DELETE /accountAddresses/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.deleteAccountAddress({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getAccountAddress

`accountAddresses.getAccountAddress`

Get Account Address (GET /accountAddresses/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.getAccountAddress({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountId` | `object` | No | — |
| `address1` | `string` | No | — |
| `address2` | `string \| null` | No | — |
| `city` | `string` | No | — |
| `countryId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `string \| null` | No | — |
| `dateUpdated` | `string \| null` | No | — |
| `deleted` | `boolean` | No | — |
| `description` | `string \| null` | No | — |
| `id` | `number` | No | — |
| `postcode` | `string` | No | — |
| `region` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `number \| null` | No | — |
| `salesRepIdUpdated` | `number \| null` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] countryId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listAccountAddresses

`accountAddresses.listAccountAddresses`

List Account Addresses (GET /accountAddresses)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.listAccountAddresses({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountId?: {
>     id?: number,
>     value?: string
>   },
>   address1?: string,
>   address2?: string | null,
>   city?: string,
>   countryId?: {
>     id?: number,
>     value?: string
>   },
>   dateCreated?: string,
>   dateDeleted?: string | null,
>   dateUpdated?: string | null,
>   deleted?: boolean,
>   description?: string | null,
>   id?: number,
>   postcode?: string,
>   region?: string,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: number | null,
>   salesRepIdUpdated?: number | null
> }[]
> ```

***

### updateAccountAddress

`accountAddresses.updateAccountAddress`

Update Account Address (PUT /accountAddresses/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountAddresses.updateAccountAddress({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address1?: string,
>   city?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Accounts Entity

### accountsSchema

`accountsEntity.accountsSchema`

Accounts schema (GET /accounts/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.accountsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   address1?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   address2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   city?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   comment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   countryId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateGeocoded?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   email?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fax?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocoded?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocodingAccuracy?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   latitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   longitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   marketingCommunications?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   name?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone3?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   postcode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   public?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   rateId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   region?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId1?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepId2?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepId3?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepId4?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepId5?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   segmentId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   statusId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   typeId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   vatNumber?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   website?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createAccount

`accountsEntity.createAccount`

Create Account (POST /accounts)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.createAccount({
	body: { branchId: 1, name: 'sample', salesRepId1: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address1?: string,
>   address2?: string,
>   branchId: number,
>   city?: string,
>   comment?: string,
>   countryId?: number,
>   email?: string,
>   fax?: string,
>   geocoded?: boolean,
>   geocodingAccuracy?: number,
>   latitude?: number,
>   longitude?: number,
>   name: string,
>   permissionLevel?: number,
>   phone?: string,
>   phone2?: string,
>   phone3?: string,
>   postcode?: string,
>   public?: boolean,
>   rateId?: number,
>   readOnly?: boolean,
>   region?: string,
>   salesRepId1: number,
>   segmentId?: number,
>   statusId?: number,
>   typeId?: number,
>   vatNumber?: string,
>   website?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteAccount

`accountsEntity.deleteAccount`

Delete Account (DELETE /accounts/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.deleteAccount({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getAccount

`accountsEntity.getAccount`

Get Account (GET /accounts/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.getAccount({
	path: { id: 1 },
	headers: { extraFieldDescription: '0' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `address1` | `string` | No | — |
| `address2` | `JsonValue` | No | — |
| `branchId` | `object` | No | — |
| `city` | `string` | No | — |
| `comment` | `JsonValue` | No | — |
| `countryId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateGeocoded` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `email` | `string` | No | — |
| `extId` | `string` | No | — |
| `fax` | `JsonValue` | No | — |
| `geocoded` | `boolean` | No | — |
| `geocodingAccuracy` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `latitude` | `number` | No | — |
| `longitude` | `number` | No | — |
| `marketingCommunications` | `boolean` | No | — |
| `name` | `string` | No | — |
| `permissionLevel` | `number` | No | — |
| `phone` | `JsonValue` | No | — |
| `phone2` | `JsonValue` | No | — |
| `phone3` | `JsonValue` | No | — |
| `postcode` | `string` | No | — |
| `public` | `JsonValue` | No | — |
| `rateId` | `JsonValue` | No | — |
| `readOnly` | `boolean` | No | — |
| `region` | `string` | No | — |
| `salesRepId1` | `object` | No | — |
| `salesRepId2` | `JsonValue` | No | — |
| `salesRepId3` | `JsonValue` | No | — |
| `salesRepId4` | `JsonValue` | No | — |
| `salesRepId5` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `segmentId` | `JsonValue` | No | — |
| `statusId` | `object` | No | — |
| `typeId` | `object` | No | — |
| `vatNumber` | `JsonValue` | No | — |
| `website` | `string` | No | — |

> [accordion] branchId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] countryId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId1 full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] statusId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] typeId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listAccounts

`accountsEntity.listAccounts`

List Accounts (GET /accounts)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.listAccounts({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   address1?: string,
>   address2?: string,
>   branchId?: {
>     id?: number,
>     value?: string
>   },
>   city?: string,
>   comment?: string,
>   countryId?: {
>     id?: number,
>     value?: string
>   },
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   email?: string,
>   extId?: JsonValue,
>   fax?: string,
>   geocoded?: boolean,
>   geocodingAccuracy?: number,
>   id?: number,
>   latitude?: number,
>   longitude?: number,
>   name?: string,
>   permissionLevel?: number,
>   phone?: string,
>   phone2?: string,
>   phone3?: string,
>   postcode?: string,
>   public?: boolean,
>   rateId?: JsonValue,
>   readOnly?: boolean,
>   region?: string,
>   salesRepId1?: {
>     id?: number,
>     value?: string
>   },
>   salesRepId2?: JsonValue,
>   salesRepId3?: JsonValue,
>   salesRepId4?: JsonValue,
>   salesRepId5?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   segmentId?: {
>     id?: number,
>     value?: string
>   },
>   statusId?: JsonValue,
>   typeId?: {
>     id?: number,
>     value?: string
>   },
>   vatNumber?: JsonValue,
>   website?: JsonValue
> }[]
> ```

***

### updateAccount

`accountsEntity.updateAccount`

Update Account (PUT /accounts/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsEntity.updateAccount({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address1?: string,
>   phone3?: string,
>   website?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Accounts Segments

### accountSegmentsSchema

`accountsSegments.accountSegmentsSchema`

Account Segments schema (GET /accountSegments/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.accountSegmentsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   visitCycle?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createAccountSegment

`accountsSegments.createAccountSegment`

Create Account Segment (POST /accountSegments)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.createAccountSegment({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   visitCycle?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteAccountSegment

`accountsSegments.deleteAccountSegment`

Delete Account Segment (DELETE /accountSegments/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.deleteAccountSegment({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getAccountSegment

`accountsSegments.getAccountSegment`

Get Account Segment (GET /accountSegments/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.getAccountSegment({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `order` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `visitCycle` | `number` | No | — |

***

### listAccountSegments

`accountsSegments.listAccountSegments`

List Account Segments (GET /accountSegments)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.listAccountSegments({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: JsonValue,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   order?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   visitCycle?: number
> }[]
> ```

***

### updateAccountSegment

`accountsSegments.updateAccountSegment`

Update Account Segment (PUT /accountSegments/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsSegments.updateAccountSegment({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   visitCycle?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Accounts Statuses

### accountStatusesSchema

`accountsStatuses.accountStatusesSchema`

Account Statuses schema (GET /accountStatuses/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.accountStatusesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lost?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   won?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createAccountStatus

`accountsStatuses.createAccountStatus`

Create Account Status (POST /accountStatuses)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.createAccountStatus({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   lost?: boolean,
>   branchVisibility?: Record<string, JsonValue>[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteAccountStatus

`accountsStatuses.deleteAccountStatus`

Delete Account Status (DELETE /accountStatuses/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.deleteAccountStatus({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getAccountStatus

`accountsStatuses.getAccountStatus`

Get Account Status (GET /accountStatuses/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.getAccountStatus({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `object[]` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `lost` | `boolean` | No | — |
| `order` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `won` | `boolean` | No | — |

> [accordion] branchVisibility full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }[]
> ```

***

### listAccountStatuses

`accountsStatuses.listAccountStatuses`

List Account Statuses (GET /accountStatuses)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.listAccountStatuses({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   lost?: boolean,
>   order?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: number,
>   salesRepIdUpdated?: JsonValue,
>   won?: boolean
> }[]
> ```

***

### updateAccountStatus

`accountsStatuses.updateAccountStatus`

Update Account Status (PUT /accountStatuses/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsStatuses.updateAccountStatus({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   lost?: boolean,
>   won?: boolean,
>   branchVisibility?: Record<string, JsonValue>[],
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Accounts Types

### accountTypesSchema

`accountsTypes.accountTypesSchema`

Account Types schema (GET /accountTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.accountTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   computeSfm?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   internal?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createAccountType

`accountsTypes.createAccountType`

Create Account Type (POST /accountTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.createAccountType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteAccountType

`accountsTypes.deleteAccountType`

Delete Account Type (DELETE /list/accountTypes/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.deleteAccountType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getAccountType

`accountsTypes.getAccountType`

Get Account Type (GET /accountTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.getAccountType({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue` | No | — |
| `computeSfm` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `internal` | `boolean` | No | — |
| `order` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |

***

### listAccountTypes

`accountsTypes.listAccountTypes`

List Account Types (GET /accountTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.listAccountTypes({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   computeSfm?: boolean,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   internal?: boolean,
>   order?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: number,
>   salesRepIdUpdated?: number
> }[]
> ```

***

### updateAccountType

`accountsTypes.updateAccountType`

Update Account Type (PUT /list/accountTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.accountsTypes.updateAccountType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   computeSfm?: boolean,
>   internal?: boolean,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Activities Entity

### activitiesSchema

`activitiesEntity.activitiesSchema`

Activities schema (GET /activities/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.activitiesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   checkin?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   checkinTypeId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   checkoutDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   comment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   contactId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   date?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocoded?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocodingAccuracy?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   latitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   longitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   opportunityId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   typeId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   }
> }
> ```

***

### createActivity

`activitiesEntity.createActivity`

Create Activity (POST /activities)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.createActivity({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId?: number,
>   date?: string,
>   checkin?: boolean,
>   checkinTypeId?: number,
>   comment?: string,
>   opportunityId?: number,
>   permissionLevel?: number,
>   salesRepId?: number,
>   typeId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteActivity

`activitiesEntity.deleteActivity`

Delete Activity (DELETE /activities/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.deleteActivity({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getActivity

`activitiesEntity.getActivity`

Get Activity (GET /activities/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.getActivity({
	path: { id: 1 },
	headers: { extraFieldDescription: '0' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountId` | `object` | No | — |
| `checkin` | `boolean` | No | — |
| `checkinTypeId` | `number` | No | — |
| `checkoutDate` | `JsonValue` | No | — |
| `comment` | `string` | No | — |
| `contactId` | `object` | No | — |
| `date` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `extId` | `JsonValue` | No | — |
| `geocoded` | `boolean` | No | — |
| `geocodingAccuracy` | `number` | No | — |
| `id` | `number` | No | — |
| `latitude` | `number` | No | — |
| `longitude` | `number` | No | — |
| `opportunityId` | `object` | No | — |
| `permissionLevel` | `number` | No | — |
| `readOnly` | `boolean` | No | — |
| `salesRepId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `typeId` | `object` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] contactId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] opportunityId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] typeId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listActivities

`activitiesEntity.listActivities`

List Activities (GET /activities)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.listActivities({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountId?: {
>     id?: number,
>     value?: string
>   },
>   checkin?: boolean,
>   checkinTypeId?: number,
>   checkoutDate?: JsonValue,
>   comment?: string,
>   contactId?: JsonValue,
>   date?: string,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   extId?: JsonValue,
>   geocoded?: boolean,
>   geocodingAccuracy?: number,
>   id?: number,
>   latitude?: number,
>   longitude?: number,
>   opportunityId?: {
>     id?: number,
>     value?: string
>   },
>   permissionLevel?: number,
>   readOnly?: boolean,
>   salesRepId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   typeId?: {
>     id?: number,
>     value?: string
>   }
> }[]
> ```

***

### updateActivity

`activitiesEntity.updateActivity`

Update Activity (PUT /activities/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.activitiesEntity.updateActivity({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment?: string,
>   geocoded?: boolean,
>   geocodingAccuracy?: number,
>   latitude?: number,
>   longitude?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Activities Points

### listActivityPoints

`activitiesPoints.listActivityPoints`

List Activity Points (GET /activity/points)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesPoints.listActivityPoints({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `IntervalDays` | `number` | No | — |
| `PointsPerActivity` | `number` | No | — |
| `PointsPerCheckin` | `number` | No | — |
| `PointsPerEmail` | `number` | No | — |
| `PointsPerFastCheckin` | `number` | No | — |
| `PointsPerInternalEmail` | `number` | No | — |
| `PointsPerInternalPhoneCallMinute` | `number` | No | — |
| `PointsPerOpportunity` | `number` | No | — |
| `PointsPerPhoneCallMinute` | `number` | No | — |
| `PointsPerQuote` | `number` | No | — |
| `PointsPerSalesOrder` | `number` | No | — |
| `PointsPerVisit` | `number` | No | — |
| `SalesInput` | `number` | No | — |
| `ScoringPerEnvironment` | `number` | No | — |

***

### updateActivityPoints

`activitiesPoints.updateActivityPoints`

Update Activity Points (PUT /activity/points)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.activitiesPoints.updateActivityPoints({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   IntervalDays?: number,
>   PointsPerActivity?: number,
>   PointsPerCheckin?: number,
>   PointsPerEmail?: number,
>   PointsPerFastCheckin?: number,
>   PointsPerInternalEmail?: number,
>   PointsPerInternalPhoneCallMinute?: number,
>   PointsPerOpportunity?: number,
>   PointsPerPhoneCallMinute?: number,
>   PointsPerQuote?: number,
>   PointsPerSalesOrder?: number,
>   PointsPerVisit?: number,
>   SalesInput?: number,
>   ScoringPerEnvironment?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `IntervalDays` | `number` | No | — |
| `PointsPerActivity` | `number` | No | — |
| `PointsPerCheckin` | `number` | No | — |
| `PointsPerEmail` | `number` | No | — |
| `PointsPerInternalEmail` | `number` | No | — |
| `PointsPerInternalPhoneCallMinute` | `number` | No | — |
| `PointsPerOpportunity` | `number` | No | — |
| `PointsPerPhoneCallMinute` | `number` | No | — |
| `PointsPerQuote` | `number` | No | — |
| `PointsPerVisit` | `number` | No | — |
| `SalesInput` | `number` | No | — |
| `ScoringPerEnvironment` | `number` | No | — |

***

## Activities Types

### activityTypesSchema

`activitiesTypes.activityTypesSchema`

Activity Types schema (GET /activityTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.activityTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   automatic?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   checkin?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fastCheckin?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   general?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   hide?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phoneCall?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   system?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   videoCall?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   visibleInActivities?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   visibleInAgendaActivities?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   visit?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   workflow?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createActivityType

`activitiesTypes.createActivityType`

Create Activity Type (POST /activityTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.createActivityType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   branchVisibility?: Record<string, JsonValue>[],
>   checkin?: boolean,
>   descriptionEN?: string,
>   descriptionES?: string,
>   fastCheckin?: boolean,
>   general?: boolean,
>   order?: string,
>   phoneCall?: boolean,
>   visit?: boolean,
>   videocall?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteActivityType

`activitiesTypes.deleteActivityType`

Delete Activity Type (DELETE /activityTypes/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.deleteActivityType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getActivityType

`activitiesTypes.getActivityType`

Get Activity Type (GET /activityTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.getActivityType({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `automatic` | `boolean` | No | — |
| `branchVisibility` | `object[]` | No | — |
| `checkin` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `fastCheckin` | `boolean` | No | — |
| `general` | `boolean` | No | — |
| `hide` | `boolean` | No | — |
| `id` | `number` | No | — |
| `order` | `JsonValue` | No | — |
| `phoneCall` | `boolean` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `system` | `boolean` | No | — |
| `videoCall` | `boolean` | No | — |
| `visibleInActivities` | `boolean` | No | — |
| `visibleInAgendaActivities` | `boolean` | No | — |
| `visit` | `boolean` | No | — |
| `workflow` | `boolean` | No | — |

> [accordion] branchVisibility full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }[]
> ```

***

### listActivityTypes

`activitiesTypes.listActivityTypes`

List Activity Types (GET /activityTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.listActivityTypes({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   automatic?: boolean,
>   branchVisibility?: JsonValue,
>   checkin?: boolean,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   fastCheckin?: boolean,
>   general?: boolean,
>   hide?: boolean,
>   id?: number,
>   order?: JsonValue,
>   phoneCall?: boolean,
>   salesRepIdCreated?: JsonValue,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   system?: boolean,
>   videoCall?: boolean,
>   visibleInActivities?: boolean,
>   visibleInAgendaActivities?: boolean,
>   visit?: boolean,
>   workflow?: boolean
> }[]
> ```

***

### updateActivityType

`activitiesTypes.updateActivityType`

Update Activity Type (PUT /activityTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.activitiesTypes.updateActivityType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Branches

### branchesSchema

`branches.branchesSchema`

Branches schema (GET /branches/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.branches.branchesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   currencyId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   default?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   imperialSystem?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   mainEnvironment?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   timeZoneId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   }
> }
> ```

***

### deleteBranch

`branches.deleteBranch`

Delete Branch (DELETE /branches/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.branches.deleteBranch({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getBranch

`branches.getBranch`

Get Branch (GET /branches/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.branches.getBranch({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `currencyId` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `default` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `imperialSystem` | `boolean` | No | — |
| `mainEnvironment` | `boolean` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `timeZoneId` | `object` | No | — |

> [accordion] timeZoneId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listBranches

`branches.listBranches`

List Branches (GET /branches)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.branches.listBranches({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   currencyId?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   default?: boolean,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   extId?: string,
>   id?: number,
>   imperialSystem?: boolean,
>   mainEnvironment?: boolean,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   timeZoneId?: {
>     id?: number,
>     value?: string
>   }
> }[]
> ```

***

## Bulks

### bulkCreateResources

`bulks.bulkCreateResources`

Bulk Create Resources (POST /VALUE/bulk)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.bulks.bulkCreateResources({
	path: { value: 'sample' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `Record<string, JsonValue>[]` | Yes | — |

Creates up to 200 records of the named resource in one call. For users or calendar events the same charges and invitation emails apply as for the single-record calls.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

### bulkDeleteResources

`bulks.bulkDeleteResources`

Bulk Delete Resources (DELETE /VALUE/bulk)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.bulks.bulkDeleteResources({
	path: { value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

### bulkUpdateResources

`bulks.bulkUpdateResources`

Bulk Update Resources (PUT /VALUE/bulk)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.bulks.bulkUpdateResources({
	path: { value: 'sample' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `Record<string, JsonValue>[]` | Yes | — |

Updates up to 200 records of the named resource in one call. For users or calendar events the same charges and invitation emails apply as for the single-record calls.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

## Calls

### createCallByUserId

`calls.createCallByUserId`

Create Call by User ID (POST /calls)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.calls.createCallByUserId({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   startDate?: string,
>   endDate?: string,
>   type?: number,
>   terminalType?: number,
>   phone?: string,
>   accountId?: number,
>   contactId?: number,
>   salesRepId?: number,
>   opportunityId?: number,
>   phoneAlias?: string,
>   timeZoneId?: number
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   duration?: number,
>   startDate?: string,
>   endDate?: string,
>   type?: number,
>   terminalType?: number,
>   phone?: string,
>   accountId?: number,
>   contactId?: number,
>   salesRepId?: number,
>   opportunityId?: number,
>   phoneAlias?: string,
>   description?: string,
>   timeZoneId?: number,
>   deleted?: boolean,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number
> }[]
> ```

***

### createCallByUserPhoneNumber

`calls.createCallByUserPhoneNumber`

Create Call by User Phone Number (POST /calls/identify)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.calls.createCallByUserPhoneNumber({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   startDate?: string,
>   endDate?: string,
>   type?: number,
>   terminalType?: number,
>   phone?: string,
>   accountId?: number,
>   contactId?: number,
>   userPhoneFM?: string,
>   opportunityId?: number,
>   phoneAlias?: string,
>   timeZoneId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### deleteCall

`calls.deleteCall`

Delete Call (DELETE /calls/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.calls.deleteCall({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `JsonValue`

***

### getCall

`calls.getCall`

Get Call (GET /calls/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.calls.getCall({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `duration` | `number` | No | — |
| `startDate` | `string` | No | — |
| `endDate` | `string` | No | — |
| `type` | `number` | No | — |
| `terminalType` | `number` | No | — |
| `phone` | `string` | No | — |
| `accountId` | `number` | No | — |
| `contactId` | `number` | No | — |
| `salesRepId` | `number` | No | — |
| `opportunityId` | `number` | No | — |
| `phoneAlias` | `string` | No | — |
| `description` | `string` | No | — |
| `timeZoneId` | `number` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `JsonValue` | No | — |
| `dateDeleted` | `string` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### getResourcesByPhoneNumber

`calls.getResourcesByPhoneNumber`

Get Resources by Phone Number (GET /calls/phone/VALUE)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.calls.getResourcesByPhoneNumber({
	path: { value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `userIds` | `JsonValue[]` | No | — |
| `contactIds` | `number[]` | No | — |
| `accountIds` | `number[]` | No | — |

***

### listCalls

`calls.listCalls`

List Calls (GET /calls)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.calls.listCalls({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   duration?: number,
>   startDate?: string,
>   endDate?: string,
>   type?: number,
>   terminalType?: number,
>   phone?: string,
>   accountId?: number,
>   contactId?: number,
>   salesRepId?: number,
>   opportunityId?: number,
>   phoneAlias?: string,
>   description?: string,
>   timeZoneId?: number,
>   deleted?: boolean,
>   dateCreated?: JsonValue,
>   dateDeleted?: string,
>   dateUpdated?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number
> }[]
> ```

***

### updateCall

`calls.updateCall`

Update Call (PUT /calls/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.calls.updateCall({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   startDate?: string,
>   endDate?: string,
>   phone?: string,
>   accountId?: number,
>   contactId?: number,
>   salesRepId?: number,
>   opportunityId?: number,
>   phoneAlias?: string,
>   timeZoneId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `duration` | `number` | No | — |
| `startDate` | `string` | No | — |
| `endDate` | `string` | No | — |
| `type` | `number` | No | — |
| `terminalType` | `number` | No | — |
| `phone` | `string` | No | — |
| `accountId` | `number` | No | — |
| `contactId` | `number` | No | — |
| `salesRepId` | `number` | No | — |
| `opportunityId` | `number` | No | — |
| `phoneAlias` | `string` | No | — |
| `description` | `string` | No | — |
| `timeZoneId` | `number` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `JsonValue` | No | — |
| `dateDeleted` | `string` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

## Campaigns Accounts

### createCampaignAccount

`campaignsAccounts.createCampaignAccount`

Create Campaign Account (POST /campaigns/\{ID}/entities/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsAccounts.createCampaignAccount({
	path: { id: 1, value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string,
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   activityId?: number,
>   completed?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `accountId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `completed` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `DateCreated` | `string` | No | — |
| `DateDeleted` | `JsonValue` | No | — |
| `DateUpdated` | `JsonValue` | No | — |
| `SalesRepIdCreated` | `number` | No | — |
| `SalesRepIdUpdated` | `number` | No | — |
| `SalesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### deleteCampaignAccount

`campaignsAccounts.deleteCampaignAccount`

Delete Campaign Account (DELETE /campaigns/\{ID}/entities/VALUE)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.campaignsAccounts.deleteCampaignAccount({
	path: { id: 1, value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string,
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### getCampaignAccount

`campaignsAccounts.getCampaignAccount`

Get Campaign Account (GET /campaigns/\{ID}/entities/VALUE)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsAccounts.getCampaignAccount({
	path: { id: 1, value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string,
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `accountId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `completed` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `DateCreated` | `string` | No | — |
| `DateDeleted` | `JsonValue` | No | — |
| `DateUpdated` | `JsonValue` | No | — |
| `SalesRepIdCreated` | `number` | No | — |
| `SalesRepIdUpdated` | `number` | No | — |
| `SalesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### listCampaignAccounts

`campaignsAccounts.listCampaignAccounts`

List Campaign Accounts (GET /campaigns/\{ID}/entities)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsAccounts.listCampaignAccounts({
	path: { id: 1 },
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `JsonValue`

***

### updateCampaignAccount

`campaignsAccounts.updateCampaignAccount`

Update Campaign Account (PUT /campaigns/\{ID}/entities/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsAccounts.updateCampaignAccount({
	path: { id: 1, value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string,
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   activityId?: number,
>   completed?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `accountId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `completed` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `DateCreated` | `string` | No | — |
| `DateDeleted` | `JsonValue` | No | — |
| `DateUpdated` | `string` | No | — |
| `SalesRepIdCreated` | `number` | No | — |
| `SalesRepIdUpdated` | `number` | No | — |
| `SalesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

## Campaigns Entity

### createCampaign

`campaignsEntity.createCampaign`

Create Campaign (POST /campaigns)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsEntity.createCampaign({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string,
>   description?: string,
>   ownerId?: number,
>   statusId?: number,
>   typeId?: number,
>   startDate?: string,
>   endDate?: string,
>   deleted?: boolean,
>   videoUrl?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `ownerId` | `number` | No | — |
| `statusId` | `number` | No | — |
| `typeId` | `number` | No | — |
| `startDate` | `string` | No | — |
| `endDate` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `videoUrl` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### deleteCampaign

`campaignsEntity.deleteCampaign`

Delete Campaign (DELETE /campaigns/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.campaignsEntity.deleteCampaign({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### getCampaign

`campaignsEntity.getCampaign`

Get Campaign (GET /campaigns/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsEntity.getCampaign({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `ownerId` | `number` | No | — |
| `statusId` | `number` | No | — |
| `typeId` | `number` | No | — |
| `startDate` | `string` | No | — |
| `endDate` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `videoUrl` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### listCampaigns

`campaignsEntity.listCampaigns`

List Campaigns (GET /campaigns)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsEntity.listCampaigns({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   title?: string,
>   description?: string,
>   ownerId?: number,
>   statusId?: number,
>   typeId?: number,
>   startDate?: string,
>   endDate?: string,
>   deleted?: boolean,
>   videoUrl?: string,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: string,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number
> }[]
> ```

***

### updateCampaign

`campaignsEntity.updateCampaign`

Update Campaign (PUT /campaigns/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsEntity.updateCampaign({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   startDate?: string,
>   endDate?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `ownerId` | `number` | No | — |
| `statusId` | `number` | No | — |
| `typeId` | `number` | No | — |
| `startDate` | `string` | No | — |
| `endDate` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `videoUrl` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

## Campaigns Question Answers

### createQuestionAnswer

`campaignsQuestionAnswers.createQuestionAnswer`

Create Question Answer (POST /campaignQuestions/VALUE/answers)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionAnswers.createQuestionAnswer({
	path: { value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   activityId?: number,
>   value?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `value` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### deleteQuestionAnswer

`campaignsQuestionAnswers.deleteQuestionAnswer`

Delete Question Answer (DELETE /campaignQuestions/VALUE/answers/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionAnswers.deleteQuestionAnswer({
	path: { value: 'sample', id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### getQuestionAnswer

`campaignsQuestionAnswers.getQuestionAnswer`

Get Question Answer (GET /campaignQuestions/VALUE/answers/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionAnswers.getQuestionAnswer({
	path: { value: 'sample', id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `value` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### listQuestionAnswers

`campaignsQuestionAnswers.listQuestionAnswers`

List Question Answers (GET /campaignQuestions/VALUE/answers)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionAnswers.listQuestionAnswers({
	path: { value: 'sample' },
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   questionId?: number,
>   activityId?: number,
>   value?: string,
>   deleted?: boolean,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number
> }[]
> ```

***

### updateQuestionAnswer

`campaignsQuestionAnswers.updateQuestionAnswer`

Update Question Answer (PUT /campaignQuestions/VALUE/answers/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionAnswers.updateQuestionAnswer({
	path: { value: 'sample', id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   activityId?: number,
>   value?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `activityId` | `number` | No | — |
| `value` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

## Campaigns Questions

### createCampaignQuestion

`campaignsQuestions.createCampaignQuestion`

Create Campaign Question (POST /campaignQuestions)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestions.createCampaignQuestion({
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `Record<string, JsonValue>[]` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   textES?: string,
>   textEN?: string,
>   textIT?: string,
>   textFR?: string,
>   textDE?: string,
>   textPT?: string,
>   textUS?: string,
>   textBR?: string,
>   textRU?: string,
>   textDK?: string,
>   type?: string,
>   mandatory?: boolean,
>   deleted?: boolean,
>   order?: number,
>   valueListName?: string,
>   linkedEntity?: string,
>   linkedEntityField?: string,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number,
>   custom?: boolean
> }[]
> ```

***

### deleteCampaignQuestion

`campaignsQuestions.deleteCampaignQuestion`

Delete Campaign Question (DELETE /campaignQuestions/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestions.deleteCampaignQuestion({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### getCampaignQuestion

`campaignsQuestions.getCampaignQuestion`

Get Campaign Question (GET /campaignQuestions/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestions.getCampaignQuestion({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `textES` | `string` | No | — |
| `textEN` | `string` | No | — |
| `textIT` | `string` | No | — |
| `textFR` | `string` | No | — |
| `textDE` | `string` | No | — |
| `textPT` | `string` | No | — |
| `textUS` | `string` | No | — |
| `textBR` | `string` | No | — |
| `textRU` | `string` | No | — |
| `textDK` | `string` | No | — |
| `type` | `string` | No | — |
| `mandatory` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `order` | `number` | No | — |
| `valueListName` | `string` | No | — |
| `linkedEntity` | `string` | No | — |
| `linkedEntityField` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |
| `custom` | `boolean` | No | — |

***

### listCampaignQuestions

`campaignsQuestions.listCampaignQuestions`

List Campaign Questions (GET /campaignQuestions)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestions.listCampaignQuestions({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   campaignId?: number,
>   textES?: string,
>   textEN?: string,
>   textIT?: string,
>   textFR?: string,
>   textDE?: string,
>   textPT?: string,
>   textUS?: string,
>   textBR?: string,
>   textRU?: string,
>   textDK?: string,
>   type?: string,
>   mandatory?: boolean,
>   deleted?: boolean,
>   order?: number,
>   valueListName?: string,
>   linkedEntity?: string,
>   linkedEntityField?: string,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number,
>   custom?: boolean
> }[]
> ```

***

### updateCampaignQuestion

`campaignsQuestions.updateCampaignQuestion`

Update Campaign Question (PUT /campaignQuestions/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestions.updateCampaignQuestion({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   textEN?: string,
>   mandatory?: boolean,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `campaignId` | `number` | No | — |
| `textES` | `string` | No | — |
| `textEN` | `string` | No | — |
| `textIT` | `string` | No | — |
| `textFR` | `string` | No | — |
| `textDE` | `string` | No | — |
| `textPT` | `string` | No | — |
| `textUS` | `string` | No | — |
| `textBR` | `string` | No | — |
| `textRU` | `string` | No | — |
| `textDK` | `string` | No | — |
| `type` | `string` | No | — |
| `mandatory` | `boolean` | No | — |
| `deleted` | `boolean` | No | — |
| `order` | `number` | No | — |
| `valueListName` | `string` | No | — |
| `linkedEntity` | `string` | No | — |
| `linkedEntityField` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |
| `custom` | `boolean` | No | — |

***

## Campaigns Question Values

### createQuestionValue

`campaignsQuestionValues.createQuestionValue`

Create Question Value (POST /campaignQuestions/\{ID}/values)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionValues.createQuestionValue({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   textEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `textES` | `string` | No | — |
| `textEN` | `string` | No | — |
| `textIT` | `string` | No | — |
| `textFR` | `string` | No | — |
| `textDE` | `string` | No | — |
| `textPT` | `string` | No | — |
| `textUS` | `string` | No | — |
| `textBR` | `string` | No | — |
| `textRU` | `string` | No | — |
| `textDK` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### deleteQuestionValue

`campaignsQuestionValues.deleteQuestionValue`

Delete Question Value (DELETE /campaignQuestions/VALUE/values/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionValues.deleteQuestionValue({
	path: { value: 'sample', id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | No | — |

***

### getQuestionValue

`campaignsQuestionValues.getQuestionValue`

Get Question Value (GET /campaignQuestions/VALUE/values/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionValues.getQuestionValue({
	path: { value: 'sample', id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `textES` | `string` | No | — |
| `textEN` | `string` | No | — |
| `textIT` | `string` | No | — |
| `textFR` | `string` | No | — |
| `textDE` | `string` | No | — |
| `textPT` | `string` | No | — |
| `textUS` | `string` | No | — |
| `textBR` | `string` | No | — |
| `textRU` | `string` | No | — |
| `textDK` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

### listQuestionValues

`campaignsQuestionValues.listQuestionValues`

List Question Values (GET /campaignQuestions/VALUE/values)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionValues.listQuestionValues({
	path: { value: 'sample' },
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   questionId?: number,
>   textES?: string,
>   textEN?: string,
>   textIT?: string,
>   textFR?: string,
>   textDE?: string,
>   textPT?: string,
>   textUS?: string,
>   textBR?: string,
>   textRU?: string,
>   textDK?: string,
>   deleted?: boolean,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: string,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   id?: number
> }[]
> ```

***

### updateQuestionValue

`campaignsQuestionValues.updateQuestionValue`

Update Question Value (PUT /campaignQuestions/VALUE/values/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.campaignsQuestionValues.updateQuestionValue({
	path: { value: 'sample', id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   textEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `questionId` | `number` | No | — |
| `textES` | `string` | No | — |
| `textEN` | `string` | No | — |
| `textIT` | `string` | No | — |
| `textFR` | `string` | No | — |
| `textDE` | `string` | No | — |
| `textPT` | `string` | No | — |
| `textUS` | `string` | No | — |
| `textBR` | `string` | No | — |
| `textRU` | `string` | No | — |
| `textDK` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `id` | `number` | No | — |

***

## Campaigns Statuses

### listCampaignStatuses

`campaignsStatuses.listCampaignStatuses`

List Campaign Statuses (GET /campaignStatuses)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.campaignsStatuses.listCampaignStatuses({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionIT?: string,
>   descriptionFR?: string,
>   descriptionDE?: string,
>   descriptionPT?: string,
>   descriptionUS?: string,
>   descriptionBR?: string,
>   descriptionRU?: string,
>   descriptionDK?: string
> }[]
> ```

***

## Contacts Entity

### contactsSchema

`contactsEntity.contactsSchema`

Contacts schema (GET /contacts/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.contactsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   UseCompanyAddress?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   address1?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   birthday?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   city?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   comment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   countryId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   email?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   email2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   email3?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fax?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   firstName?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   gender?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lastName?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   linkedin?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   marketingCommunications?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone1?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   postcode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   region?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   skype?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   typeId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   }
> }
> ```

***

### createContact

`contactsEntity.createContact`

Create Contact (POST /contacts)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.createContact({
	body: {
		accountId: 1,
		firstName: 'sample',
		lastName: 'sample',
		salesRepId: 1,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId: number,
>   address1?: string,
>   city?: string,
>   comment?: string,
>   countryId?: number,
>   email?: string,
>   fax?: string,
>   firstName: string,
>   gender?: number,
>   lastName: string,
>   linkedin?: string,
>   permissionLevel?: number,
>   phone1?: string,
>   phone2?: string,
>   postcode?: string,
>   readOnly?: boolean,
>   region?: string,
>   salesRepId: number,
>   skype?: string,
>   typeId?: number,
>   birthday?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteContact

`contactsEntity.deleteContact`

Delete Contact (DELETE /contacts/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.deleteContact({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getContact

`contactsEntity.getContact`

Get Contact (GET /contacts/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.getContact({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `UseCompanyAddress` | `boolean` | No | — |
| `accountId` | `object` | No | — |
| `address1` | `string` | No | — |
| `birthday` | `string` | No | — |
| `city` | `string` | No | — |
| `comment` | `string` | No | — |
| `countryId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `email` | `string` | No | — |
| `email2` | `JsonValue` | No | — |
| `email3` | `JsonValue` | No | — |
| `extId` | `JsonValue` | No | — |
| `fax` | `string` | No | — |
| `firstName` | `string` | No | — |
| `gender` | `object` | No | — |
| `id` | `number` | No | — |
| `lastName` | `string` | No | — |
| `linkedin` | `string` | No | — |
| `marketingCommunications` | `boolean` | No | — |
| `permissionLevel` | `number` | No | — |
| `phone1` | `string` | No | — |
| `phone2` | `string` | No | — |
| `postcode` | `string` | No | — |
| `readOnly` | `boolean` | No | — |
| `region` | `string` | No | — |
| `salesRepId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `skype` | `string` | No | — |
| `typeId` | `object` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] countryId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] gender full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] typeId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listContacts

`contactsEntity.listContacts`

List Contacts (GET /contacts)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.listContacts({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   UseCompanyAddress?: boolean,
>   accountId?: {
>     id?: number,
>     value?: string
>   },
>   address1?: string,
>   birthday?: JsonValue,
>   city?: string,
>   comment?: string,
>   countryId?: {
>     id?: number,
>     value?: string
>   },
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   email?: string,
>   email2?: JsonValue,
>   email3?: JsonValue,
>   extId?: JsonValue,
>   fax?: string,
>   firstName?: string,
>   gender?: {
>     id?: number,
>     value?: string
>   },
>   id?: number,
>   lastName?: string,
>   linkedin?: string,
>   marketingCommunications?: boolean,
>   permissionLevel?: number,
>   phone1?: string,
>   phone2?: string,
>   postcode?: string,
>   readOnly?: boolean,
>   region?: string,
>   salesRepId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   skype?: string,
>   typeId?: {
>     id?: number,
>     value?: string
>   }
> }[]
> ```

***

### updateContact

`contactsEntity.updateContact`

Update Contact (PUT /contacts/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.contactsEntity.updateContact({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address1?: string,
>   city?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Contacts Types

### contactTypesSchema

`contactsTypes.contactTypesSchema`

Contact Types schema (GET /contactTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.contactTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### createContactType

`contactsTypes.createContactType`

Create Contact Type (POST /contactTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.createContactType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteContactType

`contactsTypes.deleteContactType`

Delete Contact Type (DELETE /contactTypes/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.deleteContactType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getContactType

`contactsTypes.getContactType`

Get Contact Type (GET /contactTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.getContactType({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `order` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |

***

### listContactTypes

`contactsTypes.listContactTypes`

List Contact Types (GET /contactTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.listContactTypes({
	query: { page: 0 },
	headers: { extraFieldDescription: '0' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   order?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number
> }[]
> ```

***

### updateContactType

`contactsTypes.updateContactType`

Update Contact Type (PUT /contactTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.contactsTypes.updateContactType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Countries

### countriesSchema

`countries.countriesSchema`

Countries schema (GET /countries/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.countries.countriesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionde?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionen?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionfr?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionit?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionpt?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   iso2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   iso3?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isoNum?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phoneCode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   strName?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### listCountries

`countries.listCountries`

List Countries (GET /countries)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.countries.listCountries({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: string,
>   descriptionDK?: string,
>   descriptionRU?: JsonValue,
>   descriptionUS?: string,
>   descriptionde?: string,
>   descriptionen?: string,
>   descriptionfr?: string,
>   descriptionit?: string,
>   descriptionpt?: string,
>   id?: number,
>   iso2?: string,
>   iso3?: string,
>   isoNum?: number,
>   phoneCode?: string,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   strName?: string
> }[]
> ```

***

## Currencies

### currenciesSchema

`currencies.currenciesSchema`

Currencies schema (GET /currencies/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.currencies.currenciesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isoCode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   symbol?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### listCurrencies

`currencies.listCurrencies`

List Currencies (GET /currencies)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.currencies.listCurrencies({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: JsonValue,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   isoCode?: string,
>   salesRepIdCreated?: JsonValue,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   symbol?: string
> }[]
> ```

***

## Documents Entity

### listDocuments

`documentsEntity.listDocuments`

List Documents (GET /documents)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.documentsEntity.listDocuments({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   description?: string,
>   name?: string,
>   extension?: string,
>   folderId?: number,
>   opportunityId?: number,
>   quoteId?: number,
>   deleted?: boolean,
>   dateDeleted?: JsonValue,
>   userId?: number,
>   size?: number,
>   level?: number,
>   accountId?: number,
>   contactId?: number,
>   activityId?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   extId?: JsonValue,
>   link?: string,
>   salesOrderId?: number,
>   formId?: number,
>   billboardId?: number,
>   carrousel?: boolean,
>   campaignId?: number
> }[]
> ```

***

### listDocumentsOfAResource

`documentsEntity.listDocumentsOfAResource`

List Documents of a Resource (GET /VALUE/VALUE/documents)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.documentsEntity.listDocumentsOfAResource({
	path: { value: 'sample', value2: 'sample' },
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   description?: string,
>   name?: string,
>   extension?: string,
>   folderId?: number,
>   opportunityId?: number,
>   quoteId?: number,
>   deleted?: boolean,
>   dateDeleted?: JsonValue,
>   userId?: number,
>   size?: number,
>   level?: number,
>   accountId?: number,
>   activityId?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   extId?: JsonValue,
>   link?: string,
>   salesOrderId?: number,
>   formId?: number,
>   billboardId?: number,
>   campaignId?: number,
>   contactId?: number,
>   isCarroussel?: boolean
> }[]
> ```

***

## Documents Folders

### createFolder

`documentsFolders.createFolder`

Create Folder (POST /documents/folders)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.documentsFolders.createFolder({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   folderId?: number,
>   name?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### createFolderForAResource

`documentsFolders.createFolderForAResource`

Create Folder for a Resource (POST /VALUE/VALUE/documents/folders)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.documentsFolders.createFolderForAResource({
	path: { value: 'sample', value2: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   folderId?: number,
>   name?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### listFolders

`documentsFolders.listFolders`

List Folders (GET /documents/folders)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.documentsFolders.listFolders({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: JsonValue,
>   dateCreated?: string,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   dateDeleted?: JsonValue,
>   name?: string,
>   folderId?: number,
>   restrictSucursales?: boolean,
>   level?: number,
>   entityId?: JsonValue
> }[]
> ```

***

### listFoldersOfAResource

`documentsFolders.listFoldersOfAResource`

List Folders of a Resource (GET /VALUE/VALUE/documents/folders)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.documentsFolders.listFoldersOfAResource({
	path: { value: 'sample', value2: 'sample' },
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: JsonValue,
>   dateCreated?: string,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   dateDeleted?: JsonValue,
>   name?: string,
>   folderId?: number,
>   restrictSucursales?: boolean,
>   level?: number,
>   entityId?: JsonValue
> }[]
> ```

***

## Emails

### createEmail

`emails.createEmail`

Create Email (POST /emails)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.emails.createEmail({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emailTo?: Record<string, JsonValue>[],
>   attachments?: Record<string, JsonValue>[],
>   extId?: string,
>   accountId?: number,
>   contactId?: number,
>   opportunityId?: number,
>   salesRepId?: number,
>   emailFrom?: string,
>   body?: string,
>   date?: string,
>   type?: number,
>   mailFolder?: string,
>   subject?: string
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   emailTo?: string
> }[]
> ```

***

### emailsSchema

`emails.emailsSchema`

Emails schema (GET /emails/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.emails.emailsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountId?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   attachments?: {
>     properties?: {
>       id?: {
>         type?: string
>       },
>       name?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean
>   },
>   body?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   contactId?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   date?: {
>     properties?: {
>       time?: {
>         format?: string,
>         readOnly?: boolean,
>         type?: string[]
>       },
>       timeStamp?: {
>         format?: string,
>         readOnly?: boolean,
>         type?: string[]
>       },
>       timeZone?: {
>         readOnly?: boolean,
>         type?: string[]
>       }
>     },
>     readOnly?: boolean
>   },
>   date_created?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   date_deleted?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   date_updated?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   emailFrom?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   emailTo?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     readOnly?: boolean,
>     type?: string
>   },
>   mailFolder?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   opportunityId?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   salesRepId?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   subject?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   type?: {
>     readOnly?: boolean,
>     type?: string
>   },
>   user_created?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   user_deleted?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   user_updated?: {
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### getEmail

`emails.getEmail`

Get Email (GET /emails/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.emails.getEmail({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `JsonValue`

***

### listEmails

`emails.listEmails`

List Emails (GET /emails)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.emails.listEmails({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   emailTo?: string,
>   attachments?: JsonValue[],
>   extId?: JsonValue,
>   accountId?: number,
>   contactId?: number,
>   opportunityId?: JsonValue,
>   salesRepId?: number,
>   emailFrom?: string,
>   body?: string,
>   date?: {
>     time?: string,
>     timeStamp?: number,
>     timeZone?: string
>   },
>   type?: number,
>   mailFolder?: JsonValue,
>   subject?: string,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   dateCreated?: string,
>   dateUpdated?: JsonValue,
>   dateDeleted?: JsonValue,
>   deleted?: boolean
> }[]
> ```

***

## Entity Contacts

### entityContactsSchema

`entityContacts.entityContactsSchema`

Entity Contacts schema (GET /contactsEntities/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.entityContacts.entityContactsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `JsonValue`

***

### listEntityContacts

`entityContacts.listEntityContacts`

List Entity Contacts (GET /contactsEntities)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.entityContacts.listEntityContacts({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `JsonValue`

***

## Entity Owners

### entityOwnersSchema

`entityOwners.entityOwnersSchema`

Entity Owners schema (GET /entityOwners/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.entityOwners.entityOwnersSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   entityId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   entityTypeId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepOrder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### listEntityOwners

`entityOwners.listEntityOwners`

List Entity Owners (GET /entityOwners)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.entityOwners.listEntityOwners({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   entityId?: number,
>   entityTypeId?: number,
>   id?: number,
>   salesRepId?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   salesRepOrder?: number
> }[]
> ```

***

## Events Tasks

### calendarSchema

`eventsTasks.calendarSchema`

Calendar schema (GET /calendar/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.calendarSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   Completed?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   allDay?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   comment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   contactId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   endDate?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   endHour?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   opportunityId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reminder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   sendNotification?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   startDate?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   startHour?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   subject?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   task?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   typeId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   videoCallMeetingDetails?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   videoCallProviderId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   }
> }
> ```

***

### createCalendar

`eventsTasks.createCalendar`

Create Calendar (POST /calendar)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.createCalendar({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

With sendNotification true, ForceManager emails an invitation to the event's contacts. Leave it unset or false unless the contacts should be invited.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId?: number,
>   allDay?: boolean,
>   branchId?: number,
>   comment?: string,
>   contactId?: number,
>   endDate?: string,
>   salesRepId?: number,
>   sendNotification?: boolean,
>   startDate?: string,
>   startHour?: string,
>   subject?: string,
>   task?: boolean,
>   typeId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteCalendar

`eventsTasks.deleteCalendar`

Delete Calendar (DELETE /calendar/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.deleteCalendar({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getCalendar

`eventsTasks.getCalendar`

Get Calendar (GET /calendar/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.getCalendar({
	path: { id: 1 },
	headers: { extraFieldDescription: '0' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountId` | `object` | No | — |
| `allDay` | `boolean` | No | — |
| `branchId` | `object` | No | — |
| `comment` | `string` | No | — |
| `completed` | `boolean` | No | — |
| `contactId` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `endDate` | `string` | No | — |
| `endHour` | `string` | No | — |
| `extId` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `opportunityId` | `JsonValue` | No | — |
| `permissionLevel` | `number` | No | — |
| `readOnly` | `boolean` | No | — |
| `reminder` | `number` | No | — |
| `salesRepId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `sendNotification` | `boolean` | No | — |
| `startDate` | `string` | No | — |
| `startHour` | `string` | No | — |
| `subject` | `string` | No | — |
| `task` | `boolean` | No | — |
| `typeId` | `object` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] branchId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] typeId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listCalendar

`eventsTasks.listCalendar`

List Calendar (GET /calendar)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.listCalendar({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountId?: JsonValue,
>   allDay?: boolean,
>   branchId?: {
>     id?: number,
>     value?: string
>   },
>   comment?: string,
>   completed?: boolean,
>   contactId?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   endDate?: JsonValue,
>   endHour?: JsonValue,
>   extId?: JsonValue,
>   id?: number,
>   opportunityId?: JsonValue,
>   permissionLevel?: number,
>   readOnly?: boolean,
>   reminder?: number,
>   salesRepId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   sendNotification?: boolean,
>   startDate?: string,
>   startHour?: string,
>   subject?: string,
>   task?: boolean,
>   typeId?: {
>     id?: number,
>     value?: string
>   }
> }[]
> ```

***

### updateCalendar

`eventsTasks.updateCalendar`

Update Calendar (PUT /calendar/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.eventsTasks.updateCalendar({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

With sendNotification true, ForceManager emails an invitation to the event's contacts. Leave it unset or false unless the contacts should be invited.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   salesRepId?: string,
>   sendNotification?: boolean,
>   startDate?: string,
>   startHour?: string,
>   subject?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Extra Fields Entity

### createExtraFieldForResource

`extraFieldsEntity.createExtraFieldForResource`

Create Extra Field for Resource (POST /extrafields/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsEntity.createExtraFieldForResource({
	path: { value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fieldName?: string,
>   valueListRelated?: string,
>   description?: string,
>   searchable?: boolean,
>   visibleInList?: boolean,
>   order?: number,
>   webVisibility?: boolean,
>   tabId?: number,
>   multilanguage?: boolean,
>   mobileVisibility?: boolean,
>   mandatory?: boolean,
>   readOnly?: boolean,
>   descriptionEN?: string,
>   descriptionIT?: string,
>   descriptionFR?: string,
>   descriptionDE?: string,
>   descriptionPT?: string,
>   descriptionUS?: string,
>   descriptionRU?: string,
>   descriptionBR?: string,
>   descriptionDK?: string,
>   branches?: Record<string, JsonValue>[],
>   defaultValue?: string,
>   restApi?: boolean,
>   visibleInPhoneCallForm?: boolean,
>   type?: string,
>   length?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### extraFieldsSchemaByResource

`extraFieldsEntity.extraFieldsSchemaByResource`

Extra Fields schema by Resource (GET /extrafields/VALUE/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsEntity.extraFieldsSchemaByResource({
	path: { value: 'sample' },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branches?: {
>     items?: {
>       maxLength?: number,
>       type?: string
>     },
>     type?: string
>   },
>   dateCreated?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   defaultValue?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dependenceField?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dynamicField?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dynamicFieldValues?: {
>     items?: {
>       type?: string
>     },
>     readOnly?: boolean,
>     type?: string[]
>   },
>   entity?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fieldName?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     readOnly?: boolean,
>     type?: string
>   },
>   idsDynamism?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   length?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   mandatory?: {
>     type?: string[]
>   },
>   mobileVisibility?: {
>     type?: string[]
>   },
>   multilanguage?: {
>     type?: string[]
>   },
>   order?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     type?: string[]
>   },
>   restApi?: {
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   searchable?: {
>     format?: string,
>     type?: string[]
>   },
>   tabId?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   type?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   valueListRelated?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   visibleInList?: {
>     type?: string[]
>   },
>   visibleInPhoneCallForm?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   webVisibility?: {
>     type?: string[]
>   }
> }
> ```

***

### listExtraFieldsByResource

`extraFieldsEntity.listExtraFieldsByResource`

List Extra Fields by Resource (GET /extrafields/VALUE)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsEntity.listExtraFieldsByResource({
	path: { value: 'sample' },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   entity?: string,
>   fieldName?: string,
>   valueListRelated?: string,
>   description?: string,
>   deleted?: boolean,
>   dateDeleted?: JsonValue,
>   searchable?: boolean,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: JsonValue,
>   dateCreated?: string,
>   dateUpdated?: JsonValue,
>   visibleInList?: boolean,
>   order?: number,
>   webVisibility?: boolean,
>   tabId?: number,
>   mobileVisibility?: boolean,
>   mandatory?: boolean,
>   readOnly?: boolean,
>   descriptionEN?: string,
>   descriptionIT?: string,
>   descriptionFR?: string,
>   descriptionDE?: string,
>   descriptionPT?: string,
>   descriptionUS?: string,
>   descriptionRU?: string,
>   descriptionBR?: string,
>   descriptionDK?: string,
>   branches?: JsonValue,
>   defaultValue?: string,
>   restApi?: boolean,
>   idsDynamism?: JsonValue,
>   visibleInPhoneCallForm?: boolean,
>   type?: string,
>   length?: number,
>   dynamicField?: JsonValue,
>   dynamicFieldValues?: JsonValue,
>   dependenceField?: JsonValue,
>   fuzzySearch?: JsonValue,
>   includeTime?: boolean,
>   mandatoryRestApi?: boolean
> }[]
> ```

***

## Extra Fields Tabs

### createTabs

`extraFieldsTabs.createTabs`

Create Tabs (POST /extrafieldsTabs)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsTabs.createTabs({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   order?: number,
>   entity?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteTabs

`extraFieldsTabs.deleteTabs`

Delete Tabs (DELETE /extrafieldsTabs/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsTabs.deleteTabs({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getTabs

`extraFieldsTabs.getTabs`

Get Tabs (GET /extrafieldsTabs/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsTabs.getTabs({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `string`

***

### listTabs

`extraFieldsTabs.listTabs`

List Tabs (GET /extrafieldsTabs)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsTabs.listTabs({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: JsonValue,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   order?: number,
>   entity?: string,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### updateTabs

`extraFieldsTabs.updateTabs`

Update Tabs (PUT /extrafieldsTabs/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.extraFieldsTabs.updateTabs({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Forms Entity

### getForm

`formsEntity.getForm`

Get Form (GET /forms/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.formsEntity.getForm({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `list` | `string` | No | — |
| `detail` | `string` | No | — |
| `jsonData` | `string` | No | — |
| `formTemplateId` | `number` | No | — |
| `statusId` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `dateDeleted` | `string` | No | — |
| `deleted` | `boolean` | No | — |

***

## Forms States

### getFormState

`formsStates.getFormState`

Get Form State (GET /forms/\{ID}/state)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.formsStates.getFormState({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `intOrder` | `number` | No | — |
| `idParent` | `JsonValue` | No | — |
| `blnEndState` | `boolean` | No | — |
| `strIdEnvironment` | `string` | No | — |
| `descriptionEN` | `JsonValue` | No | — |
| `description` | `string` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |

***

## Forms Templates

### getFormTemplate

`formsTemplates.getFormTemplate`

Get Form Template (GET /forms/\{ID}/template)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.formsTemplates.getFormTemplate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `guid` | `string` | No | — |
| `type` | `number` | No | — |
| `typeDescription` | `string` | No | — |
| `url` | `string` | No | — |
| `active` | `boolean` | No | — |
| `idRole` | `JsonValue` | No | — |
| `extraFields` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `userDeleted` | `JsonValue` | No | — |
| `userCreated` | `number` | No | — |
| `userUpdated` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateUpdated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `descriptionEN` | `JsonValue` | No | — |
| `description` | `string` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |

***

## News

### listNews

`news.listNews`

List News (GET /news)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.news.listNews({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionText?: string,
>   endDate?: string,
>   id?: number,
>   salesRepIDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: JsonValue,
>   startDate?: string,
>   status?: number,
>   subject?: string,
>   totalUsers?: number
> }[]
> ```

***

## Opportunities Entity

### createOpportunity

`opportunitiesEntity.createOpportunity`

Create Opportunity (POST /opportunities)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.createOpportunity({
	body: {
		branchId: 1,
		reference: 'sample',
		salesProbability: 1,
		salesRepId: 1,
		statusId: 1,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId1?: number,
>   address1?: string,
>   branchId: number,
>   city?: string,
>   comments?: string,
>   currencyId?: number,
>   geocoded?: boolean,
>   geocodingAccuracy?: number,
>   latitude?: number,
>   longitude?: number,
>   lostDate?: string,
>   permissionLevel?: number,
>   postcode?: string,
>   readOnly?: boolean,
>   reference: string,
>   salesProbability: number,
>   salesRepId: number,
>   statusId: number,
>   total?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOpportunity

`opportunitiesEntity.deleteOpportunity`

Delete Opportunity (DELETE /opportunities/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.deleteOpportunity({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOpportunity

`opportunitiesEntity.getOpportunity`

Get Opportunity (GET /opportunities/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.getOpportunity({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountId1` | `object` | No | — |
| `accountId2` | `JsonValue` | No | — |
| `accountId3` | `JsonValue` | No | — |
| `address1` | `string` | No | — |
| `address2` | `JsonValue` | No | — |
| `branchId` | `object` | No | — |
| `city` | `string` | No | — |
| `closedDate` | `JsonValue` | No | — |
| `comments` | `string` | No | — |
| `countryId` | `JsonValue` | No | — |
| `currencyId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateGeocoded` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `extId` | `JsonValue` | No | — |
| `geocoded` | `boolean` | No | — |
| `geocodingAccuracy` | `number` | No | — |
| `id` | `number` | No | — |
| `latitude` | `number` | No | — |
| `longitude` | `number` | No | — |
| `lostDate` | `JsonValue` | No | — |
| `permissionLevel` | `number` | No | — |
| `postcode` | `string` | No | — |
| `readOnly` | `boolean` | No | — |
| `reference` | `string` | No | — |
| `region` | `JsonValue` | No | — |
| `salesForecastDate` | `JsonValue` | No | — |
| `salesProbability` | `number` | No | — |
| `salesRepId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `statusId` | `object` | No | — |
| `total` | `number` | No | — |
| `type_id` | `JsonValue` | No | — |
| `wonDate` | `JsonValue` | No | — |

> [accordion] accountId1 full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] branchId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] currencyId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] statusId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listOpportunities

`opportunitiesEntity.listOpportunities`

List Opportunities (GET /opportunities)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.listOpportunities({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountId1?: {
>     id?: number,
>     value?: string
>   },
>   accountId2?: JsonValue,
>   accountId3?: JsonValue,
>   address1?: JsonValue,
>   address2?: JsonValue,
>   branchId?: {
>     id?: number,
>     value?: string
>   },
>   city?: JsonValue,
>   closedDate?: string,
>   comments?: JsonValue,
>   countryId?: {
>     id?: number,
>     value?: string
>   },
>   currencyId?: {
>     id?: number,
>     value?: string
>   },
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateGeocoded?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   extId?: string,
>   geocoded?: boolean,
>   geocodingAccuracy?: JsonValue,
>   id?: number,
>   latitude?: JsonValue,
>   longitude?: JsonValue,
>   lostDate?: JsonValue,
>   permissionLevel?: number,
>   postcode?: JsonValue,
>   readOnly?: boolean,
>   reference?: string,
>   region?: JsonValue,
>   salesForecastDate?: string,
>   salesProbability?: number,
>   salesRepId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   statusId?: {
>     id?: number,
>     value?: string
>   },
>   total?: number,
>   type_id?: {
>     id?: number,
>     value?: string
>   },
>   wonDate?: JsonValue
> }[]
> ```

***

### opportunitiesSchema

`opportunitiesEntity.opportunitiesSchema`

Opportunities schema (GET /opportunities/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.opportunitiesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountId1?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   accountId2?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   accountId3?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   address1?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   address2?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   city?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   closedDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   comments?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   countryId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   currencyId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateGeocoded?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocoded?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   geocodingAccuracy?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   latitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   longitude?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lostDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   postcode?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reference?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   region?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesForecastDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesProbability?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   statusId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   total?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   type_id?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   wonDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOpportunity

`opportunitiesEntity.updateOpportunity`

Update Opportunity (PUT /opportunities/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesEntity.updateOpportunity({
	path: { id: 1 },
	body: { salesProbability: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   salesProbability: number,
>   total?: number,
>   comments?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Opportunities Statuses

### createOpportunityStatus

`opportunitiesStatuses.createOpportunityStatus`

Create Opportunity Status (POST /opportunityStatuses)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.createOpportunityStatus({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionBR?: string,
>   descriptionDE?: string,
>   descriptionDK?: string,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: string,
>   descriptionRU?: string,
>   descriptionUS?: string,
>   endStatus?: boolean,
>   order?: number,
>   won?: number,
>   idParent?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOpportunityStatus

`opportunitiesStatuses.deleteOpportunityStatus`

Delete Opportunity Status (DELETE /opportunityStatuses/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.deleteOpportunityStatus({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOpportunityStatus

`opportunitiesStatuses.getOpportunityStatus`

Get Opportunity Status (GET /opportunityStatuses/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.getOpportunityStatus({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `string` | No | — |
| `endStatus` | `boolean` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `order` | `number` | No | — |
| `salesProbability` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `won` | `number` | No | — |

***

### listOpportunityStatuses

`opportunitiesStatuses.listOpportunityStatuses`

List Opportunity Statuses (GET /opportunityStatuses)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.listOpportunityStatuses({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   endStatus?: boolean,
>   id?: number,
>   idParent?: JsonValue,
>   order?: number,
>   salesProbability?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: number,
>   salesRepIdUpdated?: number,
>   won?: number
> }[]
> ```

***

### opportunityStatusesSchema

`opportunitiesStatuses.opportunityStatusesSchema`

Opportunity Statuses schema (GET /opportunityStatuses/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.opportunityStatusesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   endStatus?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesProbability?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   won?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOpportunityStatus

`opportunitiesStatuses.updateOpportunityStatus`

Update Opportunity Status (PUT /opportunityStatuses/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesStatuses.updateOpportunityStatus({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   branchVisibility?: Record<string, JsonValue>[],
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   endStatus?: boolean,
>   won?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Opportunities Types

### createOpportunityType

`opportunitiesTypes.createOpportunityType`

Create Opportunity Type (POST /opportunityTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.createOpportunityType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   branchVisibility?: Record<string, JsonValue>[],
>   descriptionEN?: string,
>   defaultStatus?: number,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOpportunityType

`opportunitiesTypes.deleteOpportunityType`

Delete Opportunity Type (DELETE /opportunityTypes/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.deleteOpportunityType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOpportunityTypes

`opportunitiesTypes.getOpportunityTypes`

Get Opportunity Types (GET /opportunityTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.getOpportunityTypes({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `object[]` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `defaultStatus` | `number` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `order` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

> [accordion] branchVisibility full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }[]
> ```

***

### listOpportunityTypes

`opportunitiesTypes.listOpportunityTypes`

List Opportunity Types (GET /opportunityTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.listOpportunityTypes({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `string`

***

### opportunityTypesSchema

`opportunitiesTypes.opportunityTypesSchema`

Opportunity Types schema (GET /opportunityTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.opportunityTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   defaultStatus?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOpportunityType

`opportunitiesTypes.updateOpportunityType`

Update Opportunity Type (PUT /opportunityTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.opportunitiesTypes.updateOpportunityType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Orders Entity

### createOrderHeader

`ordersEntity.createOrderHeader`

Create Order Header (POST /salesorders)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.createOrderHeader({
	body: { branchId: 1, reference: 'sample', salesRepId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountAddressId?: string,
>   accountId?: number,
>   archived?: boolean,
>   branchId: number,
>   closedDate?: string,
>   comment?: string,
>   contactId?: string,
>   currencyId?: string,
>   discount1?: number,
>   discount2?: number,
>   discount3?: number,
>   discount4?: number,
>   extId?: string,
>   internalComment?: string,
>   internalCommentUpdateDate?: string,
>   internalCommentUpdateSalesRepId?: string,
>   mainSalesorder?: string,
>   number?: number,
>   opportunityId?: string,
>   rateId?: number,
>   readOnly?: boolean,
>   reference: string,
>   salesRepId: number,
>   statusId?: number,
>   total?: number,
>   year?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### createOrderLine

`ordersEntity.createOrderLine`

Create Order Line (POST /salesOrdersLines)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.createOrderLine({
	body: { price: 1, productId: 1, quantity: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   description?: string,
>   discount1?: number,
>   price: number,
>   productId: number,
>   quantity: number,
>   salesorderId?: number,
>   total?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOrderHeader

`ordersEntity.deleteOrderHeader`

Delete Order Header (DELETE /salesorders/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.deleteOrderHeader({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### deleteOrderLine

`ordersEntity.deleteOrderLine`

Delete Order Line (DELETE /salesordersLines/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.deleteOrderLine({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOrderHeader

`ordersEntity.getOrderHeader`

Get Order Header (GET /salesorders/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.getOrderHeader({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountAddressId` | `JsonValue` | No | — |
| `accountId` | `object` | No | — |
| `archived` | `boolean` | No | — |
| `branchId` | `object` | No | — |
| `closedDate` | `JsonValue` | No | — |
| `comment` | `string` | No | — |
| `contactId` | `JsonValue` | No | — |
| `currencyId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `discount1` | `number` | No | — |
| `discount2` | `number` | No | — |
| `discount3` | `number` | No | — |
| `discount4` | `number` | No | — |
| `extId` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `internalComment` | `string` | No | — |
| `internalCommentUpdateDate` | `JsonValue` | No | — |
| `internalCommentUpdateSalesRepId` | `JsonValue` | No | — |
| `mainSalesorder` | `JsonValue` | No | — |
| `number` | `number` | No | — |
| `opportunityId` | `JsonValue` | No | — |
| `rateId` | `JsonValue` | No | — |
| `readOnly` | `boolean` | No | — |
| `reference` | `string` | No | — |
| `salesForcecastDate` | `string` | No | — |
| `salesRepId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `statusId` | `object` | No | — |
| `total` | `number` | No | — |
| `year` | `number` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] branchId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] currencyId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesRepId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] statusId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### getOrderLine

`ordersEntity.getOrderLine`

Get Order Line (GET /salesordersLines/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.getOrderLine({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `string` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `description` | `string` | No | — |
| `discount1` | `number` | No | — |
| `discount2` | `number` | No | — |
| `discount3` | `number` | No | — |
| `discount4` | `number` | No | — |
| `id` | `number` | No | — |
| `price` | `number` | No | — |
| `productId` | `object` | No | — |
| `quantity` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `salesorderId` | `object` | No | — |
| `total` | `number` | No | — |

> [accordion] productId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] salesorderId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listOrderHeaders

`ordersEntity.listOrderHeaders`

List Order Headers (GET /salesorders)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.listOrderHeaders({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountAddressId?: JsonValue,
>   accountId?: JsonValue,
>   archived?: JsonValue,
>   blocked?: boolean,
>   branchId?: {
>     id?: number,
>     value?: string
>   },
>   closedDate?: JsonValue,
>   comment?: string,
>   contactId?: JsonValue,
>   currencyId?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   discount1?: number,
>   discount2?: number,
>   discount3?: number,
>   discount4?: number,
>   extId?: JsonValue,
>   id?: number,
>   internalComment?: string,
>   internalCommentUpdateDate?: JsonValue,
>   internalCommentUpdateSalesRepId?: JsonValue,
>   mainSalesorder?: JsonValue,
>   number?: number,
>   opportunityId?: number,
>   rateId?: number,
>   readOnly?: boolean,
>   reference?: string,
>   salesForcecastDate?: JsonValue,
>   salesRepId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   statusId?: JsonValue,
>   salesOrderType?: {
>     id?: number,
>     value?: string
>   },
>   total?: number,
>   year?: number
> }[]
> ```

***

### listOrderLines

`ordersEntity.listOrderLines`

List Order Lines (GET /salesordersLines)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.listOrderLines({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   description?: string,
>   discount1?: number,
>   discount2?: number,
>   discount3?: number,
>   discount4?: number,
>   id?: number,
>   price?: number,
>   productId?: {
>     id?: number,
>     value?: string
>   },
>   quantity?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   salesorderId?: {
>     id?: number,
>     value?: string
>   },
>   total?: number
> }[]
> ```

***

### orderHeadersSchema

`ordersEntity.orderHeadersSchema`

Order Headers schema (GET /salesorders/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.orderHeadersSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountAddressId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   archived?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   blocked?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   closedDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   comment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   contactId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   currencyId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount1?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount2?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount3?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount4?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   internalComment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   internalCommentUpdateDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   internalCommentUpdateSalesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   mainSalesorder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   number?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   opportunityId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   rateId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reference?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesForcecastDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   statusId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   total?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   year?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### orderLinesSchema

`ordersEntity.orderLinesSchema`

Order Lines schema (GET /salesordersLines/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.orderLinesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount1?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount2?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount3?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount4?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   price?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   productId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   quantity?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesorderId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   total?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOrderHeader

`ordersEntity.updateOrderHeader`

Update Order Header (PUT /salesorders/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.updateOrderHeader({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment?: string,
>   discount1?: number,
>   discount2?: number,
>   total?: number,
>   year?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### updateOrderLine

`ordersEntity.updateOrderLine`

Update Order Line (PUT /salesordersLines/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersEntity.updateOrderLine({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   discount1?: number,
>   price?: number,
>   quantity?: number,
>   total?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Orders Statuses

### createOrderStatus

`ordersStatuses.createOrderStatus`

Create Order Status (POST /salesorderStatuses)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.createOrderStatus({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   order?: number,
>   won?: boolean,
>   lost?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOrderStatus

`ordersStatuses.deleteOrderStatus`

Delete Order Status (DELETE /salesorderStatuses/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.deleteOrderStatus({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOrderStatus

`ordersStatuses.getOrderStatus`

Get Order Status (GET /salesorderStatuses/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.getOrderStatus({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue[]` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `lost` | `JsonValue` | No | — |
| `order` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `won` | `boolean` | No | — |

***

### listOrderStatuses

`ordersStatuses.listOrderStatuses`

List Order Statuses (GET /salesorderStatuses)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.listOrderStatuses({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue[],
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: JsonValue,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   lost?: JsonValue,
>   order?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   won?: boolean
> }[]
> ```

***

### orderStatusesSchema

`ordersStatuses.orderStatusesSchema`

Order Statuses schema (GET /salesorderStatuses/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.orderStatusesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lost?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   won?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOrderStatus

`ordersStatuses.updateOrderStatus`

Update Order Status (PUT /salesorderStatuses/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersStatuses.updateOrderStatus({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   lost?: boolean,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Orders Types

### createOrderTypes

`ordersTypes.createOrderTypes`

Create Order Types (POST /orderTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.createOrderTypes({
	body: { descriptionEN: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN: string,
>   order?: number,
>   won?: boolean,
>   lost?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteOrderTypes

`ordersTypes.deleteOrderTypes`

Delete Order Types (DELETE /orderTypes/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.deleteOrderTypes({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getOrderTypes

`ordersTypes.getOrderTypes`

Get Order Types (GET /orderTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.getOrderTypes({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue[]` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `lost` | `JsonValue` | No | — |
| `order` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `won` | `boolean` | No | — |

***

### listOrderTypes

`ordersTypes.listOrderTypes`

List Order Types (GET /orderTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.listOrderTypes({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue[],
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: JsonValue,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   lost?: JsonValue,
>   order?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   won?: boolean
> }[]
> ```

***

### orderTypesSchema

`ordersTypes.orderTypesSchema`

Order Types schema (GET /orderTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.orderTypesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lost?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   won?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateOrderTypes

`ordersTypes.updateOrderTypes`

Update Order Types (PUT /orderTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.ordersTypes.updateOrderTypes({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   lost?: boolean,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Product Environments

### createProductEnvironment

`productEnvironments.createProductEnvironment`

Create Product Environment (POST /productEnvironments)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.createProductEnvironment({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productId?: number,
>   branchId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProductEnvironment

`productEnvironments.deleteProductEnvironment`

Delete Product Environment (DELETE /productEnvironments/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.deleteProductEnvironment({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProductEnvironment

`productEnvironments.getProductEnvironment`

Get Product Environment (GET /productEnvironments/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.getProductEnvironment({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchId` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `id` | `number` | No | — |
| `productId` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

***

### listProductEnvironments

`productEnvironments.listProductEnvironments`

List Product Environments (GET /productEnvironments)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.listProductEnvironments({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchId?: number,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   id?: number,
>   productId?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### productEnvironmentsSchema

`productEnvironments.productEnvironmentsSchema`

Product Environments schema (GET /productEnvironments/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.productEnvironmentsSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   productId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductEnvironment

`productEnvironments.updateProductEnvironment`

Update Product Environment (PUT /productEnvironments/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productEnvironments.updateProductEnvironment({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productId?: number,
>   branchId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Product Families Branches

### createProductFamiliesBranch

`productFamiliesBranches.createProductFamiliesBranch`

Create Product Families Branch (POST /productFamiliesBranches)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.createProductFamiliesBranch({
	body: { productFamilyId: 1, branchId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productFamilyId: number,
>   branchId: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProductFamiliesBranch

`productFamiliesBranches.deleteProductFamiliesBranch`

Delete Product Families Branch (DELETE /productFamiliesBranches/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.deleteProductFamiliesBranch({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProductFamiliesBranch

`productFamiliesBranches.getProductFamiliesBranch`

Get Product Families Branch (GET /productFamiliesBranches/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.getProductFamiliesBranch({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchId` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `id` | `number` | No | — |
| `productFamilyId` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

***

### listProductFamiliesBranches

`productFamiliesBranches.listProductFamiliesBranches`

List Product Families Branches (GET /productFamiliesBranches)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.listProductFamiliesBranches({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchId?: number,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   id?: number,
>   productFamilyId?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### productFamiliesBranchesSchema

`productFamiliesBranches.productFamiliesBranchesSchema`

Product Families Branches schema (GET /productFamiliesBranches/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.productFamiliesBranchesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   productFamilyId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductFamiliesBranch

`productFamiliesBranches.updateProductFamiliesBranch`

Update Product Families Branch (PUT /productFamiliesBranches/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productFamiliesBranches.updateProductFamiliesBranch({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productFamilyId?: number,
>   branchId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Products Carousel

### deletePicture

`productsCarousel.deletePicture`

Delete Picture (DELETE /documents/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productsCarousel.deletePicture({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Products Categories

### createProductCategory

`productsCategories.createProductCategory`

Create Product Category (POST /productCategories)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.createProductCategory({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   cLevel2?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProductCategory

`productsCategories.deleteProductCategory`

Delete Product Category (DELETE /productCategories/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.deleteProductCategory({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProductCategory

`productsCategories.getProductCategory`

Get Product Category (GET /productCategories/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.getProductCategory({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `cLevel2` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `JsonValue` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `JsonValue` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

***

### listProductCategories

`productsCategories.listProductCategories`

List Product Categories (GET /productCategories)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.listProductCategories({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   cLevel2?: number,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: JsonValue,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: JsonValue,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: number,
>   salesRepIdUpdated?: number
> }[]
> ```

***

### productCategoriesSchema

`productsCategories.productCategoriesSchema`

Product Categories schema (GET /productCategories/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.productCategoriesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   cLevel2?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductCategory

`productsCategories.updateProductCategory`

Update Product Category (PUT /productCategories/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsCategories.updateProductCategory({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cLevel2?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Products Entity

### bulkCreateProducts

`productsEntity.bulkCreateProducts`

Bulk Create Products (POST /products/bulk)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.bulkCreateProducts({
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `Record<string, JsonValue>[]` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

### bulkDeleteProducts

`productsEntity.bulkDeleteProducts`

Bulk Delete Products (DELETE /products/bulk)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.bulkDeleteProducts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

### bulkUpdateProducts

`productsEntity.bulkUpdateProducts`

Bulk Update Products (PUT /products/bulk)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.bulkUpdateProducts({
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `Record<string, JsonValue>[]` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   message?: string,
>   guid?: string,
>   code?: number
> }[]
> ```

***

### createProduct

`productsEntity.createProduct`

Create Product (POST /products)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.createProduct({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   categoryId?: number,
>   cost?: number,
>   description?: string,
>   familyId?: number,
>   maxDiscount?: number,
>   permissionLevel?: number,
>   price?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProduct

`productsEntity.deleteProduct`

Delete Product (DELETE /products/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.deleteProduct({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProduct

`productsEntity.getProduct`

Get Product (GET /products/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.getProduct({
	path: { id: 1 },
	headers: { extraFieldDescription: '0' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Z_SKU` | `string` | No | — |
| `categoryId` | `JsonValue` | No | — |
| `cost` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `description` | `string` | No | — |
| `extId` | `JsonValue` | No | — |
| `familyId` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `maxDiscount` | `number` | No | — |
| `model` | `string` | No | — |
| `notAvailable` | `boolean` | No | — |
| `permissionLevel` | `number` | No | — |
| `price` | `number` | No | — |
| `readOnly` | `boolean` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `stock` | `JsonValue` | No | — |

***

### listProducts

`productsEntity.listProducts`

List Products (GET /products)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.listProducts({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   Z_SKU?: string,
>   categoryId?: JsonValue,
>   cost?: number,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   description?: string,
>   extId?: JsonValue,
>   familyId?: JsonValue,
>   id?: number,
>   maxDiscount?: JsonValue,
>   model?: string,
>   notAvailable?: boolean,
>   permissionLevel?: number,
>   price?: number,
>   readOnly?: boolean,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   stock?: JsonValue
> }[]
> ```

***

### productsSchema

`productsEntity.productsSchema`

Products schema (GET /products/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.productsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   categoryId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   cost?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   familyId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   maxDiscount?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   model?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   notAvailable?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   permissionLevel?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   price?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   readOnly?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   stock?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProduct

`productsEntity.updateProduct`

Update Product (PUT /products/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsEntity.updateProduct({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cost?: number,
>   description?: string,
>   maxDiscount?: number,
>   price?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Products Families

### createProductFamily

`productsFamilies.createProductFamily`

Create Product Family (POST /productFamilies)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsFamilies.createProductFamily({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   branchRestriction?: boolean,
>   notAvailable?: boolean,
>   idParent?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### getProductFamily

`productsFamilies.getProductFamily`

Get Product Family (GET /productFamilies/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsFamilies.getProductFamily({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchRestriction` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `string` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `string` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `string` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionRU` | `string` | No | — |
| `descriptionUS` | `string` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `notAvailable` | `boolean` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

***

### listProductFamilies

`productsFamilies.listProductFamilies`

List Product Families (GET /productFamilies)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsFamilies.listProductFamilies({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchRestriction?: boolean,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: string,
>   descriptionDE?: string,
>   descriptionDK?: string,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: string,
>   descriptionRU?: string,
>   descriptionUS?: string,
>   id?: number,
>   idParent?: number,
>   notAvailable?: boolean,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### productFamiliesSchema

`productsFamilies.productFamiliesSchema`

Product Families schema (GET /productFamilies/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsFamilies.productFamiliesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchRestriction?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   notAvailable?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductFamily

`productsFamilies.updateProductFamily`

Update Product Family (PUT /productFamilies/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsFamilies.updateProductFamily({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   branchRestriction?: boolean,
>   descriptionEN?: string,
>   idParent?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Products Rates

### createProductRate

`productsRates.createProductRate`

Create Product Rate (POST /productRates)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsRates.createProductRate({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   costPrice?: number,
>   discount1?: number,
>   discount2?: number,
>   discount3?: number,
>   discount4?: number,
>   productId?: number,
>   rateId?: number,
>   salePrice?: number,
>   tempBuyingPrice?: number,
>   tempListedPrice?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProductRate

`productsRates.deleteProductRate`

Delete Product Rate (DELETE /productRates/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productsRates.deleteProductRate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProductRate

`productsRates.getProductRate`

Get Product Rate (GET /productRates/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsRates.getProductRate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `costPrice` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `discount1` | `number` | No | — |
| `discount2` | `number` | No | — |
| `discount3` | `number` | No | — |
| `discount4` | `number` | No | — |
| `productId` | `object` | No | — |
| `rateId` | `object` | No | — |
| `salePrice` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `tempBuyingPrice` | `number` | No | — |
| `tempListedPrice` | `number` | No | — |

> [accordion] productId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] rateId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listProductRates

`productsRates.listProductRates`

List Product Rates (GET /productRates)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsRates.listProductRates({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `JsonValue`

***

### productRatesSchema

`productsRates.productRatesSchema`

Product Rates schema (GET /productRates/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productsRates.productRatesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   costPrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount1?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount2?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount3?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   discount4?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   productId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   rateId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salePrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   tempBuyingPrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   tempListedPrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductRate

`productsRates.updateProductRate`

Update Product Rate (PUT /productRates/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productsRates.updateProductRate({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   costPrice?: number,
>   salePrice?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Product Units Of Measure

### createProductUnitOfMeasure

`productUnitsOfMeasure.createProductUnitOfMeasure`

Create Product Unit Of Measure (POST /productUnitsOfMeasure)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.createProductUnitOfMeasure({
	body: { idProducto: 1, idUnitOfMeasure: 1, factor: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   idProducto: number,
>   idUnitOfMeasure: number,
>   factor: number,
>   extId?: string,
>   idParent?: number,
>   integrationField?: string,
>   isActive?: boolean,
>   isBase?: boolean,
>   minStep?: number,
>   name?: string,
>   order?: number,
>   specialPrice?: number,
>   strIdEnvironment?: string,
>   useSpecialPrice?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteProductUnitOfMeasure

`productUnitsOfMeasure.deleteProductUnitOfMeasure`

Delete Product Unit Of Measure (DELETE /productUnitsOfMeasure/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.deleteProductUnitOfMeasure({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getProductUnitOfMeasure

`productUnitsOfMeasure.getProductUnitOfMeasure`

Get Product Unit Of Measure (GET /productUnitsOfMeasure/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.getProductUnitOfMeasure({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `extId` | `string` | No | — |
| `factor` | `number` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `idProducto` | `number` | No | — |
| `idUnitOfMeasure` | `number` | No | — |
| `integrationField` | `JsonValue` | No | — |
| `isActive` | `boolean` | No | — |
| `isBase` | `boolean` | No | — |
| `minStep` | `number` | No | — |
| `name` | `string` | No | — |
| `order` | `number` | No | — |
| `specialPrice` | `number` | No | — |
| `strIdEnvironment` | `JsonValue` | No | — |
| `useSpecialPrice` | `boolean` | No | — |

***

### listProductUnitsOfMeasure

`productUnitsOfMeasure.listProductUnitsOfMeasure`

List Product Units Of Measure (GET /productUnitsOfMeasure)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.listProductUnitsOfMeasure({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   extId?: JsonValue,
>   factor?: number,
>   id?: number,
>   idParent?: JsonValue,
>   idProducto?: number,
>   idUnitOfMeasure?: number,
>   integrationField?: JsonValue,
>   isActive?: boolean,
>   isBase?: boolean,
>   minStep?: number,
>   name?: string,
>   order?: number,
>   specialPrice?: JsonValue,
>   strIdEnvironment?: JsonValue,
>   useSpecialPrice?: boolean
> }[]
> ```

***

### productUnitsOfMeasureSchema

`productUnitsOfMeasure.productUnitsOfMeasureSchema`

Product Units Of Measure schema (GET /productUnitsOfMeasure/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.productUnitsOfMeasureSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   factor?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   idProducto?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   idUnitOfMeasure?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   integrationField?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isActive?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isBase?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   minStep?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   name?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   specialPrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   strIdEnvironment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   useSpecialPrice?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateProductUnitOfMeasure

`productUnitsOfMeasure.updateProductUnitOfMeasure`

Update Product Unit Of Measure (PUT /productUnitsOfMeasure/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.productUnitsOfMeasure.updateProductUnitOfMeasure({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   isActive?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Rates

### createRate

`rates.createRate`

Create Rate (POST /rates)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.rates.createRate({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   branchId?: number,
>   comments?: string,
>   currencyId?: number,
>   startDate?: string,
>   endDate?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteRate

`rates.deleteRate`

Delete Rate (DELETE /rates/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.rates.deleteRate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getRate

`rates.getRate`

Get Rate (GET /rates/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.rates.getRate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Comments` | `string` | No | — |
| `branchId` | `object` | No | — |
| `branchVisibility` | `object[]` | No | — |
| `currencyId` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `string` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `string` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionRU` | `string` | No | — |
| `descriptionUS` | `string` | No | — |
| `endDate` | `JsonValue` | No | — |
| `extID` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `startDate` | `string` | No | — |

> [accordion] branchId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] branchVisibility full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }[]
> ```

***

### listRates

`rates.listRates`

List Rates (GET /rates)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.rates.listRates({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   Comments?: string,
>   branchId?: {
>     id?: number,
>     value?: string
>   },
>   branchVisibility?: {
>     id?: number,
>     value?: string
>   }[],
>   currencyId?: number,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: string,
>   descriptionDE?: string,
>   descriptionDK?: string,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: string,
>   descriptionRU?: string,
>   descriptionUS?: string,
>   endDate?: JsonValue,
>   extID?: JsonValue,
>   id?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number,
>   startDate?: string
> }[]
> ```

***

### ratesSchema

`rates.ratesSchema`

Rates schema (GET /rates/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.rates.ratesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   Comments?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branchId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   currencyId?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   endDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extID?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   startDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateRate

`rates.updateRate`

Update Rate (PUT /rates/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.rates.updateRate({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   branchId?: number,
>   branchVisibility?: Record<string, JsonValue>[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Related Accounts Entity

### createRelatedAccount

`relatedAccountsEntity.createRelatedAccount`

Create Related Account (POST /accountsRelated)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.createRelatedAccount({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountOneId?: number,
>   accountTwoId?: number,
>   relationId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteRelatedAccount

`relatedAccountsEntity.deleteRelatedAccount`

Delete Related Account (DELETE /accountsRelated/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.deleteRelatedAccount({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### listRelatedAccounts

`relatedAccountsEntity.listRelatedAccounts`

List Related Accounts (GET /accountsRelated)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.listRelatedAccounts({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountOneId?: {
>     id?: number,
>     value?: string
>   },
>   accountTwoId?: {
>     id?: number,
>     value?: string
>   },
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   id?: number,
>   relationId?: {
>     id?: number,
>     value?: string
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### relatedAccountsSchema

`relatedAccountsEntity.relatedAccountsSchema`

Related Accounts schema (GET /accountsRelated/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.relatedAccountsSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountOneId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   accountTwoId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   relationId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### retrieveRelatedAccount

`relatedAccountsEntity.retrieveRelatedAccount`

Retrieve Related Account (GET /accountsRelated/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.retrieveRelatedAccount({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountOneId` | `object` | No | — |
| `accountTwoId` | `object` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `id` | `number` | No | — |
| `relationId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

> [accordion] accountOneId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] accountTwoId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

> [accordion] relationId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### updateRelatedAccount

`relatedAccountsEntity.updateRelatedAccount`

Update Related Account (PUT /accountsRelated/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsEntity.updateRelatedAccount({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountOneId?: number,
>   accountTwoId?: number,
>   relationId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Related Accounts Types

### createRelatedAccountType

`relatedAccountsTypes.createRelatedAccountType`

Create Related Account Type (POST /accountsRelations)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.createRelatedAccountType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string,
>   reverseDescriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteRelatedAccountType

`relatedAccountsTypes.deleteRelatedAccountType`

Delete Related Account Type (DELETE /accountsRelations/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.deleteRelatedAccountType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### listRelatedAccountTypes

`relatedAccountsTypes.listRelatedAccountTypes`

List Related Account Types (GET /accountsRelations)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.listRelatedAccountTypes({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: string,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   reverseDescriptionBR?: JsonValue,
>   reverseDescriptionDE?: JsonValue,
>   reverseDescriptionDK?: JsonValue,
>   reverseDescriptionEN?: JsonValue,
>   reverseDescriptionES?: JsonValue,
>   reverseDescriptionFR?: JsonValue,
>   reverseDescriptionIT?: JsonValue,
>   reverseDescriptionPT?: JsonValue,
>   reverseDescriptionRU?: JsonValue,
>   reverseDescriptionUS?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue
> }[]
> ```

***

### relatedAccountTypesSchema

`relatedAccountsTypes.relatedAccountTypesSchema`

Related Account Types schema (GET /accountsRelations/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.relatedAccountTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   reverseDescriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### retrieveRelatedAccountType

`relatedAccountsTypes.retrieveRelatedAccountType`

Retrieve Related Account Type (GET /accountsRelations/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.retrieveRelatedAccountType({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `reverseDescriptionBR` | `JsonValue` | No | — |
| `reverseDescriptionDE` | `JsonValue` | No | — |
| `reverseDescriptionDK` | `JsonValue` | No | — |
| `reverseDescriptionEN` | `JsonValue` | No | — |
| `reverseDescriptionES` | `JsonValue` | No | — |
| `reverseDescriptionFR` | `JsonValue` | No | — |
| `reverseDescriptionIT` | `JsonValue` | No | — |
| `reverseDescriptionPT` | `JsonValue` | No | — |
| `reverseDescriptionRU` | `JsonValue` | No | — |
| `reverseDescriptionUS` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |

***

### updateRelatedAccountType

`relatedAccountsTypes.updateRelatedAccountType`

Update Related Account Type (PUT /accountsRelations/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.relatedAccountsTypes.updateRelatedAccountType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Resources

### getResources

`resources.getResources`

Get Resources (GET /resources)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.resources.getResources({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   end_point?: string,
>   description?: string,
>   schema?: string,
>   operations?: {
>     create?: boolean,
>     read?: boolean,
>     update?: boolean,
>     delete?: boolean
>   }
> }[]
> ```

***

## Roles

### addRolesInUser

`roles.addRolesInUser`

Add Roles in User (PUT /users/\{ID}/roles)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.roles.addRolesInUser({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   rolesId?: Record<string, JsonValue>[]
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   extId?: JsonValue,
>   level?: number,
>   name?: string,
>   branches?: JsonValue[],
>   salesRepIdDeleted?: number,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   dateDeleted?: string,
>   deleted?: boolean
> }[]
> ```

***

### deleteRolesInUser

`roles.deleteRolesInUser`

Delete Roles in User (DELETE /users/\{ID}/roles)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.roles.deleteRolesInUser({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   extId?: JsonValue,
>   level?: number,
>   name?: string,
>   branches?: JsonValue[],
>   salesRepIdDeleted?: number,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   dateDeleted?: string,
>   deleted?: boolean
> }[]
> ```

***

### getRole

`roles.getRole`

Get Role (GET /roles/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.roles.getRole({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `extId` | `JsonValue` | No | — |
| `level` | `number` | No | — |
| `name` | `string` | No | — |
| `branches` | `JsonValue` | No | — |
| `salesRepIdDeleted` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `dateCreated` | `string` | No | — |
| `dateUpdated` | `string` | No | — |
| `dateDeleted` | `string` | No | — |
| `deleted` | `boolean` | No | — |

***

### listRoles

`roles.listRoles`

List Roles (GET /roles)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.roles.listRoles({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   extId?: JsonValue,
>   level?: number,
>   name?: string,
>   branches?: number[],
>   salesRepIdDeleted?: number,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   dateDeleted?: string,
>   deleted?: boolean
> }[]
> ```

***

### listRolesOfUser

`roles.listRolesOfUser`

List Roles of User (GET /users/\{ID}/roles)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.roles.listRolesOfUser({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   extId?: JsonValue,
>   level?: number,
>   name?: string,
>   branches?: JsonValue[],
>   salesRepIdDeleted?: number,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   dateCreated?: string,
>   dateUpdated?: string,
>   dateDeleted?: string,
>   deleted?: boolean
> }[]
> ```

***

### listUsersInRole

`roles.listUsersInRole`

List Users in Role (GET /roles/\{ID}/users)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.roles.listUsersInRole({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   extId?: string,
>   billable?: boolean,
>   lastPasswordChangeDate?: JsonValue,
>   branches?: {
>     id?: number,
>     description?: string
>   },
>   userTypeId?: {
>     id?: number,
>     description?: string
>   },
>   level?: number,
>   name?: string,
>   lastName?: string,
>   email?: string,
>   nic?: string,
>   dateCreated?: string,
>   dateUpdated?: string,
>   dateDeleted?: string,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: number,
>   salesRepIdDeleted?: number,
>   deleted?: boolean,
>   phone?: string,
>   phoneExtension?: string,
>   managerId?: {
>     id?: number,
>     name?: JsonValue
>   },
>   rateId?: {
>     id?: number,
>     name?: JsonValue
>   },
>   computeSfm?: boolean
> }[]
> ```

***

### rolesSchema

`roles.rolesSchema`

Roles schema (GET /roles/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.roles.rolesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branches?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         },
>         required?: string[],
>         type?: string
>       },
>       readOnly?: boolean,
>       table?: string,
>       type?: string[]
>     }
>   },
>   dataDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   level?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   name?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

## Sales

### createSale

`sales.createSale`

Create Sale (POST /sales)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.sales.createSale({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountExtId?: string,
>   accountId?: number,
>   date?: string,
>   extId?: string,
>   salesRepExtId?: string,
>   total?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteSale

`sales.deleteSale`

Delete Sale (DELETE /sales/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.sales.deleteSale({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getSale

`sales.getSale`

Get Sale (GET /sales/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.sales.getSale({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `accountExtId` | `string` | No | — |
| `accountId` | `object` | No | — |
| `date` | `string` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `deleted` | `number` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `salesRepExtId` | `string` | No | — |
| `salesRepId` | `JsonValue` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `total` | `number` | No | — |

> [accordion] accountId full type
>
> ```ts theme={null}
> {
>   id?: number,
>   value?: string
> }
> ```

***

### listSales

`sales.listSales`

List Sales (GET /sales)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.sales.listSales({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   accountExtId?: string,
>   accountId?: {
>     id?: number,
>     value?: string
>   },
>   date?: string,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: number,
>   extId?: string,
>   id?: number,
>   salesRepExtId?: string,
>   salesRepId?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   total?: number
> }[]
> ```

***

### salesSchema

`sales.salesSchema`

Sales schema (GET /sales/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.sales.salesSchema({
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   accountExtId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   accountId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   date?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepExtId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   total?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateSale

`sales.updateSale`

Update Sale (PUT /sales/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.sales.updateSale({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountId?: number,
>   date?: string,
>   salesRepExtId?: string,
>   total?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Tax Profiles

### getTaxProfile

`taxProfiles.getTaxProfile`

Get Tax Profile (GET /taxProfiles/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxProfiles.getTaxProfile({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Descripcion` | `string` | No | — |
| `Descripcion_BR` | `JsonValue` | No | — |
| `Descripcion_DE` | `JsonValue` | No | — |
| `Descripcion_DK` | `JsonValue` | No | — |
| `Descripcion_EN` | `string` | No | — |
| `Descripcion_FR` | `JsonValue` | No | — |
| `Descripcion_IT` | `JsonValue` | No | — |
| `Descripcion_PT` | `JsonValue` | No | — |
| `Descripcion_RU` | `JsonValue` | No | — |
| `Descripcion_US` | `JsonValue` | No | — |
| `Descripcion_frca` | `JsonValue` | No | — |
| `extID` | `string` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `integrationField` | `JsonValue` | No | — |
| `intOrder` | `number` | No | — |
| `isExempt` | `boolean` | No | — |
| `strIdEnvironment` | `JsonValue` | No | — |

***

### listTaxProfiles

`taxProfiles.listTaxProfiles`

List Tax Profiles (GET /taxProfiles)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxProfiles.listTaxProfiles({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   Descripcion?: string,
>   Descripcion_BR?: JsonValue,
>   Descripcion_DE?: JsonValue,
>   Descripcion_DK?: JsonValue,
>   Descripcion_EN?: string,
>   Descripcion_FR?: JsonValue,
>   Descripcion_IT?: JsonValue,
>   Descripcion_PT?: JsonValue,
>   Descripcion_RU?: JsonValue,
>   Descripcion_US?: JsonValue,
>   Descripcion_frca?: JsonValue,
>   extID?: JsonValue,
>   id?: number,
>   idParent?: JsonValue,
>   integrationField?: JsonValue,
>   intOrder?: number,
>   isExempt?: boolean,
>   strIdEnvironment?: JsonValue
> }[]
> ```

***

### taxProfilesSchema

`taxProfiles.taxProfilesSchema`

Tax Profiles schema (GET /taxProfiles/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxProfiles.taxProfilesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   Descripcion?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   Descripcion_BR?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_DE?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_DK?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_EN?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_FR?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_IT?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_PT?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_RU?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_US?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_frca?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extID?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   integrationField?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   intOrder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isExempt?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   strIdEnvironment?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

## Tax Rates

### createTaxRate

`taxRates.createTaxRate`

Create Tax Rate (POST /taxRates)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.taxRates.createTaxRate({
	body: { Descripcion: 'sample', percentage: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   Descripcion: string,
>   Descripcion_BR?: string,
>   Descripcion_DE?: string,
>   Descripcion_DK?: string,
>   Descripcion_EN?: string,
>   Descripcion_FR?: string,
>   Descripcion_IT?: string,
>   Descripcion_PT?: string,
>   Descripcion_RU?: string,
>   Descripcion_US?: string,
>   Descripcion_frca?: string,
>   extID?: string,
>   idParent?: number,
>   integrationField?: number,
>   intOrder?: number,
>   isActive?: boolean,
>   percentage: number,
>   strIdEnvironment?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteTaxRate

`taxRates.deleteTaxRate`

Delete Tax Rate (DELETE /taxRates/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.taxRates.deleteTaxRate({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getTaxRate

`taxRates.getTaxRate`

Get Tax Rate (GET /taxRates/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxRates.getTaxRate({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Descripcion` | `string` | No | — |
| `Descripcion_BR` | `JsonValue` | No | — |
| `Descripcion_DE` | `JsonValue` | No | — |
| `Descripcion_DK` | `JsonValue` | No | — |
| `Descripcion_EN` | `string` | No | — |
| `Descripcion_FR` | `JsonValue` | No | — |
| `Descripcion_IT` | `JsonValue` | No | — |
| `Descripcion_PT` | `JsonValue` | No | — |
| `Descripcion_RU` | `JsonValue` | No | — |
| `Descripcion_US` | `JsonValue` | No | — |
| `Descripcion_frca` | `JsonValue` | No | — |
| `extID` | `string` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `integrationField` | `JsonValue` | No | — |
| `intOrder` | `number` | No | — |
| `isActive` | `boolean` | No | — |
| `percentage` | `number` | No | — |
| `strIdEnvironment` | `JsonValue` | No | — |

***

### listTaxRates

`taxRates.listTaxRates`

List Tax Rates (GET /taxRates)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxRates.listTaxRates({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   Descripcion?: string,
>   Descripcion_BR?: JsonValue,
>   Descripcion_DE?: JsonValue,
>   Descripcion_DK?: JsonValue,
>   Descripcion_EN?: string,
>   Descripcion_FR?: JsonValue,
>   Descripcion_IT?: JsonValue,
>   Descripcion_PT?: JsonValue,
>   Descripcion_RU?: JsonValue,
>   Descripcion_US?: JsonValue,
>   Descripcion_frca?: JsonValue,
>   extID?: JsonValue,
>   id?: number,
>   idParent?: JsonValue,
>   integrationField?: JsonValue,
>   intOrder?: number,
>   isActive?: boolean,
>   percentage?: number,
>   strIdEnvironment?: JsonValue
> }[]
> ```

***

### taxRatesSchema

`taxRates.taxRatesSchema`

Tax Rates schema (GET /taxRates/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.taxRates.taxRatesSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   Descripcion?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   Descripcion_BR?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_DE?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_DK?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_EN?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_FR?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_IT?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_PT?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_RU?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_US?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   Descripcion_frca?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extID?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   integrationField?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   intOrder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   isActive?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   percentage?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   strIdEnvironment?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateTaxRate

`taxRates.updateTaxRate`

Update Tax Rate (PUT /taxRates/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.taxRates.updateTaxRate({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   Descripcion?: string,
>   Descripcion_BR?: string,
>   Descripcion_DE?: string,
>   Descripcion_DK?: string,
>   Descripcion_EN?: string,
>   Descripcion_FR?: string,
>   Descripcion_IT?: string,
>   Descripcion_PT?: string,
>   Descripcion_RU?: string,
>   Descripcion_US?: string,
>   Descripcion_frca?: string,
>   extID?: string,
>   idParent?: number,
>   integrationField?: number,
>   intOrder?: number,
>   isActive?: boolean,
>   percentage?: number,
>   strIdEnvironment?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Time Zones

### listTimezones

`timeZones.listTimezones`

List TimeZones (GET /timezones)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.timeZones.listTimezones({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: JsonValue,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: string,
>   descriptionIT?: string,
>   descriptionPT?: string,
>   descriptionRU?: JsonValue,
>   descriptionUS?: string,
>   fullDescription?: string,
>   id?: number,
>   idIanaZone?: string,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   shortDescription?: string
> }[]
> ```

***

## Units Of Measure

### createUnitOfMeasure

`unitsOfMeasure.createUnitOfMeasure`

Create Unit Of Measure (POST /unitsOfMeasure)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.createUnitOfMeasure({
	body: { descriptionES: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES: string,
>   description_BR?: string,
>   description_DE?: string,
>   description_DK?: string,
>   description_EN?: string,
>   description_FR?: string,
>   description_IT?: string,
>   description_PT?: string,
>   description_RU?: string,
>   description_US?: string,
>   description_frca?: string,
>   extId?: string,
>   idParent?: number,
>   integrationField?: string,
>   order?: number,
>   status?: number,
>   strIdEnvironment?: string,
>   symbol?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteUnitOfMeasure

`unitsOfMeasure.deleteUnitOfMeasure`

Delete Unit Of Measure (DELETE /unitsOfMeasure/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.deleteUnitOfMeasure({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getUnitOfMeasure

`unitsOfMeasure.getUnitOfMeasure`

Get Unit Of Measure (GET /unitsOfMeasure/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.getUnitOfMeasure({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `descriptionES` | `string` | No | — |
| `description_BR` | `JsonValue` | No | — |
| `description_DE` | `JsonValue` | No | — |
| `description_DK` | `JsonValue` | No | — |
| `description_EN` | `string` | No | — |
| `description_FR` | `JsonValue` | No | — |
| `description_IT` | `JsonValue` | No | — |
| `description_PT` | `JsonValue` | No | — |
| `description_RU` | `JsonValue` | No | — |
| `description_US` | `JsonValue` | No | — |
| `description_frca` | `JsonValue` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `idParent` | `number` | No | — |
| `integrationField` | `JsonValue` | No | — |
| `order` | `number` | No | — |
| `status` | `number` | No | — |
| `strIdEnvironment` | `JsonValue` | No | — |
| `symbol` | `string` | No | — |

***

### listUnitsOfMeasure

`unitsOfMeasure.listUnitsOfMeasure`

List Units Of Measure (GET /unitsOfMeasure)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.listUnitsOfMeasure({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   description_BR?: JsonValue,
>   description_DE?: JsonValue,
>   description_DK?: JsonValue,
>   description_EN?: string,
>   description_FR?: JsonValue,
>   description_IT?: JsonValue,
>   description_PT?: JsonValue,
>   description_RU?: JsonValue,
>   description_US?: JsonValue,
>   description_frca?: JsonValue,
>   extId?: JsonValue,
>   id?: number,
>   idParent?: JsonValue,
>   integrationField?: JsonValue,
>   order?: number,
>   status?: number,
>   strIdEnvironment?: JsonValue,
>   symbol?: string
> }[]
> ```

***

### unitsOfMeasureSchema

`unitsOfMeasure.unitsOfMeasureSchema`

Units Of Measure schema (GET /unitsOfMeasure/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.unitsOfMeasureSchema({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string
>   },
>   description_BR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_DE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_DK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_EN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_FR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_IT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_PT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_RU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_US?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   description_frca?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   integrationField?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   order?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   status?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   strIdEnvironment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   symbol?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

### updateUnitOfMeasure

`unitsOfMeasure.updateUnitOfMeasure`

Update Unit Of Measure (PUT /unitsOfMeasure/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.unitsOfMeasure.updateUnitOfMeasure({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   symbol?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

## Users Entity

### createUser

`usersEntity.createUser`

Create User (POST /users)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.createUser({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

Creates a user who can sign in. An active user can take a paid seat; the response's billable field says whether ForceManager bills for it.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   extId?: string,
>   isActive?: boolean,
>   branches?: number,
>   userTypeId?: number,
>   level?: number,
>   name?: string,
>   lastName?: string,
>   email?: string,
>   nic?: string,
>   password?: string,
>   phone?: string,
>   phoneExtension?: string,
>   idPrefix?: number,
>   managerId?: number,
>   rateId?: number,
>   computeSfm?: boolean,
>   dbLanguage?: string,
>   uiLanguage?: string,
>   locale?: string,
>   deleted?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `billable` | `boolean` | No | — |
| `branches` | `object` | No | — |
| `computeSfm` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `dbLanguage` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `email` | `string` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `idPrefix` | `number` | No | — |
| `isActive` | `boolean` | No | — |
| `lastName` | `string` | No | — |
| `lastPasswordChangeDate` | `string` | No | — |
| `level` | `number` | No | — |
| `locale` | `string` | No | — |
| `managerId` | `object` | No | — |
| `name` | `string` | No | — |
| `nic` | `string` | No | — |
| `phone` | `string` | No | — |
| `phoneExtension` | `string` | No | — |
| `rateId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `uiLanguage` | `string` | No | — |
| `userTypeId` | `object` | No | — |

> [accordion] branches full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] managerId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] rateId full type
>
> ```ts theme={null}
> {
>   description?: JsonValue,
>   id?: number
> }
> ```

> [accordion] userTypeId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

***

### deleteUser

`usersEntity.deleteUser`

Delete User (DELETE /users/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.deleteUser({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### getUser

`usersEntity.getUser`

Get User (GET /users/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.getUser({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `billable` | `boolean` | No | — |
| `branches` | `object` | No | — |
| `computeSfm` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `JsonValue` | No | — |
| `dbLanguage` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `email` | `string` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `idPrefix` | `number` | No | — |
| `isActive` | `boolean` | No | — |
| `lastName` | `string` | No | — |
| `lastPasswordChangeDate` | `string` | No | — |
| `level` | `number` | No | — |
| `locale` | `string` | No | — |
| `managerId` | `object` | No | — |
| `name` | `string` | No | — |
| `nic` | `string` | No | — |
| `phone` | `string` | No | — |
| `phoneExtension` | `string` | No | — |
| `rateId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `JsonValue` | No | — |
| `uiLanguage` | `string` | No | — |
| `userTypeId` | `object` | No | — |

> [accordion] branches full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] managerId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] rateId full type
>
> ```ts theme={null}
> {
>   description?: JsonValue,
>   id?: number
> }
> ```

> [accordion] userTypeId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

***

### listUserHierarchy

`usersEntity.listUserHierarchy`

List User Hierarchy (GET /users/\{ID}/hierarchy)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.listUserHierarchy({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string
> }[]
> ```

***

### listUsers

`usersEntity.listUsers`

List Users (GET /users)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.listUsers({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   billable?: boolean,
>   branches?: {
>     description?: string,
>     id?: number
>   },
>   computeSfm?: boolean,
>   dateCreated?: string,
>   dateDeleted?: string,
>   dateUpdated?: JsonValue,
>   dbLanguage?: JsonValue,
>   deleted?: boolean,
>   email?: string,
>   extId?: string,
>   id?: number,
>   idPrefix?: JsonValue,
>   isActive?: boolean,
>   lastName?: string,
>   lastPasswordChangeDate?: string,
>   level?: number,
>   locale?: JsonValue,
>   managerId?: {
>     description?: string,
>     id?: number
>   },
>   name?: string,
>   nic?: string,
>   phone?: string,
>   phoneExtension?: JsonValue,
>   rateId?: {
>     description?: JsonValue,
>     id?: number
>   },
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: JsonValue,
>   uiLanguage?: JsonValue,
>   userTypeId?: {
>     description?: string,
>     id?: number
>   }
> }[]
> ```

***

### listUsersScores

`usersEntity.listUsersScores`

List Users Scores (GET /users/scores)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.listUsersScores({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   points?: number,
>   sales?: number,
>   lastUpdate?: string
> }[]
> ```

***

### updateUser

`usersEntity.updateUser`

Update User (PUT /users/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.updateUser({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

Changes extId and isActive only. isActive true lets the user sign in and can take a paid seat; the response's billable field says whether ForceManager bills for it.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   extId?: string,
>   isActive?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `billable` | `boolean` | No | — |
| `branches` | `object` | No | — |
| `computeSfm` | `boolean` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `dbLanguage` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `email` | `string` | No | — |
| `extId` | `string` | No | — |
| `id` | `number` | No | — |
| `idPrefix` | `number` | No | — |
| `isActive` | `boolean` | No | — |
| `lastName` | `string` | No | — |
| `lastPasswordChangeDate` | `string` | No | — |
| `level` | `number` | No | — |
| `locale` | `string` | No | — |
| `managerId` | `object` | No | — |
| `name` | `string` | No | — |
| `nic` | `string` | No | — |
| `phone` | `string` | No | — |
| `phoneExtension` | `string` | No | — |
| `rateId` | `object` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |
| `uiLanguage` | `string` | No | — |
| `userTypeId` | `object` | No | — |

> [accordion] branches full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] managerId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

> [accordion] rateId full type
>
> ```ts theme={null}
> {
>   description?: JsonValue,
>   id?: number
> }
> ```

> [accordion] userTypeId full type
>
> ```ts theme={null}
> {
>   description?: string,
>   id?: number
> }
> ```

***

### usersSchema

`usersEntity.usersSchema`

Users schema (GET /users/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersEntity.usersSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   billable?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branch?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   branchRestriction?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   branches?: {
>     description?: string,
>     properties?: {
>       description?: {
>         type?: string[]
>       },
>       id?: {
>         type?: string
>       },
>       readOnly?: boolean,
>       required?: string[],
>       table?: string,
>       type?: string[]
>     }
>   },
>   computeInSfm?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   computeSfm?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dataDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dbLanguage?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   email?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   idPrefix?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       readOnly?: boolean,
>       required?: string[],
>       table?: string,
>       type?: string[],
>       value?: {
>         type?: string[]
>       }
>     }
>   },
>   isActive?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lastName?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   lastPasswordChangeDate?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   level?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   locale?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   managerId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       readOnly?: boolean,
>       required?: string[],
>       table?: string,
>       type?: string[],
>       value?: {
>         type?: string[]
>       }
>     }
>   },
>   name?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   nic?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   password?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phone?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   phoneExtension?: {
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   rateId?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       name?: {
>         type?: string[]
>       },
>       readOnly?: boolean,
>       required?: string[],
>       table?: string,
>       type?: string[]
>     }
>   },
>   responsible?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     readOnly?: boolean,
>     type?: string[]
>   },
>   session?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   uiLanguage?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   userType?: {
>     description?: string,
>     properties?: {
>       id?: {
>         type?: string
>       },
>       value?: {
>         type?: string[]
>       }
>     },
>     readOnly?: boolean,
>     required?: string[],
>     table?: string,
>     type?: string[]
>   },
>   userTypeId?: {
>     description?: string,
>     properties?: {
>       description?: {
>         type?: string[]
>       },
>       id?: {
>         type?: string
>       },
>       readOnly?: boolean,
>       required?: string[],
>       table?: string,
>       type?: string[]
>     }
>   }
> }
> ```

***

## Users Types

### createUserType

`usersTypes.createUserType`

Create User Type (POST /userTypes)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.usersTypes.createUserType({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### getUserType

`usersTypes.getUserType`

Get User Type (GET /userTypes/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersTypes.getUserType({
	path: { id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `branchVisibility` | `JsonValue` | No | — |
| `dateCreated` | `string` | No | — |
| `dateDeleted` | `JsonValue` | No | — |
| `dateUpdated` | `string` | No | — |
| `deleted` | `boolean` | No | — |
| `descriptionBR` | `JsonValue` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionDK` | `JsonValue` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionES` | `string` | No | — |
| `descriptionFR` | `JsonValue` | No | — |
| `descriptionIT` | `JsonValue` | No | — |
| `descriptionPT` | `JsonValue` | No | — |
| `descriptionRU` | `JsonValue` | No | — |
| `descriptionUS` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `salesRepIdCreated` | `number` | No | — |
| `salesRepIdDeleted` | `JsonValue` | No | — |
| `salesRepIdUpdated` | `number` | No | — |

***

### listUserTypes

`usersTypes.listUserTypes`

List User Types (GET /userTypes)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersTypes.listUserTypes({
	query: { page: 0 },
	headers: { count: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: number,
>   extraFieldDescription?: 0 | 1
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   branchVisibility?: JsonValue,
>   dateCreated?: string,
>   dateDeleted?: JsonValue,
>   dateUpdated?: string,
>   deleted?: boolean,
>   descriptionBR?: JsonValue,
>   descriptionDE?: string,
>   descriptionDK?: JsonValue,
>   descriptionEN?: string,
>   descriptionES?: string,
>   descriptionFR?: JsonValue,
>   descriptionIT?: JsonValue,
>   descriptionPT?: JsonValue,
>   descriptionRU?: JsonValue,
>   descriptionUS?: JsonValue,
>   id?: number,
>   salesRepIdCreated?: number,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdUpdated?: number
> }[]
> ```

***

### updateUserType

`usersTypes.updateUserType`

Update User Type (PUT /userTypes/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.usersTypes.updateUserType({
	path: { id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionDE?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### userTypesSchema

`usersTypes.userTypesSchema`

User Types schema (GET /userTypes/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.usersTypes.userTypesSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `JsonValue[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   branchVisibility?: {
>     description?: string,
>     items?: {
>       properties?: {
>         id?: {
>           type?: string,
>           value?: {
>             type?: string[]
>           }
>         }
>       },
>       required?: string[],
>       type?: string
>     },
>     readOnly?: boolean,
>     table?: string,
>     type?: string[]
>   },
>   dateCreated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateDeleted?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   dateUpdated?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   deleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionBR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDE?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionDK?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionEN?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionES?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionFR?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionIT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionPT?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionRU?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descriptionUS?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdCreated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdDeleted?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   salesRepIdUpdated?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

## Value Lists Entity

### createList

`valueListsEntity.createList`

Create List (POST /list)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.valueListsEntity.createList({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   databaseName?: string,
>   description?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `databaseName` | `string` | No | — |
| `description` | `string` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionUS` | `string` | No | — |
| `descriptionBR` | `string` | No | — |
| `descriptionRU` | `string` | No | — |
| `descriptionDK` | `string` | No | — |

***

### deleteList

`valueListsEntity.deleteList`

Delete List (DELETE /list/VALUE)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.valueListsEntity.deleteList({
	path: { value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `code` | `number` | No | — |
| `message` | `string` | No | — |

***

### listLists

`valueListsEntity.listLists`

List Lists (GET /list)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.valueListsEntity.listLists({
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   databaseName?: string,
>   description?: string,
>   descriptionEN?: string,
>   descriptionIT?: string,
>   descriptionFR?: string,
>   descriptionDE?: string,
>   descriptionPT?: string,
>   descriptionUS?: string,
>   descriptionBR?: string,
>   descriptionRU?: string,
>   descriptionDK?: string
> }[]
> ```

***

### updateList

`valueListsEntity.updateList`

Update List (PUT /list/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.valueListsEntity.updateList({
	path: { value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionEN?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `databaseName` | `string` | No | — |
| `description` | `string` | No | — |
| `descriptionEN` | `string` | No | — |
| `descriptionIT` | `string` | No | — |
| `descriptionFR` | `string` | No | — |
| `descriptionDE` | `string` | No | — |
| `descriptionPT` | `string` | No | — |
| `descriptionUS` | `string` | No | — |
| `descriptionBR` | `string` | No | — |
| `descriptionRU` | `string` | No | — |
| `descriptionDK` | `string` | No | — |

***

## Value Lists Values

### createValue

`valueListsValues.createValue`

Create Value (POST /list/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.createValue({
	path: { value: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteValue

`valueListsValues.deleteValue`

Delete Value (DELETE /list/VALUE/\{ID})

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.deleteValue({
	path: { value: 'sample', id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### getValue

`valueListsValues.getValue`

Get Value (GET /list/VALUE/\{ID})

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.getValue({
	path: { value: 'sample', id: 1 },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `UserBorrado` | `JsonValue` | No | — |
| `UserCreado` | `number` | No | — |
| `UserModificado` | `JsonValue` | No | — |
| `borrado` | `boolean` | No | — |
| `descripcion` | `string` | No | — |
| `descripcion_br` | `JsonValue` | No | — |
| `descripcion_de` | `JsonValue` | No | — |
| `descripcion_dk` | `JsonValue` | No | — |
| `descripcion_en` | `JsonValue` | No | — |
| `descripcion_fr` | `JsonValue` | No | — |
| `descripcion_it` | `JsonValue` | No | — |
| `descripcion_pt` | `JsonValue` | No | — |
| `descripcion_ru` | `JsonValue` | No | — |
| `descripcion_us` | `JsonValue` | No | — |
| `extId` | `JsonValue` | No | — |
| `fCreado` | `string` | No | — |
| `fModificado` | `JsonValue` | No | — |
| `fborrado` | `JsonValue` | No | — |
| `id` | `number` | No | — |
| `idParent` | `JsonValue` | No | — |
| `intOrder` | `JsonValue` | No | — |
| `strIdEnvironment` | `JsonValue` | No | — |

***

### listValues

`valueListsValues.listValues`

List Values (GET /list/VALUE)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.listValues({
	path: { value: 'sample' },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   UserBorrado?: JsonValue,
>   UserCreado?: number,
>   UserModificado?: JsonValue,
>   borrado?: boolean,
>   descripcion?: string,
>   descripcion_br?: string,
>   descripcion_de?: string,
>   descripcion_dk?: string,
>   descripcion_en?: string,
>   descripcion_fr?: string,
>   descripcion_it?: string,
>   descripcion_pt?: string,
>   descripcion_ru?: string,
>   descripcion_us?: string,
>   extId?: string,
>   fCreado?: string,
>   fModificado?: JsonValue,
>   fborrado?: JsonValue,
>   id?: number,
>   idParent?: number,
>   intOrder?: number,
>   strIdEnvironment?: string
> }[]
> ```

***

### updateValue

`valueListsValues.updateValue`

Update Value (PUT /list/VALUE/\{ID})

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.updateValue({
	path: { value: 'sample', id: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   id: number | string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   descriptionES?: string,
>   order?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Message` | `string` | No | — |

***

### valuesListSchema

`valueListsValues.valuesListSchema`

Values List schema (GET /list/VALUE/schema)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.valueListsValues.valuesListSchema({
	path: { value: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `properties` | `object` | No | — |
| `required` | `string[]` | No | — |
| `title` | `string` | No | — |
| `type` | `string` | No | — |

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   UserBorrado?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   UserCreado?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   UserModificado?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   borrado?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_br?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_de?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_dk?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_en?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_fr?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_it?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_pt?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_ru?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   descripcion_us?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   extId?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fCreado?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fModificado?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   fborrado?: {
>     description?: string,
>     format?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   id?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   idParent?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   intOrder?: {
>     description?: string,
>     readOnly?: boolean,
>     type?: string[]
>   },
>   strIdEnvironment?: {
>     description?: string,
>     maxLength?: number,
>     readOnly?: boolean,
>     type?: string[]
>   }
> }
> ```

***

## Warnings

### createWarningForAResourceCopy

`warnings.createWarningForAResourceCopy`

Create Warning for a Resource Copy (POST /VALUE/VALUE/warnings)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.warnings.createWarningForAResourceCopy({
	path: { value: 'sample', value2: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text?: string,
>   enabled?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### deleteWarningOfAResource

`warnings.deleteWarningOfAResource`

Delete Warning of a Resource (DELETE /VALUE/VALUE/warnings/VALUE)

**Risk:** `destructive`

```ts theme={null}
await corsair.forcemanager.api.warnings.deleteWarningOfAResource({
	path: { value: 'sample', value2: 'sample', value3: 'sample' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

Review the target identifier and business impact before deleting this ForceManager record.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string,
>   value3: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***

### listWarningsOfAResource

`warnings.listWarningsOfAResource`

List Warnings of a Resource (GET /VALUE/VALUE/warnings)

**Risk:** `read`

```ts theme={null}
await corsair.forcemanager.api.warnings.listWarningsOfAResource({
	path: { value: 'sample', value2: 'sample' },
	query: { page: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   where?: string,
>   order?: string,
>   lang?: string,
>   filters?: Record<string, string | number | boolean>
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: number,
>   text?: string,
>   dateCreated?: string,
>   dateUpdated?: JsonValue,
>   dateDeleted?: JsonValue,
>   salesRepIdDeleted?: JsonValue,
>   salesRepIdCreated?: number,
>   salesRepIdUpdated?: JsonValue,
>   deleted?: boolean,
>   enabled?: boolean
> }[]
> ```

***

### updateWarningOfAResource

`warnings.updateWarningOfAResource`

Update Warning of a Resource (PUT /VALUE/VALUE/warnings/VALUE)

**Risk:** `write`

```ts theme={null}
await corsair.forcemanager.api.warnings.updateWarningOfAResource({
	path: { value: 'sample', value2: 'sample', value3: 'sample' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `headers` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   value: string,
>   value2: string,
>   value3: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: never,
>   where?: never,
>   order?: never,
>   lang?: never,
>   filters?: never
> }
> ```

> [accordion] headers full type
>
> ```ts theme={null}
> {
>   count?: never,
>   extraFieldDescription?: never
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text?: string,
>   enabled?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `Message` | `string` | No | — |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.