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

# sevdesk API reference

> API reference for the sevdesk plugin in Corsair: every `sevdesk.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).

## Accounting Contact

### createAccountingContact

`accountingContact.createAccountingContact`

Create a new accounting contact. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.accountingContact.createAccountingContact({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact: {
>     id: number,
>     objectName: string
>   },
>   debitorNumber?: number | null,
>   creditorNumber?: number | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   debitorNumber?: string,
>   creditorNumber?: string
> }
> ```

***

### deleteAccountingContact

`accountingContact.deleteAccountingContact`

Deletes an accounting contact. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.accountingContact.deleteAccountingContact({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getAccountingContact

`accountingContact.getAccountingContact`

Retrieve accounting contact. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.accountingContact.getAccountingContact({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   contact[
>     id
>   ]?: string,
>   contact[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   debitorNumber?: string,
>   creditorNumber?: string
> }[]
> ```

***

### getAccountingContactById

`accountingContact.getAccountingContactById`

Find accounting contact by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.accountingContact.getAccountingContactById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   debitorNumber?: string,
>   creditorNumber?: string
> }[]
> ```

***

### updateAccountingContact

`accountingContact.updateAccountingContact`

Update an existing accounting contact. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.accountingContact.updateAccountingContact({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     id: number,
>     objectName: string
>   } | null,
>   debitorNumber?: number | null,
>   creditorNumber?: number | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   debitorNumber?: string,
>   creditorNumber?: string
> }
> ```

***

## Basics

### bookkeepingSystemVersion

`basics.bookkeepingSystemVersion`

Retrieve bookkeeping system version. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.basics.bookkeepingSystemVersion({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

Check before constructing accounting documents. Sevdesk Update 2.0 replaces taxType/taxSet with taxRule; custom taxType/taxSet is not supported on Update 2.0 accounts.

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   version?: 1.0 | 2.0
> }
> ```

***

## Check Account

### createClearingAccount

`checkAccount.createClearingAccount`

Create a new clearing account. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.createClearingAccount({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   type?: online | offline,
>   currency?: string,
>   defaultAccount?: 0 | 1,
>   status?: 0 | 100,
>   accountingNumber?: string
> }
> ```

***

### createFileImportAccount

`checkAccount.createFileImportAccount`

Create a new file import account. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.createFileImportAccount({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   importType?: CSV | MT940,
>   accountingNumber?: number | null,
>   iban?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   iban?: string | null,
>   type?: online | offline,
>   importType?: CSV | MT940,
>   currency?: string,
>   defaultAccount?: 0 | 1,
>   status?: 0 | 100,
>   autoMapTransactions?: 0 | 1,
>   accountingNumber?: string
> }
> ```

***

### deleteCheckAccount

`checkAccount.deleteCheckAccount`

Deletes a check account. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.deleteCheckAccount({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getBalanceAtDate

`checkAccount.getBalanceAtDate`

Get the balance at a given date. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.getBalanceAtDate({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   date: string
> }
> ```

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

**Output**

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

***

### getCheckAccountById

`checkAccount.getCheckAccountById`

Find check account by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.getCheckAccountById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   iban?: string | null,
>   type?: online | offline | register,
>   importType?: CSV | MT940 | null,
>   currency?: string,
>   defaultAccount?: string,
>   baseAccount?: string,
>   priority?: string,
>   status?: 0 | 100,
>   balance?: string | null,
>   bankServer?: string | null,
>   autoMapTransactions?: string | null,
>   autoSyncTransactions?: string,
>   lastSync?: string,
>   accountingNumber?: string,
>   bic?: string | null
> }[]
> ```

***

### getCheckAccounts

`checkAccount.getCheckAccounts`

Retrieve check accounts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.getCheckAccounts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   iban?: string | null,
>   type?: online | offline | register,
>   importType?: CSV | MT940 | null,
>   currency?: string,
>   defaultAccount?: string,
>   baseAccount?: string,
>   priority?: string,
>   status?: 0 | 100,
>   balance?: string | null,
>   bankServer?: string | null,
>   autoMapTransactions?: string | null,
>   autoSyncTransactions?: string,
>   lastSync?: string,
>   accountingNumber?: string,
>   bic?: string | null
> }[]
> ```

***

### updateCheckAccount

`checkAccount.updateCheckAccount`

Update an existing check account. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.checkAccount.updateCheckAccount({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   defaultAccount?: 0 | 1,
>   autoMapTransactions?: number | null,
>   accountingNumber?: string,
>   iban?: string,
>   bic?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   iban?: string | null,
>   type?: online | offline | register,
>   importType?: CSV | MT940 | null,
>   currency?: string,
>   defaultAccount?: string,
>   baseAccount?: string,
>   priority?: string,
>   status?: 0 | 100,
>   balance?: string | null,
>   bankServer?: string | null,
>   autoMapTransactions?: string | null,
>   autoSyncTransactions?: string,
>   lastSync?: string,
>   accountingNumber?: string,
>   bic?: string | null
> }
> ```

***

## Check Account Transaction

### checkAccountTransactionEnshrine

`checkAccountTransaction.checkAccountTransactionEnshrine`

Enshrine. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.checkAccountTransactionEnshrine({});
```

**Input**

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

Enshrining cannot be undone for legal reasons; confirm the target transaction before execution.

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue` | No | — |

***

### createTransaction

`checkAccountTransaction.createTransaction`

Create a new transaction. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.createTransaction({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   valueDate: string,
>   entryDate?: string | null,
>   paymtPurpose?: string | null,
>   amount: number,
>   payeePayerName: string | null,
>   payeePayerAcctNo?: string | null,
>   payeePayerBankCode?: string | null,
>   checkAccount: {
>     id: number,
>     objectName: string
>   },
>   status: 100 | 200 | 300 | 400,
>   sourceTransaction?: {
>     id: number,
>     objectName: string
>   } | null,
>   targetTransaction?: {
>     id: number,
>     objectName: string
>   } | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   valueDate?: string,
>   entryDate?: string | null,
>   paymtPurpose?: string | null,
>   amount?: string,
>   payeePayerName?: string | null,
>   payeePayerAcctNo?: string | null,
>   payeePayerBankCode?: string | null,
>   gvCode?: string | null,
>   entryText?: string | null,
>   primaNotaNo?: string | null,
>   checkAccount?: {
>     id: string,
>     objectName: string
>   },
>   status?: 100 | 200 | 300 | 350 | 400,
>   sourceTransaction?: {
>     id: string,
>     objectName: string
>   },
>   targetTransaction?: {
>     id: string,
>     objectName: string
>   },
>   enshrined?: string
> }
> ```

***

### deleteCheckAccountTransaction

`checkAccountTransaction.deleteCheckAccountTransaction`

Deletes a check account transaction. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.deleteCheckAccountTransaction({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getCheckAccountTransactionById

`checkAccountTransaction.getCheckAccountTransactionById`

Find check account transaction by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.getCheckAccountTransactionById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   valueDate?: string,
>   entryDate?: string | null,
>   paymtPurpose?: string | null,
>   amount?: string,
>   payeePayerName?: string | null,
>   payeePayerAcctNo?: string | null,
>   payeePayerBankCode?: string | null,
>   gvCode?: string | null,
>   entryText?: string | null,
>   primaNotaNo?: string | null,
>   checkAccount?: {
>     id: string,
>     objectName: string
>   },
>   status?: 100 | 200 | 300 | 350 | 400,
>   sourceTransaction?: {
>     id: string,
>     objectName: string
>   },
>   targetTransaction?: {
>     id: string,
>     objectName: string
>   },
>   enshrined?: string
> }[]
> ```

***

### getTransactions

`checkAccountTransaction.getTransactions`

Retrieve transactions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.getTransactions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   checkAccount[
>     id
>   ]?: number,
>   checkAccount[
>     objectName
>   ]?: string,
>   isBooked?: boolean,
>   paymtPurpose?: string,
>   startDate?: string,
>   endDate?: string,
>   payeePayerName?: string,
>   onlyCredit?: boolean,
>   onlyDebit?: boolean,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   valueDate?: string,
>   entryDate?: string | null,
>   paymtPurpose?: string | null,
>   amount?: string,
>   payeePayerName?: string | null,
>   payeePayerAcctNo?: string | null,
>   payeePayerBankCode?: string | null,
>   gvCode?: string | null,
>   entryText?: string | null,
>   primaNotaNo?: string | null,
>   checkAccount?: {
>     id: string,
>     objectName: string
>   },
>   status?: 100 | 200 | 300 | 350 | 400,
>   sourceTransaction?: {
>     id: string,
>     objectName: string
>   },
>   targetTransaction?: {
>     id: string,
>     objectName: string
>   },
>   enshrined?: string
> }[]
> ```

***

### updateCheckAccountTransaction

`checkAccountTransaction.updateCheckAccountTransaction`

Update an existing check account transaction. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.checkAccountTransaction.updateCheckAccountTransaction({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   valueDate?: string,
>   entryDate?: string | null,
>   paymtPurpose?: string,
>   amount?: number | null,
>   payeePayerName?: string | null,
>   checkAccount?: {
>     id: number,
>     objectName: string
>   },
>   status?: 100 | 200 | 300 | 400,
>   sourceTransaction?: {
>     id: number,
>     objectName: string
>   } | null,
>   targetTransaction?: {
>     id: number,
>     objectName: string
>   } | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   valueDate?: string,
>   entryDate?: string | null,
>   paymtPurpose?: string | null,
>   amount?: string,
>   payeePayerName?: string | null,
>   payeePayerAcctNo?: string | null,
>   payeePayerBankCode?: string | null,
>   gvCode?: string | null,
>   entryText?: string | null,
>   primaNotaNo?: string | null,
>   checkAccount?: {
>     id: string,
>     objectName: string
>   },
>   status?: 100 | 200 | 300 | 350 | 400,
>   sourceTransaction?: {
>     id: string,
>     objectName: string
>   },
>   targetTransaction?: {
>     id: string,
>     objectName: string
>   },
>   enshrined?: string
> }
> ```

***

## Communication Way

### createCommunicationWay

`communicationWay.createCommunicationWay`

Create a new contact communication way. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.createCommunicationWay({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     id: number,
>     objectName: string
>   },
>   type: EMAIL | PHONE | WEB | MOBILE,
>   value: string,
>   key: {
>     id: number,
>     objectName: string
>   },
>   main?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   type?: EMAIL | PHONE | WEB | MOBILE,
>   value?: string,
>   key?: {
>     id: string,
>     objectName: string
>   },
>   main?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }
> ```

***

### deleteCommunicationWay

`communicationWay.deleteCommunicationWay`

Deletes a communication way. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.deleteCommunicationWay({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getCommunicationWayById

`communicationWay.getCommunicationWayById`

Find communication way by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.getCommunicationWayById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   type?: EMAIL | PHONE | WEB | MOBILE,
>   value?: string,
>   key?: {
>     id: string,
>     objectName: string
>   },
>   main?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }[]
> ```

***

### getCommunicationWayKeys

`communicationWay.getCommunicationWayKeys`

Retrieve communication way keys. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.getCommunicationWayKeys({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   upadate?: string,
>   name?: Arbeit | Autobox | Fax | Mobil | Newsletter | Privat | Rechnungsadresse | ,
>   translationCode?: string
> }[]
> ```

***

### getCommunicationWays

`communicationWay.getCommunicationWays`

Retrieve communication ways. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.getCommunicationWays({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   contact[
>     id
>   ]?: string,
>   contact[
>     objectName
>   ]?: string,
>   type?: PHONE | EMAIL | WEB | MOBILE,
>   main?: 0 | 1,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   type?: EMAIL | PHONE | WEB | MOBILE,
>   value?: string,
>   key?: {
>     id: string,
>     objectName: string
>   },
>   main?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }[]
> ```

***

### updateCommunicationWay

`communicationWay.updateCommunicationWay`

Update a existing communication way. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.communicationWay.updateCommunicationWay({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     id: number,
>     objectName: string
>   } | null,
>   type?: EMAIL | PHONE | WEB | MOBILE,
>   value?: string,
>   key?: {
>     id: number,
>     objectName: string
>   } | null,
>   main?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   type?: EMAIL | PHONE | WEB | MOBILE,
>   value?: string,
>   key?: {
>     id: string,
>     objectName: string
>   },
>   main?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }
> ```

***

## Contact

### contactCustomerNumberAvailabilityCheck

`contact.contactCustomerNumberAvailabilityCheck`

Check if a customer number is available. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.contactCustomerNumberAvailabilityCheck({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `boolean` | No | — |

***

### createContact

`contact.createContact`

Create a new contact. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contact.createContact({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   status?: number | null,
>   customerNumber?: string | null,
>   parent?: {
>     id: number,
>     objectName: string
>   } | null,
>   surename?: string | null,
>   familyname?: string | null,
>   titel?: string | null,
>   category: {
>     id: number,
>     objectName: string
>   },
>   description?: string | null,
>   academicTitle?: string | null,
>   gender?: string | null,
>   name2?: string | null,
>   birthday?: string | null,
>   vatNumber?: string | null,
>   bankAccount?: string | null,
>   bankNumber?: string | null,
>   defaultCashbackTime?: number | null,
>   defaultCashbackPercent?: number | null,
>   defaultTimeToPay?: number | null,
>   taxNumber?: string | null,
>   taxOffice?: string | null,
>   exemptVat?: boolean | null,
>   defaultDiscountAmount?: number | null,
>   defaultDiscountPercentage?: boolean | null,
>   buyerReference?: string | null,
>   governmentAgency?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name?: string,
>   status?: string,
>   customerNumber?: string,
>   parent?: {
>     id: string,
>     objectName: string
>   },
>   surename?: string,
>   familyname?: string,
>   titel?: string,
>   category?: {
>     id: string,
>     objectName: string
>   },
>   description?: string,
>   academicTitle?: string,
>   gender?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   birthday?: string,
>   vatNumber?: string,
>   bankAccount?: string,
>   bankNumber?: string,
>   defaultCashbackTime?: string,
>   defaultCashbackPercent?: string,
>   defaultTimeToPay?: string,
>   taxNumber?: string,
>   taxOffice?: string,
>   exemptVat?: string,
>   defaultDiscountAmount?: string,
>   defaultDiscountPercentage?: string,
>   buyerReference?: string,
>   governmentAgency?: string,
>   additionalInformation?: string
> }
> ```

***

### deleteContact

`contact.deleteContact`

Deletes a contact. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.contact.deleteContact({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### findContactsByCustomFieldValue

`contact.findContactsByCustomFieldValue`

Find contacts by custom field value. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.findContactsByCustomFieldValue({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   value: string,
>   customFieldSetting[
>     id
>   ]?: string,
>   customFieldSetting[
>     objectName
>   ]?: string,
>   customFieldName: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name?: string,
>   status?: string,
>   customerNumber?: string,
>   parent?: {
>     id: string,
>     objectName: string
>   },
>   surename?: string,
>   familyname?: string,
>   titel?: string,
>   category?: {
>     id: string,
>     objectName: string
>   },
>   description?: string,
>   academicTitle?: string,
>   gender?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   birthday?: string,
>   vatNumber?: string,
>   bankAccount?: string,
>   bankNumber?: string,
>   defaultCashbackTime?: string,
>   defaultCashbackPercent?: string,
>   defaultTimeToPay?: string,
>   taxNumber?: string,
>   taxOffice?: string,
>   exemptVat?: string,
>   defaultDiscountAmount?: string,
>   defaultDiscountPercentage?: string,
>   buyerReference?: string,
>   governmentAgency?: string,
>   additionalInformation?: string
> }[]
> ```

***

### getContactById

`contact.getContactById`

Find contact by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.getContactById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name?: string,
>   status?: string,
>   customerNumber?: string,
>   parent?: {
>     id: string,
>     objectName: string
>   },
>   surename?: string,
>   familyname?: string,
>   titel?: string,
>   category?: {
>     id: string,
>     objectName: string
>   },
>   description?: string,
>   academicTitle?: string,
>   gender?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   birthday?: string,
>   vatNumber?: string,
>   bankAccount?: string,
>   bankNumber?: string,
>   defaultCashbackTime?: string,
>   defaultCashbackPercent?: string,
>   defaultTimeToPay?: string,
>   taxNumber?: string,
>   taxOffice?: string,
>   exemptVat?: string,
>   defaultDiscountAmount?: string,
>   defaultDiscountPercentage?: string,
>   buyerReference?: string,
>   governmentAgency?: string,
>   additionalInformation?: string
> }[]
> ```

***

### getContacts

`contact.getContacts`

Retrieve contacts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.getContacts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   depth?: 0 | 1,
>   customerNumber?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name?: string,
>   status?: string,
>   customerNumber?: string,
>   parent?: {
>     id: string,
>     objectName: string
>   },
>   surename?: string,
>   familyname?: string,
>   titel?: string,
>   category?: {
>     id: string,
>     objectName: string
>   },
>   description?: string,
>   academicTitle?: string,
>   gender?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   birthday?: string,
>   vatNumber?: string,
>   bankAccount?: string,
>   bankNumber?: string,
>   defaultCashbackTime?: string,
>   defaultCashbackPercent?: string,
>   defaultTimeToPay?: string,
>   taxNumber?: string,
>   taxOffice?: string,
>   exemptVat?: string,
>   defaultDiscountAmount?: string,
>   defaultDiscountPercentage?: string,
>   buyerReference?: string,
>   governmentAgency?: string,
>   additionalInformation?: string
> }[]
> ```

***

### getContactTabsItemCountById

`contact.getContactTabsItemCountById`

Get number of all items. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.getContactTabsItemCountById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `orders` | `number` | No | — |
| `invoices` | `number` | No | — |
| `creditNotes` | `number` | No | — |
| `documents` | `number` | No | — |
| `persons` | `number` | No | — |
| `vouchers` | `number` | No | — |
| `letters` | `number` | No | — |
| `parts` | `string` | No | — |
| `invoicePos` | `number` | No | — |

***

### getNextCustomerNumber

`contact.getNextCustomerNumber`

Get next free customer number. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contact.getNextCustomerNumber({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

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

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

**Output**

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

***

### updateContact

`contact.updateContact`

Update a existing contact. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contact.updateContact({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   status?: number | null,
>   customerNumber?: string | null,
>   parent?: {
>     id: number,
>     objectName: string
>   } | null,
>   surename?: string | null,
>   familyname?: string | null,
>   titel?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   description?: string | null,
>   academicTitle?: string | null,
>   gender?: string | null,
>   name2?: string | null,
>   birthday?: string | null,
>   vatNumber?: string | null,
>   bankAccount?: string | null,
>   bankNumber?: string | null,
>   defaultCashbackTime?: number | null,
>   defaultCashbackPercent?: number | null,
>   defaultTimeToPay?: number | null,
>   taxNumber?: string | null,
>   taxOffice?: string | null,
>   exemptVat?: boolean | null,
>   defaultDiscountAmount?: number | null,
>   defaultDiscountPercentage?: boolean | null,
>   buyerReference?: string | null,
>   governmentAgency?: boolean | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name?: string,
>   status?: string,
>   customerNumber?: string,
>   parent?: {
>     id: string,
>     objectName: string
>   },
>   surename?: string,
>   familyname?: string,
>   titel?: string,
>   category?: {
>     id: string,
>     objectName: string
>   },
>   description?: string,
>   academicTitle?: string,
>   gender?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   birthday?: string,
>   vatNumber?: string,
>   bankAccount?: string,
>   bankNumber?: string,
>   defaultCashbackTime?: string,
>   defaultCashbackPercent?: string,
>   defaultTimeToPay?: string,
>   taxNumber?: string,
>   taxOffice?: string,
>   exemptVat?: string,
>   defaultDiscountAmount?: string,
>   defaultDiscountPercentage?: string,
>   buyerReference?: string,
>   governmentAgency?: string,
>   additionalInformation?: string
> }
> ```

***

## Contact Address

### contactAddressId

`contactAddress.contactAddressId`

Find contact address by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactAddress.contactAddressId({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact: {
>     id: number,
>     objectName: string
>   },
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country: {
>     id: number,
>     objectName: string
>   },
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }[]
> ```

***

### createContactAddress

`contactAddress.createContactAddress`

Create a new contact address. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactAddress.createContactAddress({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact: {
>     id: number,
>     objectName: string
>   },
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country: {
>     id: number,
>     objectName: string
>   },
>   category: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact: {
>     id: number,
>     objectName: string
>   },
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country: {
>     id: number,
>     objectName: string
>   },
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }
> ```

***

### deleteContactAddress

`contactAddress.deleteContactAddress`

Deletes a contact address. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.contactAddress.deleteContactAddress({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getContactAddresses

`contactAddress.getContactAddresses`

Retrieve contact addresses. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactAddress.getContactAddresses({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact: {
>     id: number,
>     objectName: string
>   },
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country: {
>     id: number,
>     objectName: string
>   },
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }[]
> ```

***

### updateContactAddress

`contactAddress.updateContactAddress`

update a existing contact address. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactAddress.updateContactAddress({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     id: number,
>     objectName: string
>   } | null,
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country?: {
>     id: number,
>     objectName: string
>   } | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   contact: {
>     id: number,
>     objectName: string
>   },
>   street?: string | null,
>   zip?: string | null,
>   city?: string | null,
>   country: {
>     id: number,
>     objectName: string
>   },
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   name?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   name2?: string,
>   name3?: string | null,
>   name4?: string | null
> }
> ```

***

## Contact Field

### createContactField

`contactField.createContactField`

Create contact field. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactField.createContactField({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact: {
>     id: number,
>     objectName: string
>   },
>   contactCustomFieldSetting: {
>     id: number,
>     objectName: string
>   },
>   value: string,
>   objectName: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   contactCustomFieldSetting?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     name?: string,
>     identifier?: string,
>     description?: string
>   }& JsonValue,
>   value?: string
> }
> ```

***

### createContactFieldSetting

`contactField.createContactFieldSetting`

Create contact field setting. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactField.createContactFieldSetting({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   identifier?: string,
>   description?: string
> }
> ```

***

### deleteContactCustomFieldId

`contactField.deleteContactCustomFieldId`

delete a contact field. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.contactField.deleteContactCustomFieldId({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### deleteContactFieldSetting

`contactField.deleteContactFieldSetting`

Deletes a contact field setting. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.contactField.deleteContactFieldSetting({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getContactFields

`contactField.getContactFields`

Retrieve contact fields. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getContactFields({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   contactCustomFieldSetting?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     name?: string,
>     identifier?: string,
>     description?: string
>   }& JsonValue,
>   value?: string
> }[]
> ```

***

### getContactFieldsById

`contactField.getContactFieldsById`

Retrieve contact fields. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getContactFieldsById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   contactCustomFieldSetting?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     name?: string,
>     identifier?: string,
>     description?: string
>   }& JsonValue,
>   value?: string
> }[]
> ```

***

### getContactFieldSettingById

`contactField.getContactFieldSettingById`

Find contact field setting by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getContactFieldSettingById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   identifier?: string,
>   description?: string
> }[]
> ```

***

### getContactFieldSettings

`contactField.getContactFieldSettings`

Retrieve contact field settings. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getContactFieldSettings({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   identifier?: string,
>   description?: string
> }[]
> ```

***

### getPlaceholder

`contactField.getPlaceholder`

Retrieve Placeholders. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getPlaceholder({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   objectName: Invoice | CreditNote | Order | Contact | Letter | Email,
>   subObjectName?: Invoice | CreditNote | Order | Contact | Letter,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   key?: string,
>   value?: {
>     key?: string,
>     value?: string | {
>       key?: string,
>       value?: JsonValue
>     }[]
>   }[]
> }[]
> ```

***

### getReferenceCount

`contactField.getReferenceCount`

Receive count reference. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.contactField.getReferenceCount({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `number` | No | — |

***

### updateContactfield

`contactField.updateContactfield`

Update a contact field. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactField.updateContactfield({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   contactCustomFieldSetting?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     name?: string,
>     identifier?: string,
>     description?: string
>   }& JsonValue,
>   value?: string
> }
> ```

***

### updateContactFieldSetting

`contactField.updateContactFieldSetting`

Update contact field setting. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.contactField.updateContactFieldSetting({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   name?: string,
>   identifier?: string,
>   description?: string
> }
> ```

***

## Credit Note

### bookCreditNote

`creditNote.bookCreditNote`

Book a credit note. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.bookCreditNote({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   amount: number,
>   date: number,
>   type: FULL_PAYMENT | N | CB | CF | O | OF | MTC,
>   checkAccount: {
>     id: number,
>     objectName: string
>   },
>   checkAccountTransaction?: {
>     id: number,
>     objectName: string
>   },
>   createFeed?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `objectName` | `string` | No | — |
| `additionalInformation` | `string` | No | — |
| `create` | `string` | No | — |
| `creditNote` | `object` | No | — |
| `fromStatus` | `string` | No | — |
| `toStatus` | `string` | No | — |
| `ammountPayed` | `string` | No | — |
| `bookingDate` | `string` | No | — |
| `sevClient` | `object` | No | — |

> [accordion] creditNote full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

> [accordion] sevClient full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

***

### createcreditNote

`creditNote.createcreditNote`

Create a new creditNote. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.createcreditNote({});
```

**Input**

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

For Update 2.0, use taxRule and position taxRate values allowed by ReceiptGuidance. New credit notes are created as DRAFT and need a deliveryDate; enshrining is separate and irreversible. Update 2.0 does not support ACCOUNTING\_TYPE bookingCategory or credit notes from vouchers; delivery dates must agree with the source invoice.

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   creditNote: {
>     id?: number,
>     objectName: string,
>     mapAll: boolean,
>     creditNoteNumber: string,
>     contact: {
>       id: number,
>       objectName: string
>     },
>     creditNoteDate: string,
>     deliveryDate?: string | null,
>     deliveryDateUntil?: number | null,
>     status: 100 | 200 | 300 | 500 | 750 | 1000,
>     header: string,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry: {
>       id: number,
>       objectName: string
>     } | null,
>     smallSettlement?: boolean | null,
>     contactPerson: {
>       id: number,
>       objectName: string
>     },
>     taxRule: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxRate: number,
>     taxSet?: {
>       id: number,
>       objectName: string
>     } | null,
>     taxText: string,
>     taxType: string,
>     sendDate?: string | null,
>     address?: string | null,
>     bookingCategory: PROVISION | ROYALTY_ASSIGNED | ROYALTY_UNASSIGNED | UNDERACHIEVEMENT | ACCOUNTING_TYPE,
>     currency: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   creditNotePosSave?: {
>     objectName: string,
>     mapAll: boolean,
>     creditNote?: {
>       id: number,
>       objectName: string
>     },
>     part?: {
>       id: number,
>       objectName: string
>     },
>     quantity: number,
>     price?: number | null,
>     priceTax?: number | null,
>     priceGross?: number | null,
>     name?: string | null,
>     unity: {
>       id: number,
>       objectName: string
>     },
>     positionNumber?: number | null,
>     text?: string | null,
>     discount?: number | null,
>     optional?: boolean | null,
>     taxRate: number
>   }[],
>   creditNotePosDelete?: {
>     id: number,
>     objectName: string
>   },
>   discountSave?: {
>     discount: boolean,
>     text: string,
>     percentage: boolean,
>     value: number,
>     objectName: string,
>     mapAll: boolean
>   },
>   discountDelete?: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   creditNote?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNoteNumber?: string | null,
>     contact?: {
>       id: string,
>       objectName: string
>     } | null,
>     creditNoteDate?: string,
>     status?: 100 | 200 | 750 | 1000,
>     header?: string | null,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     smallSettlement?: boolean | null,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxRate?: string | null,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string | null,
>     taxType?: string | null,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string | null,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   creditNotePos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNote: {
>       id: string,
>       objectName: string
>     },
>     part?: {
>       id: string,
>       objectName: string
>     },
>     quantity: string,
>     price?: string | null,
>     priceNet?: string | null,
>     priceTax?: string | null,
>     priceGross?: string | null,
>     name?: string | null,
>     unity: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     positionNumber?: string | null,
>     text?: string | null,
>     discount?: string | null,
>     optional?: boolean | null,
>     taxRate: string,
>     sumDiscount?: string | null
>   }[]
> }
> ```

***

### createCreditNoteFromInvoice

`creditNote.createCreditNoteFromInvoice`

Creates a new creditNote from an invoice. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.createCreditNoteFromInvoice({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   invoice: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   creditNote?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNoteNumber?: string | null,
>     contact?: {
>       id: string,
>       objectName: string
>     } | null,
>     creditNoteDate?: string,
>     status?: 100 | 200 | 750 | 1000,
>     header?: string | null,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     smallSettlement?: boolean | null,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxRate?: string | null,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string | null,
>     taxType?: string | null,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string | null,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   creditNotePos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNote: {
>       id: string,
>       objectName: string
>     },
>     part?: {
>       id: string,
>       objectName: string
>     },
>     quantity: string,
>     price?: string | null,
>     priceNet?: string | null,
>     priceTax?: string | null,
>     priceGross?: string | null,
>     name?: string | null,
>     unity: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     positionNumber?: string | null,
>     text?: string | null,
>     discount?: string | null,
>     optional?: boolean | null,
>     taxRate: string,
>     sumDiscount?: string | null
>   }[],
>   discount?: {
>     id?: number,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: string,
>     discount?: string,
>     text?: string,
>     percentage?: string,
>     value?: string,
>     isNet?: string
>   }[]
> }
> ```

***

### createCreditNoteFromVoucher

`creditNote.createCreditNoteFromVoucher`

Creates a new creditNote from a voucher. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.createCreditNoteFromVoucher({});
```

**Input**

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

This documented legacy route is unavailable on Sevdesk Update 2.0; use only with accounts still on bookkeeping system 1.0.

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   voucher: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   creditNote?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNoteNumber?: string | null,
>     contact?: {
>       id: string,
>       objectName: string
>     } | null,
>     creditNoteDate?: string,
>     status?: 100 | 200 | 750 | 1000,
>     header?: string | null,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     smallSettlement?: boolean | null,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxRate?: string | null,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string | null,
>     taxType?: string | null,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string | null,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   creditNotePos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNote: {
>       id: string,
>       objectName: string
>     },
>     part?: {
>       id: string,
>       objectName: string
>     },
>     quantity: string,
>     price?: string | null,
>     priceNet?: string | null,
>     priceTax?: string | null,
>     priceGross?: string | null,
>     name?: string | null,
>     unity: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     positionNumber?: string | null,
>     text?: string | null,
>     discount?: string | null,
>     optional?: boolean | null,
>     taxRate: string,
>     sumDiscount?: string | null
>   }[],
>   discount?: {
>     id?: number,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: string,
>     discount?: string,
>     text?: string,
>     percentage?: string,
>     value?: string,
>     isNet?: string
>   }[]
> }
> ```

***

### creditNoteEnshrine

`creditNote.creditNoteEnshrine`

Enshrine. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.creditNoteEnshrine({});
```

**Input**

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

Enshrining cannot be undone for legal reasons; confirm the target credit note before execution.

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue` | No | — |

***

### creditNoteGetPdf

`creditNote.creditNoteGetPdf`

Retrieve pdf document of a credit note. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.creditNoteGetPdf({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   preventSendBy?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `filename` | `string` | No | — |
| `mimeType` | `string` | No | — |
| `base64encoded` | `boolean` | No | — |
| `content` | `string` | No | — |

***

### creditNoteResetToDraft

`creditNote.creditNoteResetToDraft`

Reset status to draft. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.creditNoteResetToDraft({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }& {
>   taxText?: JsonValue,
>   customerInternalNote?: JsonValue
> }
> ```

***

### creditNoteResetToOpen

`creditNote.creditNoteResetToOpen`

Reset status to open. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.creditNoteResetToOpen({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }& {
>   status?: JsonValue
> }
> ```

***

### creditNoteSendBy

`creditNote.creditNoteSendBy`

Mark credit note as sent. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.creditNoteSendBy({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   sendType: VPR | VP | VM | VPDF,
>   sendDraft: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

### deletecreditNote

`creditNote.deletecreditNote`

Deletes an creditNote. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.deletecreditNote({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getcreditNoteById

`creditNote.getcreditNoteById`

Find creditNote by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.creditNote.getcreditNoteById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }[]
> ```

***

### getCreditNotes

`creditNote.getCreditNotes`

Retrieve CreditNote. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.creditNote.getCreditNotes({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   creditNoteNumber?: string,
>   startDate?: number,
>   endDate?: number,
>   contact[
>     id
>   ]?: number,
>   contact[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }[]
> ```

***

### sendCreditNoteByPrinting

`creditNote.sendCreditNoteByPrinting`

Send credit note by printing. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.sendCreditNoteByPrinting({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   sendType: string
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   pdf?: string,
>   docId?: string,
>   parameters?: {
>     key?: string,
>     name?: string,
>     values?: {
>       name?: string,
>       translationCade?: string,
>       value?: string
>     }[],
>     visible?: boolean,
>     value?: string
>   }[]
> }
> ```

***

### sendCreditNoteViaEMail

`creditNote.sendCreditNoteViaEMail`

Send credit note via email. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.creditNote.sendCreditNoteViaEMail({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   toEmail: string,
>   subject: string,
>   text: string,
>   copy?: boolean,
>   additionalAttachments?: string,
>   ccEmail?: string,
>   bccEmail?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   update?: string,
>   object?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     creditNoteNumber?: string | null,
>     contact?: {
>       id: string,
>       objectName: string
>     } | null,
>     creditNoteDate?: string,
>     status?: 100 | 200 | 750 | 1000,
>     header?: string | null,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     smallSettlement?: boolean | null,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxRate?: string | null,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string | null,
>     taxType?: string | null,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string | null,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   from?: string,
>   to?: string,
>   subject?: string,
>   text?: string,
>   sevClient?: {
>     id: number,
>     objectName: string
>   }
> }[]
> ```

***

### updatecreditNote

`creditNote.updatecreditNote`

Update an existing creditNote. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.creditNote.updatecreditNote({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: number,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: number,
>     objectName: string
>   } | null,
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: number,
>     objectName: string
>   } | null,
>   taxRate?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: number,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNoteNumber?: string | null,
>   contact?: {
>     id: string,
>     objectName: string
>   } | null,
>   creditNoteDate?: string,
>   status?: 100 | 200 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxRate?: string | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

## Credit Note Pos

### getcreditNotePositions

`creditNotePos.getcreditNotePositions`

Retrieve creditNote positions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.creditNotePos.getcreditNotePositions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   creditNote[
>     id
>   ]?: number,
>   creditNote[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   creditNote: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate: string,
>   sumDiscount?: string | null
> }[]
> ```

***

## Export

### exportContact

`export.exportContact`

Export contact. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportContact({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       zip?: number,
>       city?: string,
>       country?: {
>         id: number,
>         objectName: string
>       },
>       depth?: boolean,
>       onlyPeople?: boolean
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### exportCreditNote

`export.exportCreditNote`

Export creditNote. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportCreditNote({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       startDate?: string,
>       endDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### exportDatevCSV

`export.exportDatevCSV`

Start DATEV CSV ZIP export. With enshrineDocuments: true it enshrines the exported documents, which cannot be undone (GoBD).

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.export.exportDatevCSV({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   startDate: number,
>   endDate: number,
>   scope: string,
>   exportByPaydate?: boolean,
>   includeEnshrined?: boolean,
>   enshrineDocuments?: boolean,
>   includeDocumentImages?: boolean
> }
> ```

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

**Output**

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

***

### exportDatevDepricated

`export.exportDatevDepricated`

Export datev. With enshrine: true it enshrines the exported documents, which cannot be undone (GoBD).

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.export.exportDatevDepricated({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   Download?: boolean,
>   startDate: number,
>   endDate: number,
>   scope: string,
>   withUnpaidDocuments?: boolean,
>   withEnshrinedDocuments?: boolean,
>   enshrine?: boolean
> }
> ```

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

**Output:** `Record<string, JsonValue>`

***

### exportDatevXML

`export.exportDatevXML`

Start DATEV XML ZIP export. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportDatevXML({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   startDate: number,
>   endDate: number,
>   scope: string,
>   exportByPaydate?: boolean,
>   includeEnshrined?: boolean,
>   includeExportedDocuments?: boolean,
>   includeDocumentXml?: boolean
> }
> ```

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

**Output**

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

***

### exportInvoice

`export.exportInvoice`

Export invoice. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportInvoice({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       invoiceType?: (Re | SR | TR | AR | ER | WKR | MA)[],
>       startDate?: string,
>       endDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### exportInvoiceZip

`export.exportInvoiceZip`

Export Invoice as zip. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportInvoiceZip({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       invoiceType?: (Re | SR | TR | AR | ER | WKR | MA)[],
>       startDate?: string,
>       endDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### exportTransactions

`export.exportTransactions`

Export transaction. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportTransactions({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       paymtPurpose?: string,
>       name?: string,
>       startDate?: string,
>       endDate?: string,
>       startAmount?: number,
>       endAmount?: number,
>       checkAccount?: {
>         id: number,
>         objectName: string
>       }
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### exportVoucher

`export.exportVoucher`

Export voucher as zip. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportVoucher({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       startDate?: string,
>       endDate?: string,
>       startPayDate?: string,
>       endPayDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `filename` | `string` | No | — |
| `mimetype` | `string` | No | — |
| `base64Encoded` | `boolean` | No | — |
| `content` | `string` | No | — |

***

### exportVoucherZip

`export.exportVoucherZip`

Export voucher zip. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.exportVoucherZip({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       startDate?: string,
>       endDate?: string,
>       startPayDate?: string,
>       endPayDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### generateDownloadHash

`export.generateDownloadHash`

Generate download hash. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.export.generateDownloadHash({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   jobId: string
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   current?: number,
>   total?: number
> }[]
> ```

***

### getProgress

`export.getProgress`

Get progress. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.getProgress({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   hash: string
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   current?: number,
>   total?: number
> }[]
> ```

***

### jobDownloadInfo

`export.jobDownloadInfo`

Get job download info. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.export.jobDownloadInfo({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   jobId: string
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   link?: string,
>   linkExpireDate?: string
> }[]
> ```

***

### updateExportConfig

`export.updateExportConfig`

Update export config. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.export.updateExportConfig({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   accountantNumber: number,
>   accountantClientNumber: number,
>   accountingYearBegin: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue` | No | — |

***

## Invoice

### bookInvoice

`invoice.bookInvoice`

Book an invoice. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.bookInvoice({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   amount: number,
>   date: number,
>   type: FULL_PAYMENT | N | CB | CF | O | OF | MTC,
>   checkAccount: {
>     id: number,
>     objectName: string
>   },
>   checkAccountTransaction?: {
>     id: number,
>     objectName: string
>   },
>   createFeed?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `objectName` | `string` | No | — |
| `additionalInformation` | `string` | No | — |
| `create` | `string` | No | — |
| `creditNote` | `object` | No | — |
| `fromStatus` | `string` | No | — |
| `toStatus` | `string` | No | — |
| `ammountPayed` | `string` | No | — |
| `bookingDate` | `string` | No | — |
| `sevClient` | `object` | No | — |

> [accordion] creditNote full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

> [accordion] sevClient full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

***

### cancelInvoice

`invoice.cancelInvoice`

Cancel an invoice / Create cancellation invoice. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.cancelInvoice({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }
> ```

***

### createInvoiceByFactory

`invoice.createInvoiceByFactory`

Create a new invoice. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.invoice.createInvoiceByFactory({});
```

**Input**

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

For Update 2.0, use taxRule and position taxRate values allowed by ReceiptGuidance. The factory requires invoice.status: send "100" (draft); sending, booking and enshrining are separate actions. Advanced and partial invoices accept only taxRule 1 or 11; AR/TR/ER require the account's default currency.

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   invoice: {
>     id?: number | null,
>     objectName?: string,
>     invoiceNumber?: string | null,
>     contact: {
>       id: number,
>       objectName: string
>     },
>     contactPerson: {
>       id: number,
>       objectName: string
>     },
>     invoiceDate: string,
>     header?: string | null,
>     headText?: string | null,
>     footText?: string | null,
>     timeToPay?: number | null,
>     discount: number,
>     address?: string | null,
>     addressCountry: {
>       id: number,
>       objectName: string
>     },
>     payDate?: string | null,
>     deliveryDate?: string | null,
>     deliveryDateUntil?: number | null,
>     status: 50 | 100 | 200 | 750 | 1000,
>     smallSettlement?: boolean | null,
>     taxRate: number,
>     taxRule: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxText: string,
>     taxType: default | eu | noteu | custom,
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     paymentMethod?: {
>       id: number,
>       objectName: string
>     },
>     sendDate?: string | null,
>     invoiceType: RE | WKR | SR | MA | TR | AR | ER,
>     currency: string,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP,
>     origin?: {
>       id: string,
>       objectName: string
>     } | null,
>     customerInternalNote?: string | null,
>     propertyIsEInvoice?: boolean | null,
>     mapAll: boolean
>   },
>   invoicePosSave?: {
>     id?: number,
>     objectName: string,
>     mapAll: boolean,
>     part?: {
>       id: number,
>       objectName: string
>     },
>     quantity: number,
>     price?: number | null,
>     name?: string | null,
>     unity: {
>       id: number,
>       objectName: string
>     },
>     positionNumber?: number | null,
>     text?: string | null,
>     discount?: number | null,
>     taxRate: number,
>     priceGross?: number | null,
>     priceTax?: number | null
>   }[],
>   invoicePosDelete?: {
>     id: number,
>     objectName: string
>   },
>   filename?: string,
>   discountSave?: {
>     discount?: boolean,
>     text?: string,
>     percentage?: boolean,
>     value?: number,
>     objectName?: string,
>     mapAll?: boolean
>   }[],
>   discountDelete?: {
>     id?: number,
>     objectName?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   invoice?: {
>     id?: string,
>     objectName?: string,
>     invoiceNumber?: string,
>     contact?: {
>       id: string,
>       objectName: string
>     },
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     invoiceDate?: string,
>     header?: string,
>     headText?: string,
>     footText?: string,
>     timeToPay?: string,
>     discountTime?: string,
>     discount?: string,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     },
>     payDate?: string,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     status?: 50 | 100 | 200 | 750 | 1000,
>     smallSettlement?: boolean,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     },
>     taxRate?: string,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxText?: string,
>     dunningLevel?: string,
>     taxType?: default | eu | noteu | custom,
>     paymentMethod?: {
>       id: string,
>       objectName: string
>     },
>     costCentre?: {
>       id: string,
>       objectName: string
>     },
>     sendDate?: string,
>     origin?: {
>       id: string,
>       objectName: string
>     },
>     invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>     accountIntervall?: string,
>     accountNextInvoice?: string,
>     reminderTotal?: string,
>     reminderDebit?: string,
>     reminderDeadline?: string,
>     reminderCharge?: string,
>     taxSet?: {
>       id: string,
>       objectName: string
>     },
>     address?: string,
>     currency?: string,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     sumNetAccounting?: string,
>     sumTaxAccounting?: string,
>     sumGrossAccounting?: string,
>     paidAmount?: number,
>     customerInternalNote?: string,
>     showNet?: boolean,
>     enshrined?: string,
>     sendType?: VPR | VPDF | VM | VP,
>     deliveryDateUntil?: string,
>     datevConnectOnline?: Record<string, JsonValue>,
>     sendPaymentReceivedNotificationDate?: string
>   },
>   invoicePos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     invoice?: {
>       id: string,
>       objectName: string
>     },
>     part?: {
>       id: string,
>       objectName: string
>     },
>     quantity?: number | string,
>     price?: string,
>     name?: string,
>     unity?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     positionNumber?: string,
>     text?: string,
>     discount?: string,
>     taxRate?: string,
>     sumDiscount?: string,
>     sumNetAccounting?: string,
>     sumTaxAccounting?: string,
>     sumGrossAccounting?: string,
>     priceNet?: string,
>     priceGross?: string,
>     priceTax?: string
>   }[],
>   filename?: string
> }
> ```

***

### createInvoiceFromOrder

`invoice.createInvoiceFromOrder`

Create invoice from order. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.invoice.createInvoiceFromOrder({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   order: {
>     id: number,
>     objectName: string
>   },
>   type?: percentage | net | gross,
>   amount?: number | null,
>   partialType?: RE | TR | AR
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }
> ```

***

### createInvoiceReminder

`invoice.createInvoiceReminder`

Create invoice reminder. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.createInvoiceReminder({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   invoice[
>     id
>   ]: number,
>   invoice[
>     objectName
>   ]: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   invoice: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }
> ```

***

### getInvoiceById

`invoice.getInvoiceById`

Find invoice by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.invoice.getInvoiceById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }[]
> ```

***

### getInvoicePositionsById

`invoice.getInvoicePositionsById`

Find invoice positions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.invoice.getInvoicePositionsById({});
```

**Input**

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

The OpenAPI declares invoice-position quantity as boolean, inconsistent with the numeric request schema and sibling position models. The response schema accepts numbers or numeric strings and rejects booleans.

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   embed?: string[],
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   invoice?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: number | string,
>   price?: string,
>   name?: string,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string,
>   text?: string,
>   discount?: string,
>   taxRate?: string,
>   sumDiscount?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   priceNet?: string,
>   priceGross?: string,
>   priceTax?: string
> }[]
> ```

***

### getInvoices

`invoice.getInvoices`

Retrieve invoices. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.invoice.getInvoices({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   status?: 100 | 200 | 1000,
>   invoiceNumber?: string,
>   startDate?: number,
>   endDate?: number,
>   contact[
>     id
>   ]?: number,
>   contact[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }[]
> ```

***

### getIsInvoicePartiallyPaid

`invoice.getIsInvoicePartiallyPaid`

Check if an invoice is already partially paid. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.invoice.getIsInvoicePartiallyPaid({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `boolean` | No | — |

***

### invoiceEnshrine

`invoice.invoiceEnshrine`

Enshrine. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceEnshrine({});
```

**Input**

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

Enshrining cannot be undone for legal reasons; confirm the target invoice before execution.

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue` | No | — |

***

### invoiceGetPdf

`invoice.invoiceGetPdf`

Retrieve pdf document of an invoice. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceGetPdf({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   preventSendBy?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `filename` | `string` | No | — |
| `mimeType` | `string` | No | — |
| `base64encoded` | `boolean` | No | — |
| `content` | `string` | No | — |

***

### invoiceRender

`invoice.invoiceRender`

Render the pdf document of an invoice. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceRender({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `pdf` | `string` | No | — |
| `docId` | `string` | No | — |
| `parameters` | `object[]` | No | — |

> [accordion] parameters full type
>
> ```ts theme={null}
> {
>   key?: string,
>   name?: string,
>   values?: {
>     name?: string,
>     translationCade?: string,
>     value?: string
>   }[],
>   visible?: boolean,
>   value?: string
> }[]
> ```

***

### invoiceResetToDraft

`invoice.invoiceResetToDraft`

Reset status to draft. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceResetToDraft({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }& {
>   payDate?: JsonValue,
>   enshrined?: JsonValue,
>   accountIntervall?: JsonValue,
>   accountNextInvoice?: JsonValue
> }
> ```

***

### invoiceResetToOpen

`invoice.invoiceResetToOpen`

Reset status to open. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceResetToOpen({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }& {
>   status?: JsonValue,
>   payDate?: JsonValue,
>   enshrined?: JsonValue,
>   accountIntervall?: JsonValue,
>   accountNextInvoice?: JsonValue
> }
> ```

***

### invoiceSendBy

`invoice.invoiceSendBy`

Mark invoice as sent. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.invoiceSendBy({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   sendType: VPR | VP | VM | VPDF,
>   sendDraft: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   invoiceNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   invoiceDate?: string,
>   header?: string,
>   headText?: string,
>   footText?: string,
>   timeToPay?: string,
>   discountTime?: string,
>   discount?: string,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   },
>   payDate?: string,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   deliveryDate?: string,
>   status?: 50 | 100 | 200 | 750 | 1000,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxText?: string,
>   dunningLevel?: string,
>   taxType?: default | eu | noteu | custom,
>   paymentMethod?: {
>     id: string,
>     objectName: string
>   },
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   sendDate?: string,
>   origin?: {
>     id: string,
>     objectName: string
>   },
>   invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>   accountIntervall?: string,
>   accountNextInvoice?: string,
>   reminderTotal?: string,
>   reminderDebit?: string,
>   reminderDeadline?: string,
>   reminderCharge?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   },
>   address?: string,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   paidAmount?: number,
>   customerInternalNote?: string,
>   showNet?: boolean,
>   enshrined?: string,
>   sendType?: VPR | VPDF | VM | VP,
>   deliveryDateUntil?: string,
>   datevConnectOnline?: Record<string, JsonValue>,
>   sendPaymentReceivedNotificationDate?: string
> }
> ```

***

### sendInvoiceViaEMail

`invoice.sendInvoiceViaEMail`

Send invoice via email. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.invoice.sendInvoiceViaEMail({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   toEmail: string,
>   subject: string,
>   text: string,
>   copy?: boolean,
>   additionalAttachments?: string,
>   ccEmail?: string,
>   bccEmail?: string,
>   sendXml?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   object?: {
>     id?: string,
>     objectName?: string,
>     invoiceNumber?: string,
>     contact?: {
>       id: string,
>       objectName: string
>     },
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     invoiceDate?: string,
>     header?: string,
>     headText?: string,
>     footText?: string,
>     timeToPay?: string,
>     discountTime?: string,
>     discount?: string,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     },
>     payDate?: string,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     deliveryDate?: string,
>     status?: 50 | 100 | 200 | 750 | 1000,
>     smallSettlement?: boolean,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     },
>     taxRate?: string,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxText?: string,
>     dunningLevel?: string,
>     taxType?: default | eu | noteu | custom,
>     paymentMethod?: {
>       id: string,
>       objectName: string
>     },
>     costCentre?: {
>       id: string,
>       objectName: string
>     },
>     sendDate?: string,
>     origin?: {
>       id: string,
>       objectName: string
>     },
>     invoiceType?: RE | WKR | SR | MA | TR | AR | ER,
>     accountIntervall?: string,
>     accountNextInvoice?: string,
>     reminderTotal?: string,
>     reminderDebit?: string,
>     reminderDeadline?: string,
>     reminderCharge?: string,
>     taxSet?: {
>       id: string,
>       objectName: string
>     },
>     address?: string,
>     currency?: string,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     sumNetAccounting?: string,
>     sumTaxAccounting?: string,
>     sumGrossAccounting?: string,
>     paidAmount?: number,
>     customerInternalNote?: string,
>     showNet?: boolean,
>     enshrined?: string,
>     sendType?: VPR | VPDF | VM | VP,
>     deliveryDateUntil?: string,
>     datevConnectOnline?: Record<string, JsonValue>,
>     sendPaymentReceivedNotificationDate?: string
>   },
>   from: string,
>   to: string,
>   subject: string,
>   text?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   cc?: string | null,
>   bcc?: string | null,
>   arrived?: string | null
> }
> ```

***

## Invoice Pos

### getInvoicePos

`invoicePos.getInvoicePos`

Retrieve InvoicePos. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.invoicePos.getInvoicePos({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

The OpenAPI declares invoice-position quantity as boolean, inconsistent with the numeric request schema and sibling position models. The response schema accepts numbers or numeric strings and rejects booleans.

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   id?: number,
>   invoice[
>     id
>   ]?: number,
>   invoice[
>     objectName
>   ]?: string,
>   part[
>     id
>   ]?: number,
>   part[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   invoice?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: number | string,
>   price?: string,
>   name?: string,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string,
>   text?: string,
>   discount?: string,
>   taxRate?: string,
>   sumDiscount?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   priceNet?: string,
>   priceGross?: string,
>   priceTax?: string
> }[]
> ```

***

## Layout

### getLetterpapersWithThumb

`layout.getLetterpapersWithThumb`

Retrieve letterpapers. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.layout.getLetterpapersWithThumb({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string` | No | — |
| `letterpapers` | `object[]` | No | — |

> [accordion] letterpapers full type
>
> ```ts theme={null}
> {
>   id?: string,
>   pdf?: string,
>   sevClient?: string,
>   name?: string,
>   default?: number,
>   img?: string
> }[]
> ```

***

### getTemplates

`layout.getTemplates`

Retrieve templates. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.layout.getTemplates({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   type?: Invoice | invoicereminder | Order | Contractnote | Packinglist | Letter | Creditnote
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string` | No | — |
| `templates` | `object[]` | No | — |

> [accordion] templates full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   translationCode?: string,
>   sevClient?: string,
>   type?: string,
>   html?: string,
>   default?: number,
>   premium?: boolean
> }[]
> ```

***

### updateCreditNoteTemplate

`layout.updateCreditNoteTemplate`

Update an of credit note template. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.layout.updateCreditNoteTemplate({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   key: language | template | letterpaper | payPal,
>   value: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   result?: string,
>   metadaten?: {
>     pdf?: string,
>     docId?: string
>   }
> }
> ```

***

### updateInvoiceTemplate

`layout.updateInvoiceTemplate`

Update an invoice template. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.layout.updateInvoiceTemplate({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   key: language | template | letterpaper | payPal,
>   value: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   result?: string,
>   metadaten?: {
>     pdf?: string,
>     docId?: string
>   }
> }
> ```

***

### updateOrderTemplate

`layout.updateOrderTemplate`

Update an order template. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.layout.updateOrderTemplate({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   key: language | template | letterpaper | payPal,
>   value: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   result?: string,
>   metadaten?: {
>     pdf?: string,
>     docId?: string
>   }
> }
> ```

***

## Order

### createContractNoteFromOrder

`order.createContractNoteFromOrder`

Create contract note from order. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.order.createContractNoteFromOrder({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   order[
>     id
>   ]: number,
>   order[
>     objectName
>   ]: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

### createOrder

`order.createOrder`

Create a new order. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.order.createOrder({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   order: {
>     objectName?: string,
>     mapAll: boolean,
>     orderNumber: string,
>     contact: {
>       id: number,
>       objectName: string
>     },
>     orderDate: string,
>     status: 100 | 200 | 300 | 500 | 750 | 1000,
>     header: string,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry: {
>       id: number,
>       objectName: string
>     },
>     deliveryTerms?: string | null,
>     paymentTerms?: string | null,
>     version: number,
>     smallSettlement?: boolean,
>     contactPerson: {
>       id: number,
>       objectName: string
>     },
>     taxRate: number,
>     taxRule: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: number,
>       objectName: string
>     } | null,
>     taxText: string,
>     taxType: string,
>     orderType?: AN | AB | LI,
>     sendDate?: string | null,
>     address?: string | null,
>     currency: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP,
>     origin?: {
>       id: number,
>       objectName: string
>     } | null
>   },
>   orderPosSave?: {
>     objectName: string,
>     mapAll: boolean,
>     order?: {
>       id: number,
>       objectName: string
>     },
>     part?: {
>       id: number,
>       objectName: string
>     },
>     quantity: number,
>     price?: number | null,
>     priceTax?: number | null,
>     priceGross?: number | null,
>     name?: string | null,
>     unity: {
>       id: number,
>       objectName: string
>     },
>     positionNumber?: number | null,
>     text?: string | null,
>     discount?: number | null,
>     optional?: boolean | null,
>     taxRate: number
>   }[],
>   orderPosDelete?: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   order?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     orderNumber?: string,
>     contact?: {
>       id: string,
>       objectName: string
>     },
>     orderDate?: string,
>     status?: 100 | 200 | 300 | 500 | 750 | 1000,
>     header?: string,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryTerms?: string | null,
>     paymentTerms?: string | null,
>     origin?: {
>       id: string,
>       objectName: string
>     } | null,
>     version?: string,
>     smallSettlement?: boolean,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     },
>     taxRate?: string,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string,
>     taxType?: string,
>     orderType?: AN | AB | LI,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   orderPos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     order?: {
>       id: string,
>       objectName: string
>     },
>     part?: {
>       id: string,
>       objectName: string
>     },
>     quantity?: string,
>     price?: string | null,
>     priceNet?: string | null,
>     priceTax?: string | null,
>     priceGross?: string | null,
>     name?: string | null,
>     unity?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     positionNumber?: string | null,
>     text?: string | null,
>     discount?: string | null,
>     optional?: boolean | null,
>     taxRate?: string,
>     sumDiscount?: string | null
>   }[]
> }
> ```

***

### createPackingListFromOrder

`order.createPackingListFromOrder`

Create packing list from order. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.order.createPackingListFromOrder({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   order[
>     id
>   ]: number,
>   order[
>     objectName
>   ]: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

### deleteOrder

`order.deleteOrder`

Deletes an order. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.order.deleteOrder({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getDiscounts

`order.getDiscounts`

Find order discounts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.order.getDiscounts({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   embed?: string[],
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   object?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: string,
>   text?: string,
>   percentage?: string,
>   value?: string,
>   isNet?: string
> }[]
> ```

***

### getOrderById

`order.getOrderById`

Find order by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.order.getOrderById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }[]
> ```

***

### getOrderPositionsById

`order.getOrderPositionsById`

Find order positions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.order.getOrderPositionsById({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   embed?: string[],
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   order?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate?: string,
>   sumDiscount?: string | null
> }[]
> ```

***

### getOrders

`order.getOrders`

Retrieve orders. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.order.getOrders({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   orderNumber?: string,
>   startDate?: number,
>   endDate?: number,
>   contact[
>     id
>   ]?: number,
>   contact[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }[]
> ```

***

### getRelatedObjects

`order.getRelatedObjects`

Find related objects. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.order.getRelatedObjects({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   includeItself?: boolean,
>   sortByType?: boolean,
>   embed?: string[],
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   order?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate?: string,
>   sumDiscount?: string | null
> }[]
> ```

***

### orderGetPdf

`order.orderGetPdf`

Retrieve pdf document of an order. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.order.orderGetPdf({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   preventSendBy?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `filename` | `string` | No | — |
| `mimeType` | `string` | No | — |
| `base64encoded` | `boolean` | No | — |
| `content` | `string` | No | — |

***

### orderSendBy

`order.orderSendBy`

Mark order as sent. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.order.orderSendBy({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   sendType: VPR | VP | VM | VPDF,
>   sendDraft: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

### sendorderViaEMail

`order.sendorderViaEMail`

Send order via email. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.order.sendorderViaEMail({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   toEmail: string,
>   subject: string,
>   text: string,
>   copy?: boolean,
>   additionalAttachments?: string,
>   ccEmail?: string,
>   bccEmail?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   object?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     orderNumber?: string,
>     contact?: {
>       id: string,
>       objectName: string
>     },
>     orderDate?: string,
>     status?: 100 | 200 | 300 | 500 | 750 | 1000,
>     header?: string,
>     headText?: string | null,
>     footText?: string | null,
>     addressCountry?: {
>       id: string,
>       objectName: string
>     } | null,
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     deliveryTerms?: string | null,
>     paymentTerms?: string | null,
>     origin?: {
>       id: string,
>       objectName: string
>     } | null,
>     version?: string,
>     smallSettlement?: boolean,
>     contactPerson?: {
>       id: string,
>       objectName: string
>     },
>     taxRate?: string,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>       objectName: TaxRule
>     },
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     taxText?: string,
>     taxType?: string,
>     orderType?: AN | AB | LI,
>     sendDate?: string | null,
>     address?: string | null,
>     currency?: string,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumDiscounts?: string,
>     sumNetForeignCurrency?: string,
>     sumTaxForeignCurrency?: string,
>     sumGrossForeignCurrency?: string,
>     sumDiscountsForeignCurrency?: string,
>     customerInternalNote?: string | null,
>     showNet?: boolean,
>     sendType?: VPR | VPDF | VM | VP
>   },
>   from: string,
>   to: string,
>   subject: string,
>   text?: string | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   cc?: string | null,
>   bcc?: string | null,
>   arrived?: string | null
> }[]
> ```

***

### updateOrder

`order.updateOrder`

Update an existing order. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.order.updateOrder({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   orderNumber?: string,
>   contact?: {
>     id: number,
>     objectName: string
>   } | null,
>   orderDate?: string | null,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string | null,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: number,
>     objectName: string
>   } | null,
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: number,
>     objectName: string
>   } | null,
>   version?: number | null,
>   smallSettlement?: boolean | null,
>   contactPerson?: {
>     id: number,
>     objectName: string
>   },
>   taxRate?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: number,
>     objectName: string
>   } | null,
>   taxText?: string | null,
>   taxType?: string | null,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string | null,
>   customerInternalNote?: string | null,
>   showNet?: boolean | null,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   orderNumber?: string,
>   contact?: {
>     id: string,
>     objectName: string
>   },
>   orderDate?: string,
>   status?: 100 | 200 | 300 | 500 | 750 | 1000,
>   header?: string,
>   headText?: string | null,
>   footText?: string | null,
>   addressCountry?: {
>     id: string,
>     objectName: string
>   } | null,
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   deliveryTerms?: string | null,
>   paymentTerms?: string | null,
>   origin?: {
>     id: string,
>     objectName: string
>   } | null,
>   version?: string,
>   smallSettlement?: boolean,
>   contactPerson?: {
>     id: string,
>     objectName: string
>   },
>   taxRate?: string,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 11 | 17 | 18 | 19 | 20 | 21,
>     objectName: TaxRule
>   },
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   taxText?: string,
>   taxType?: string,
>   orderType?: AN | AB | LI,
>   sendDate?: string | null,
>   address?: string | null,
>   currency?: string,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumDiscounts?: string,
>   sumNetForeignCurrency?: string,
>   sumTaxForeignCurrency?: string,
>   sumGrossForeignCurrency?: string,
>   sumDiscountsForeignCurrency?: string,
>   customerInternalNote?: string | null,
>   showNet?: boolean,
>   sendType?: VPR | VPDF | VM | VP
> }
> ```

***

## Order Pos

### deleteOrderPos

`orderPos.deleteOrderPos`

Deletes an order Position. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.orderPos.deleteOrderPos({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getOrderPositionById

`orderPos.getOrderPositionById`

Find order position by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.orderPos.getOrderPositionById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   order?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate?: string,
>   sumDiscount?: string | null
> }[]
> ```

***

### getOrderPositions

`orderPos.getOrderPositions`

Retrieve order positions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.orderPos.getOrderPositions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   order[
>     id
>   ]?: number,
>   order[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   order?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate?: string,
>   sumDiscount?: string | null
> }[]
> ```

***

### updateOrderPosition

`orderPos.updateOrderPosition`

Update an existing order position. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.orderPos.updateOrderPosition({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   order?: {
>     id: number,
>     objectName: string
>   },
>   part?: {
>     id: number,
>     objectName: string
>   },
>   quantity?: number | null,
>   price?: number | null,
>   priceTax?: number | null,
>   priceGross?: number | null,
>   name?: string | null,
>   unity?: {
>     id: number,
>     objectName: string
>   },
>   positionNumber?: number | null,
>   text?: string | null,
>   discount?: number | null,
>   optional?: boolean | null,
>   taxRate?: number | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   order?: {
>     id: string,
>     objectName: string
>   },
>   part?: {
>     id: string,
>     objectName: string
>   },
>   quantity?: string,
>   price?: string | null,
>   priceNet?: string | null,
>   priceTax?: string | null,
>   priceGross?: string | null,
>   name?: string | null,
>   unity?: {
>     id: string,
>     objectName: string
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   positionNumber?: string | null,
>   text?: string | null,
>   discount?: string | null,
>   optional?: boolean | null,
>   taxRate?: string,
>   sumDiscount?: string | null
> }
> ```

***

## Part

### createPart

`part.createPart`

Create a new part. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.part.createPart({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name: string,
>   partNumber: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock: number,
>   stockEnabled?: boolean,
>   unity: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   pricePurchase?: number | null,
>   taxRate: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name: string,
>   partNumber: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock: number,
>   stockEnabled?: boolean,
>   unity: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   pricePurchase?: number | null,
>   taxRate: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }
> ```

***

### getPartById

`part.getPartById`

Find part by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.part.getPartById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name: string,
>   partNumber: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock: number,
>   stockEnabled?: boolean,
>   unity: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   pricePurchase?: number | null,
>   taxRate: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }[]
> ```

***

### getParts

`part.getParts`

Retrieve parts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.part.getParts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   partNumber?: string,
>   name?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name: string,
>   partNumber: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock: number,
>   stockEnabled?: boolean,
>   unity: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   pricePurchase?: number | null,
>   taxRate: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }[]
> ```

***

### partGetStock

`part.partGetStock`

Get stock of a part. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.part.partGetStock({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `number` | No | — |

***

### updatePart

`part.updatePart`

Update an existing part. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.part.updatePart({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   partNumber?: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock?: number,
>   stockEnabled?: boolean | null,
>   unity?: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   pricePurchase?: number | null,
>   taxRate?: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: number,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   name: string,
>   partNumber: string,
>   text?: string | null,
>   category?: {
>     id: number,
>     objectName: string
>   } | null,
>   stock: number,
>   stockEnabled?: boolean,
>   unity: {
>     id: number,
>     objectName: string
>   },
>   price?: number | null,
>   priceNet?: number | null,
>   priceGross?: number | null,
>   sevClient?: {
>     id: number,
>     objectName: string
>   },
>   pricePurchase?: number | null,
>   taxRate: number,
>   status?: 50 | 100,
>   internalComment?: string | null
> }
> ```

***

## Private Transaction Rule

### createPrivateTransactionRule

`privateTransactionRule.createPrivateTransactionRule`

Create a new rule. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.privateTransactionRule.createPrivateTransactionRule({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   objectName: string,
>   paymentPurpose?: string | null,
>   counterpartName?: string | null
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id?: string,
>     objectName?: string
>   },
>   paymentPurpose?: string | null,
>   counterpartName?: string | null
> }
> ```

***

### deletePrivateTransactionRule

`privateTransactionRule.deletePrivateTransactionRule`

Delete the rule by id. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.privateTransactionRule.deletePrivateTransactionRule({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### listPrivateTransactionRules

`privateTransactionRule.listPrivateTransactionRules`

List existing rules. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.privateTransactionRule.listPrivateTransactionRules({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id?: string,
>     objectName?: string
>   },
>   paymentPurpose?: string | null,
>   counterpartName?: string | null
> }[]
> ```

***

## Report

### reportContact

`report.reportContact`

Export contact list. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.report.reportContact({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       zip?: number,
>       city?: string,
>       country?: {
>         id: number,
>         objectName: string
>       },
>       depth?: boolean,
>       onlyPeople?: boolean
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### reportInvoice

`report.reportInvoice`

Export invoice list. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.report.reportInvoice({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   view: string,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       invoiceType?: (Re | SR | TR | AR | ER | WKR | MA)[],
>       startDate?: string,
>       endDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### reportOrder

`report.reportOrder`

Export order list. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.report.reportOrder({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   view: string,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       orderType?: AN | AB | LI,
>       startDate?: string,
>       endDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

### reportVoucher

`report.reportVoucher`

Export voucher list. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.report.reportVoucher({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   download?: boolean,
>   view: string,
>   sevQuery: {
>     limit?: number,
>     modelName: JsonValue,
>     objectName: JsonValue,
>     filter?: {
>       startDate?: string,
>       endDate?: string,
>       startPayDate?: string,
>       endPayDate?: string,
>       contact?: {
>         id: number,
>         objectName: string
>       },
>       startAmount?: number,
>       endAmount?: number
>     }
>   }
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   filename?: string,
>   mimetype?: string,
>   base64Encoded?: boolean,
>   content?: string
> }
> ```

***

## Tag

### createTag

`tag.createTag`

Create a new tag. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.tag.createTag({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string,
>   object: {
>     id: number,
>     objectName: Invoice | Voucher | Order | CreditNote
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   tag?: {
>     id: string,
>     objectName: string
>   },
>   object?: {
>     id: number,
>     objectName: Invoice | Voucher | Order | CreditNote
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }
> ```

***

### deleteTag

`tag.deleteTag`

Deletes a tag. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.tag.deleteTag({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue[]` | No | — |

***

### getTagById

`tag.getTagById`

Find tag by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.tag.getTagById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   name?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }[]
> ```

***

### getTagRelations

`tag.getTagRelations`

Retrieve tag relations. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.tag.getTagRelations({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   tag?: {
>     id: string,
>     objectName: string
>   },
>   object?: {
>     id: number,
>     objectName: Invoice | Voucher | Order | CreditNote
>   },
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }[]
> ```

***

### getTags

`tag.getTags`

Retrieve tags. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.tag.getTags({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   name?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }[]
> ```

***

### updateTag

`tag.updateTag`

Update tag. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.tag.updateTag({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   additionalInformation?: string,
>   create?: string,
>   name?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   }
> }
> ```

***

## Voucher

### bookVoucher

`voucher.bookVoucher`

Book a voucher. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.voucher.bookVoucher({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   amount: number,
>   date: string,
>   type: FULL_PAYMENT | N | CB | CF | O | OF | MTC,
>   checkAccount: {
>     id: number,
>     objectName: string
>   },
>   checkAccountTransaction?: {
>     id: number,
>     objectName: string
>   },
>   createFeed?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `objectName` | `string` | No | — |
| `create` | `string` | No | — |
| `voucher` | `object` | No | — |
| `fromStatus` | `string` | No | — |
| `toStatus` | `string` | No | — |
| `amountPayed` | `string` | No | — |
| `bookingDate` | `string` | No | — |
| `sevClient` | `object` | No | — |

> [accordion] voucher full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

> [accordion] sevClient full type
>
> ```ts theme={null}
> {
>   id: number,
>   objectName: string
> }
> ```

***

### forAccountNumber

`voucher.forAccountNumber`

Get guidance by account number. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.forAccountNumber({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   accountNumber: number,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object \| object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> } | {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> }[]
> ```

***

### forAllAccounts

`voucher.forAllAccounts`

Get all account guides. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.forAllAccounts({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> }[]
> ```

***

### forExpense

`voucher.forExpense`

Get guidance for expense accounts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.forExpense({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> }[]
> ```

***

### forRevenue

`voucher.forRevenue`

Get guidance for revenue accounts. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.forRevenue({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> }[]
> ```

***

### forTaxRule

`voucher.forTaxRule`

Get guidance by Tax Rule. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.forTaxRule({});
```

**Input**

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

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   taxRule: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   accountDatevId?: number,
>   accountNumber?: string,
>   accountName?: string,
>   description?: string,
>   allowedTaxRules?: {
>     name?: string,
>     description?: string,
>     id?: number,
>     taxRates?: string[]
>   }[],
>   allowedReceiptTypes?: string[]
> }[]
> ```

***

### getVoucherById

`voucher.getVoucherById`

Find voucher by ID. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.getVoucherById({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   mapAll?: boolean,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   voucherDate?: string | null,
>   supplier?: {
>     id: string,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   document?: {
>     id: string,
>     objectName: string
>   } | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   sumDiscounts?: string,
>   sumDiscountsForeignCurrency?: string,
>   paidAmount?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string | null,
>   creditDebit?: C | D,
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: string | null,
>   recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>   recurringStartDate?: string | null,
>   recurringNextVoucher?: string | null,
>   recurringLastVoucher?: string | null,
>   recurringEndDate?: string | null,
>   enshrined?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null
> }[]
> ```

***

### getVouchers

`voucher.getVouchers`

Retrieve vouchers. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucher.getVouchers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   status?: 50 | 100 | 1000,
>   creditDebit?: C | D,
>   descriptionLike?: string,
>   startDate?: number,
>   endDate?: number,
>   contact[
>     id
>   ]?: number,
>   contact[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   mapAll?: boolean,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   voucherDate?: string | null,
>   supplier?: {
>     id: string,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   document?: {
>     id: string,
>     objectName: string
>   } | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   sumDiscounts?: string,
>   sumDiscountsForeignCurrency?: string,
>   paidAmount?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string | null,
>   creditDebit?: C | D,
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: string | null,
>   recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>   recurringStartDate?: string | null,
>   recurringNextVoucher?: string | null,
>   recurringLastVoucher?: string | null,
>   recurringEndDate?: string | null,
>   enshrined?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null
> }[]
> ```

***

### updateVoucher

`voucher.updateVoucher`

Update an existing voucher. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.voucher.updateVoucher({});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   voucherDate?: string | null,
>   supplier?: {
>     id: number,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string,
>   creditDebit?: C | D,
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: number | null,
>   taxSet?: {
>     id: number,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null,
>   document?: {
>     id: number,
>     objectName: string
>   } | null,
>   costCentre?: {
>     id: number,
>     objectName: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   mapAll?: boolean,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   voucherDate?: string | null,
>   supplier?: {
>     id: string,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   document?: {
>     id: string,
>     objectName: string
>   } | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   sumDiscounts?: string,
>   sumDiscountsForeignCurrency?: string,
>   paidAmount?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string | null,
>   creditDebit?: C | D,
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: string | null,
>   recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>   recurringStartDate?: string | null,
>   recurringNextVoucher?: string | null,
>   recurringLastVoucher?: string | null,
>   recurringEndDate?: string | null,
>   enshrined?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null
> }
> ```

***

### voucherEnshrine

`voucher.voucherEnshrine`

Enshrine. Confirm before sending, booking, deleting, or legally enshrining accounting records.

**Risk:** `destructive`

```ts theme={null}
await corsair.sevdesk.api.voucher.voucherEnshrine({});
```

**Input**

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

Enshrining cannot be undone for legal reasons; confirm the target voucher before execution.

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `JsonValue` | No | — |

***

### voucherFactorySaveVoucher

`voucher.voucherFactorySaveVoucher`

Create a new voucher. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.voucher.voucherFactorySaveVoucher({});
```

**Input**

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

Update 2.0 requires ReceiptGuidance-compatible tax rules/rates. Voucher taxRule supports the documented revenue rules 1, 2, 3, 4, 5, 11 and expense rules 8, 9, 10, 12, 13, 14. Positions on Update 2.0 take accountDatev (accountingType is the 1.0 field) and sumGross when net is false or sumNet when net is true. Only DRAFT (50) and UNPAID/DUE (100) can be created; use bookVoucher to register payment. Asset accounts require an asset, and enshrinement is a separate irreversible action.

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   voucher: {
>     objectName: string,
>     mapAll: boolean,
>     voucherDate?: string | null,
>     supplier?: {
>       id: number,
>       objectName: string
>     } | null,
>     supplierName?: string | null,
>     description?: string | null,
>     payDate?: string | null,
>     status: 50 | 100 | 1000,
>     taxRule: {
>       id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>       objectName: TaxRule
>     },
>     taxType: string,
>     creditDebit: C | D,
>     voucherType: VOU | RV,
>     currency?: string | null,
>     propertyForeignCurrencyDeadline?: string | null,
>     propertyExchangeRate?: number | null,
>     taxSet?: {
>       id: number,
>       objectName: string
>     } | null,
>     paymentDeadline?: string | null,
>     deliveryDate?: string,
>     deliveryDateUntil?: string | null,
>     document?: {
>       id: number,
>       objectName: string
>     } | null,
>     costCentre?: {
>       id: number,
>       objectName: string
>     }
>   },
>   voucherPosSave?: {
>     objectName: string,
>     mapAll: boolean,
>     accountDatev?: {
>       id: number,
>       objectName: string
>     },
>     accountingType?: {
>       id: number,
>       objectName: string
>     },
>     taxRate: number,
>     net: boolean,
>     isAsset?: boolean,
>     sumNet?: number,
>     sumGross?: number,
>     comment?: string | null
>   }[],
>   voucherPosDelete?: {
>     id: number,
>     objectName: string
>   },
>   filename?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   voucher?: {
>     id?: string,
>     objectName?: string,
>     mapAll?: boolean,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     createUser?: {
>       id: string,
>       objectName: string
>     },
>     voucherDate?: string | null,
>     supplier?: {
>       id: string,
>       objectName: string
>     } | null,
>     supplierName?: string | null,
>     description?: string | null,
>     document?: {
>       id: string,
>       objectName: string
>     } | null,
>     payDate?: string | null,
>     status?: 50 | 100 | 1000,
>     sumNet?: string,
>     sumTax?: string,
>     sumGross?: string,
>     sumNetAccounting?: string,
>     sumTaxAccounting?: string,
>     sumGrossAccounting?: string,
>     sumDiscounts?: string,
>     sumDiscountsForeignCurrency?: string,
>     paidAmount?: number | null,
>     taxRule?: {
>       id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>       objectName: TaxRule
>     },
>     taxType?: string | null,
>     creditDebit?: C | D,
>     costCentre?: {
>       id: string,
>       objectName: string
>     },
>     voucherType?: VOU | RV,
>     currency?: string | null,
>     propertyForeignCurrencyDeadline?: string | null,
>     propertyExchangeRate?: string | null,
>     recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>     recurringStartDate?: string | null,
>     recurringNextVoucher?: string | null,
>     recurringLastVoucher?: string | null,
>     recurringEndDate?: string | null,
>     enshrined?: string,
>     taxSet?: {
>       id: string,
>       objectName: string
>     } | null,
>     paymentDeadline?: string | null,
>     deliveryDate?: string,
>     deliveryDateUntil?: string | null
>   },
>   voucherPos?: {
>     id?: string,
>     objectName?: string,
>     create?: string,
>     update?: string,
>     sevClient?: {
>       id: string,
>       objectName: string
>     },
>     voucher: {
>       id: string,
>       objectName: string
>     },
>     accountDatev: {
>       id: number,
>       objectName: string
>     },
>     accountingType: {
>       id: string,
>       objectName: string
>     },
>     estimatedAccountingType?: {
>       id: string,
>       objectName: string
>     },
>     taxRate: string,
>     net: boolean,
>     isAsset?: boolean,
>     sumNet: string,
>     sumTax?: string,
>     sumGross: string,
>     sumNetAccounting?: string,
>     sumTaxAccounting?: string,
>     sumGrossAccounting?: string,
>     comment?: string | null
>   }[],
>   filename?: string
> }
> ```

***

### voucherResetToDraft

`voucher.voucherResetToDraft`

Reset status to draft. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.voucher.voucherResetToDraft({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   mapAll?: boolean,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   voucherDate?: string | null,
>   supplier?: {
>     id: string,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   document?: {
>     id: string,
>     objectName: string
>   } | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   sumDiscounts?: string,
>   sumDiscountsForeignCurrency?: string,
>   paidAmount?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string | null,
>   creditDebit?: C | D,
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: string | null,
>   recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>   recurringStartDate?: string | null,
>   recurringNextVoucher?: string | null,
>   recurringLastVoucher?: string | null,
>   recurringEndDate?: string | null,
>   enshrined?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null
> }& {
>   status?: JsonValue
> }
> ```

***

### voucherResetToOpen

`voucher.voucherResetToOpen`

Reset status to open. Changes Sevdesk data or starts an export job.

**Risk:** `write`

```ts theme={null}
await corsair.sevdesk.api.voucher.voucherResetToOpen({});
```

**Input**

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

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

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

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   mapAll?: boolean,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   createUser?: {
>     id: string,
>     objectName: string
>   },
>   voucherDate?: string | null,
>   supplier?: {
>     id: string,
>     objectName: string
>   } | null,
>   supplierName?: string | null,
>   description?: string | null,
>   document?: {
>     id: string,
>     objectName: string
>   } | null,
>   payDate?: string | null,
>   status?: 50 | 100 | 1000,
>   sumNet?: string,
>   sumTax?: string,
>   sumGross?: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   sumDiscounts?: string,
>   sumDiscountsForeignCurrency?: string,
>   paidAmount?: number | null,
>   taxRule?: {
>     id: 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
>     objectName: TaxRule
>   },
>   taxType?: string | null,
>   creditDebit?: C | D,
>   costCentre?: {
>     id: string,
>     objectName: string
>   },
>   voucherType?: VOU | RV,
>   currency?: string | null,
>   propertyForeignCurrencyDeadline?: string | null,
>   propertyExchangeRate?: string | null,
>   recurringInterval?: P0Y0M1W | P0Y0M2W | P0Y1M0W | P0Y3M0W | P0Y6M0W | P1Y0M0W | P2Y0M0W | P3Y0M0W | P4Y0M0W | P5Y0M0W,
>   recurringStartDate?: string | null,
>   recurringNextVoucher?: string | null,
>   recurringLastVoucher?: string | null,
>   recurringEndDate?: string | null,
>   enshrined?: string,
>   taxSet?: {
>     id: string,
>     objectName: string
>   } | null,
>   paymentDeadline?: string | null,
>   deliveryDate?: string,
>   deliveryDateUntil?: string | null
> }& {
>   status?: JsonValue
> }
> ```

***

## Voucher Pos

### getVoucherPositions

`voucherPos.getVoucherPositions`

Retrieve voucher positions. Reads Sevdesk data.

**Risk:** `read`

```ts theme={null}
await corsair.sevdesk.api.voucherPos.getVoucherPositions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `resourceVersion` | `string` | No | — |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   voucher[
>     id
>   ]?: number,
>   voucher[
>     objectName
>   ]?: string,
>   limit?: number,
>   offset?: number,
>   countAll?: boolean
> }
> ```

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `objects` | `object[]` | No | — |

> [accordion] objects full type
>
> ```ts theme={null}
> {
>   id?: string,
>   objectName?: string,
>   create?: string,
>   update?: string,
>   sevClient?: {
>     id: string,
>     objectName: string
>   },
>   voucher: {
>     id: string,
>     objectName: string
>   },
>   accountDatev: {
>     id: number,
>     objectName: string
>   },
>   accountingType: {
>     id: string,
>     objectName: string
>   },
>   estimatedAccountingType?: {
>     id: string,
>     objectName: string
>   },
>   taxRate: string,
>   net: boolean,
>   isAsset?: boolean,
>   sumNet: string,
>   sumTax?: string,
>   sumGross: string,
>   sumNetAccounting?: string,
>   sumTaxAccounting?: string,
>   sumGrossAccounting?: string,
>   comment?: string | null
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.