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

# Elorus API reference

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

## V11

### bills\_create

`v11.bills_create`

Create a new bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.bills_create({
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string | null,
>   reference?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   delivery_notes?: string[],
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category: string,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_delete

`v11.bills_delete`

Delete a bill.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.bills_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### bills\_email\_create

`v11.bills_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.bills_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_email\_from\_template

`v11.bills_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.bills_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_email\_read

`v11.bills_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.bills_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### bills\_list

`v11.bills_list`

Get the list of bills.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.bills_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   overdue?: string,
>   supplier?: string,
>   currency_code?: string,
>   documenttype?: string,
>   self_billed?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string,
>   reference?: string,
>   date?: string,
>   due_date?: string | null,
>   branch?: string | null,
>   supplier?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### bills\_mark\_void

`v11.bills_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.bills_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### bills\_partial\_update

`v11.bills_partial_update`

Partially update a bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.bills_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_pdf

`v11.bills_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.bills_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### bills\_read

`v11.bills_read`

Get a single bill.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.bills_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_update

`v11.bills_update`

Update a bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.bills_update({
	path: { id: 'demo' },
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string | null,
>   reference?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   delivery_notes?: string[],
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category: string,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_create

`v11.cashpayments_create`

Create a new payment sent.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_create({
	body: { transaction_type: 'ip', amount: '100.00', contact: '3300000040000100' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type: string,
>   title?: string,
>   amount: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_delete

`v11.cashpayments_delete`

Delete a payment sent.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashpayments\_list

`v11.cashpayments_list`

Get the list of payments sent. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   contact?: string,
>   currency_code?: string,
>   transaction_type?: string,
>   purchase?: string,
>   creditnote?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   title?: string,
>   amount?: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### cashpayments\_pdf

`v11.cashpayments_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashpayments\_read

`v11.cashpayments_read`

Get a single payment sent.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_update

`v11.cashpayments_update`

Update a payment sent.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.cashpayments_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   title?: string,
>   amount?: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_create

`v11.cashreceipts_create`

Create a new payment received.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_create({
	body: { transaction_type: 'ip', contact: '3300000040000100', amount: '100.00' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   taxes?: string[],
>   amount: string,
>   status?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `string[]` | No | — |
| `amount` | `string` | No | — |
| `status` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_delete

`v11.cashreceipts_delete`

Delete a payment received.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashreceipts\_list

`v11.cashreceipts_list`

Get the list of payments received.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   contact?: string,
>   currency_code?: string,
>   pending_approval?: string,
>   is_void?: string,
>   transaction_type?: string,
>   invoice?: string,
>   purchasecreditnote?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   amount?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   status?: string,
>   payment_gateway?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### cashreceipts\_pdf

`v11.cashreceipts_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashreceipts\_read

`v11.cashreceipts_read`

Get a single payment received.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `net` | `string \| null` | No | — |
| `taxes` | `object[]` | No | — |
| `amount` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `status` | `string` | No | — |
| `payment_gateway` | `string \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string
> }[]
> ```

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_update

`v11.cashreceipts_update`

Update a payment received.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.cashreceipts_update({
	path: { id: 'demo' },
	body: { contact: '3300000040000100' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   taxes?: string[],
>   amount?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `string[]` | No | — |
| `amount` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_create

`v11.contacts_create`

Create a new contact.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.contacts_create({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_theme?: string | null,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_theme` | `string \| null` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_delete

`v11.contacts_delete`

Delete a contact.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.contacts_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### contacts\_list

`v11.contacts_list`

Get the list of contacts

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.contacts_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   letter?: string,
>   ctype?: string,
>   profession?: string,
>   company?: string,
>   active?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_theme?: string | null,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### contacts\_read

`v11.contacts_read`

Get the details of a single contact.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.contacts_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_theme` | `string \| null` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_update

`v11.contacts_update`

Update a contact.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.contacts_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_theme?: string | null,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_theme` | `string \| null` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_applied-credit\_create

`v11.creditnotes_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_applied-credit\_delete

`v11.creditnotes_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_applied-credit\_list

`v11.creditnotes_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice?: string,
>   amount?: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_create

`v11.creditnotes_create`

Create a new credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_create({
	body: {
		date: '2018-10-25',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   paid?: string,
>   payable?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   related_documents?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `paid` | `string` | No | — |
| `payable` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_delete

`v11.creditnotes_delete`

Delete a credit note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_email\_create

`v11.creditnotes_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_email\_from\_template

`v11.creditnotes_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_email\_read

`v11.creditnotes_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### creditnotes\_list

`v11.creditnotes_list`

Get the list of credit notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_mark\_void

`v11.creditnotes_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### creditnotes\_partial\_update

`v11.creditnotes_partial_update`

Partially update a credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_pdf

`v11.creditnotes_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### creditnotes\_read

`v11.creditnotes_read`

Get a single credit note.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_update

`v11.creditnotes_update`

Update a credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.creditnotes_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   related_documents?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### documenttypes\_list

`v11.documenttypes_list`

Get the list of document types. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.documenttypes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   application?: string,
>   active?: string,
>   is_delivery_note?: string,
>   always_self_billed?: string,
>   is_reverse_delivery_note?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   active?: boolean,
>   application?: number,
>   default?: boolean,
>   always_self_billed?: boolean,
>   is_delivery_note?: boolean,
>   is_reverse_delivery_note?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### documenttypes\_read

`v11.documenttypes_read`

Get a single document type. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.documenttypes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `title_translations` | `object` | No | — |
| `active` | `boolean` | No | — |
| `application` | `number` | No | — |
| `default` | `boolean` | No | — |
| `always_self_billed` | `boolean` | No | — |
| `is_delivery_note` | `boolean` | No | — |
| `is_reverse_delivery_note` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] title\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### emailtemplates\_create

`v11.emailtemplates_create`

Create an email template. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.emailtemplates_create({
	body: { email_type: 'invoice', subject: 'Invoice from %COMPANY% (%DOCUMENTNAME%)', message: '<div style="white-space: pre-wrap;"><p>Hello %CNAME%,<br><br>Please visit %PERMALINK% to access the invoice.<br>You can also download a pdf version from that link.<br><br>Thanks,<br>%SNAME%</p></div>' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type: string,
>   subject: string,
>   message: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### emailtemplates\_delete

`v11.emailtemplates_delete`

Destroy an email template. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.emailtemplates_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### emailtemplates\_list

`v11.emailtemplates_list`

Get the list of email templates. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.emailtemplates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   email_type?: string,
>   ordering?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type?: string,
>   subject?: string,
>   message?: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### emailtemplates\_read

`v11.emailtemplates_read`

Get a single email template. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.emailtemplates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### emailtemplates\_update

`v11.emailtemplates_update`

Update an email template. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.emailtemplates_update({
	path: { id: 'demo' },
	body: { subject: 'Invoice from %COMPANY% (%DOCUMENTNAME%)', message: '<div style="white-space: pre-wrap;"><p>Hello %CNAME%,<br><br>Please visit %PERMALINK% to access the invoice.<br>You can also download a pdf version from that link.<br><br>Thanks,<br>%SNAME%</p></div>' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type?: string,
>   subject: string,
>   message: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_create

`v11.estimates_create`

Create a new estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.estimates_create({
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   accept_status?: string,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string
> }[]
> ```

***

### estimates\_delete

`v11.estimates_delete`

Delete an estimate.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.estimates_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### estimates\_email\_create

`v11.estimates_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.estimates_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_email\_from\_template

`v11.estimates_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.estimates_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_email\_read

`v11.estimates_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.estimates_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### estimates\_list

`v11.estimates_list`

Get the list of estimates.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.estimates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   active?: string,
>   status?: string,
>   draft?: string,
>   accept_status?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   permalink?: string,
>   converted_invoice?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### estimates\_partial\_update

`v11.estimates_partial_update`

Partially update an estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.estimates_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   draft?: boolean,
>   status?: string,
>   template?: string,
>   representation?: string,
>   converted_invoice?: string,
>   accept_status?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `status` | `string` | No | — |
| `template` | `string` | No | — |
| `representation` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `accept_status` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_pdf

`v11.estimates_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.estimates_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### estimates\_read

`v11.estimates_read`

Get a single estimate.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.estimates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `permalink` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string
> }[]
> ```

***

### estimates\_update

`v11.estimates_update`

Update an estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.estimates_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   accept_status?: string,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   currency_code?: string,
>   exchange_rate?: string,
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   template?: string,
>   public_notes?: string,
>   converted_invoice?: string,
>   permalink?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `permalink` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string
> }[]
> ```

***

### expensecategories\_list

`v11.expensecategories_list`

Get the list of expense categories. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.expensecategories_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   color?: string,
>   protected?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### expensecategories\_read

`v11.expensecategories_read`

Get a single expense category. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.expensecategories_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `color` | `string` | No | — |
| `protected` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### expenses\_create

`v11.expenses_create`

Create a new expense.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.expenses_create({
	body: {
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     expense_category: string,
>     description?: string,
>     amount?: string,
>     item_net?: string,
>     taxes?: string[],
>     project?: string | null,
>     billable?: boolean
>   }[],
>   net?: string,
>   total?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category: string,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: string[],
>   project?: string | null,
>   billable?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### expenses\_delete

`v11.expenses_delete`

Delete an expense. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.expenses_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### expenses\_list

`v11.expenses_list`

Get the list of expenses.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.expenses_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   supplier?: string,
>   currency_code?: string,
>   branch_id?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   total?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### expenses\_read

`v11.expenses_read`

Get a single expense.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.expenses_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category: string,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: string[],
>   project?: string | null,
>   billable?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### expenses\_update

`v11.expenses_update`

To update the line items, the endpoint expects that you send a complete list of the new items. For existing lines you must send over their IDs (as returned by the retrieve endpoint

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.expenses_update({
	path: { id: 'demo' },
	body: {
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     expense_category: string,
>     description?: string,
>     amount?: string,
>     item_net?: string,
>     taxes?: string[],
>     project?: string | null,
>     billable?: boolean
>   }[],
>   net?: string,
>   total?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category: string,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: string[],
>   project?: string | null,
>   billable?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_applied-credit\_create

`v11.invoices_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.invoices_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_applied-credit\_delete

`v11.invoices_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.invoices_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_applied-credit\_list

`v11.invoices_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.invoices_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote?: string,
>   amount?: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_create

`v11.invoices_create`

Create a new invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.invoices_create({
	body: {
		date: '2018-10-25',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date: string,
>   due_days?: number | null,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   payment_gateways?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_delete

`v11.invoices_delete`

Delete an invoice.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.invoices_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_email\_create

`v11.invoices_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.invoices_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_email\_from\_template

`v11.invoices_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.invoices_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_email\_read

`v11.invoices_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.invoices_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### invoices\_list

`v11.invoices_list`

Get the list of invoices.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.invoices_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   overdue?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string,
>   number?: string,
>   date?: string,
>   due_date?: string | null,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_mark\_void

`v11.invoices_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.invoices_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### invoices\_partial\_update

`v11.invoices_partial_update`

Partially update an invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.invoices_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   payment_gateways?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_pdf

`v11.invoices_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.invoices_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### invoices\_read

`v11.invoices_read`

Get a single invoice.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.invoices_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_update

`v11.invoices_update`

Update an invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.invoices_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence?: string | null,
>   number?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   payment_gateways?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### numberingsequence\_create

`v11.numberingsequence_create`

Create a numbering sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.numberingsequence_create({
	body: { name: 'demo', documenttype: '4400000040000123' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   documenttype: string,
>   organization?: string,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `organization` | `string` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### numberingsequence\_delete

`v11.numberingsequence_delete`

Delete a numbering sequence.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.numberingsequence_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### numberingsequence\_list

`v11.numberingsequence_list`

Get the list of numbering sequences. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.numberingsequence_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   documenttype?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   documenttype?: string,
>   organization?: string,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### numberingsequence\_read

`v11.numberingsequence_read`

Get a single numbering sequence. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.numberingsequence_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `organization` | `string` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### numberingsequence\_update

`v11.numberingsequence_update`

Update a numbering sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.numberingsequence_update({
	path: { id: 'demo' },
	body: { name: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   documenttype?: string,
>   organization?: string,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `organization` | `string` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### paymentgateways\_list

`v11.paymentgateways_list`

Get the list of payment gateways. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.paymentgateways_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   backend?: string,
>   active?: string,
>   default?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   backend?: string,
>   active?: boolean,
>   default?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### products\_create

`v11.products_create`

Create a new product / service. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.products_create({
	body: { title: 'Pair of socks' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   stock?: string,
>   unit_measure?: number | null,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   active?: boolean,
>   taric_code?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `unit_measure` | `number \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### products\_delete

`v11.products_delete`

Delete a product / service.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.products_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### products\_list

`v11.products_list`

Get the list of products / services.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.products_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   sales?: string,
>   purchases?: string,
>   active?: string,
>   custom_id?: string,
>   ordering?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title?: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   stock?: string,
>   unit_measure?: number | null,
>   active?: boolean,
>   taric_code?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### products\_read

`v11.products_read`

Get a single product / service.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.products_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `unit_measure` | `number \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### products\_update

`v11.products_update`

Update a product / service.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.products_update({
	path: { id: 'demo' },
	body: { title: 'Pair of socks' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   stock?: string,
>   unit_measure?: number | null,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   active?: boolean,
>   taric_code?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `unit_measure` | `number \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### projects\_list

`v11.projects_list`

Get the list of projects. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.projects_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   client?: string,
>   billing_method?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   description?: string,
>   client?: string,
>   billing_method?: string,
>   fixed_cost?: string,
>   hourly_rate?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### projects\_read

`v11.projects_read`

Get a single project. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.projects_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `client` | `string` | No | — |
| `billing_method` | `string` | No | — |
| `fixed_cost` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `members` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] members full type
>
> ```ts theme={null}
> {
>   id?: string,
>   member: number,
>   manager?: string,
>   hourly_rate?: string,
>   cost_per_hour?: string
> }[]
> ```

***

### recurringinvoices\_create

`v11.recurringinvoices_create`

Create a new recurring invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.recurringinvoices_create({
	body: {
		end_datetime: '2020-01-01T06:00:00Z',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence?: string | null,
>   draft?: boolean,
>   auto_email?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### recurringinvoices\_delete

`v11.recurringinvoices_delete`

Delete a recurring invoice.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.recurringinvoices_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### recurringinvoices\_list

`v11.recurringinvoices_list`

Get the list of recurring invoices.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.recurringinvoices_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   documenttype?: string,
>   sequence?: string,
>   draft?: string,
>   client?: string,
>   currency_code?: string,
>   recurring_status?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime?: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence?: string,
>   draft?: boolean,
>   auto_email?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### recurringinvoices\_read

`v11.recurringinvoices_read`

Get a single recurring invoice.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.recurringinvoices_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### recurringinvoices\_update

`v11.recurringinvoices_update`

When changing the invoice client, all client fields will be updated based on the new contact record, unless you explicitly specify their values.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.recurringinvoices_update({
	path: { id: 'demo' },
	body: {
		end_datetime: '2020-01-01T06:00:00Z',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence?: string | null,
>   draft?: boolean,
>   auto_email?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence` | `string \| null` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_applied-credit\_create

`v11.suppliercredits_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase: string,
>   date?: string,
>   currency_code?: string,
>   amount: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase: string,
>   date?: string,
>   currency_code?: string,
>   amount: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_applied-credit\_delete

`v11.suppliercredits_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_applied-credit\_list

`v11.suppliercredits_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase?: string,
>   date?: string,
>   currency_code?: string,
>   amount?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_create

`v11.suppliercredits_create`

Create a new supplier credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_create({
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string | null,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category: string,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   related_documents?: string[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_delete

`v11.suppliercredits_delete`

Delete a supplier credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_email\_create

`v11.suppliercredits_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_email\_from\_template

`v11.suppliercredits_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_email\_read

`v11.suppliercredits_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### suppliercredits\_list

`v11.suppliercredits_list`

Get the list of supplier credits.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   supplier?: string,
>   currency_code?: string,
>   documenttype?: string,
>   self_billed?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_mark\_void

`v11.suppliercredits_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### suppliercredits\_partial\_update

`v11.suppliercredits_partial_update`

Partially update a supplier credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_pdf

`v11.suppliercredits_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### suppliercredits\_read

`v11.suppliercredits_read`

Get a single supplier credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_update

`v11.suppliercredits_update`

Update a supplier credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.suppliercredits_update({
	path: { id: 'demo' },
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence?: string | null,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: number | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: string[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category: string,
>     taric_code?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   total?: string,
>   withholding_taxes?: string[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   related_documents?: string[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence` | `string \| null` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `string[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: number | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: string[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category: string,
>   taric_code?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### taxes\_list

`v11.taxes_list`

Get the list of taxes. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.taxes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   operand?: string,
>   tax_type?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   tax_type?: string,
>   value_mode?: string,
>   operand?: string,
>   percentage?: string,
>   amount?: string,
>   per_unit?: boolean,
>   subject_to_vat?: boolean,
>   apply_on_document_lines?: boolean,
>   for_information_purposes?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### taxes\_read

`v11.taxes_read`

Get a single tax. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.taxes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `title_translations` | `object` | No | — |
| `tax_type` | `string` | No | — |
| `value_mode` | `string` | No | — |
| `operand` | `string` | No | — |
| `percentage` | `string` | No | — |
| `amount` | `string` | No | — |
| `per_unit` | `boolean` | No | — |
| `subject_to_vat` | `boolean` | No | — |
| `apply_on_document_lines` | `boolean` | No | — |
| `for_information_purposes` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] title\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### templates\_list

`v11.templates_list`

Get the list of templates. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.templates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   template?: string,
>   language?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   active?: boolean,
>   default?: boolean,
>   title?: string,
>   template?: string,
>   language?: string,
>   company_name?: string,
>   company_info?: string,
>   invoice_terms?: string,
>   creditnote_terms?: string,
>   estimate_terms?: string,
>   invoice_public_notes?: string,
>   creditnote_public_notes?: string,
>   estimate_public_notes?: string,
>   self_billed_public_notes?: string,
>   self_billed_supplier_credit_public_notes?: string,
>   slogan?: string,
>   invoice_email_message?: string,
>   estimate_email_message?: string,
>   purchase_email_message?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### templates\_read

`v11.templates_read`

Get a single template. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.templates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `default` | `boolean` | No | — |
| `title` | `string` | No | — |
| `template` | `string` | No | — |
| `language` | `string` | No | — |
| `company_name` | `string` | No | — |
| `company_info` | `string` | No | — |
| `invoice_terms` | `string` | No | — |
| `creditnote_terms` | `string` | No | — |
| `estimate_terms` | `string` | No | — |
| `invoice_public_notes` | `string` | No | — |
| `creditnote_public_notes` | `string` | No | — |
| `estimate_public_notes` | `string` | No | — |
| `self_billed_public_notes` | `string` | No | — |
| `self_billed_supplier_credit_public_notes` | `string` | No | — |
| `slogan` | `string` | No | — |
| `invoice_email_message` | `string` | No | — |
| `estimate_email_message` | `string` | No | — |
| `purchase_email_message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### trackingcategories\_list

`v11.trackingcategories_list`

Get the list of tracking categories. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.trackingcategories_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   application?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   active?: boolean,
>   options?: string[],
>   application?: string[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### trackingcategories\_read

`v11.trackingcategories_read`

Get a single tracking category. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.trackingcategories_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `active` | `boolean` | No | — |
| `options` | `string[]` | No | — |
| `application` | `string[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### warehouse\_create

`v11.warehouse_create`

Create a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_create({
	body: {
		name: 'demo',
		warehouse_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   warehouse_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_delete

`v11.warehouse_delete`

Delete a warehouse. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### warehouse\_list

`v11.warehouse_list`

Get the list of warehouses. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   warehouse_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### warehouse\_partial\_update

`v11.warehouse_partial_update`

Partially update a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   warehouse_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_read

`v11.warehouse_read`

Get a single warehouse. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_update

`v11.warehouse_update`

Update a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v11.warehouse_update({
	path: { id: 'demo' },
	body: {
		name: 'demo',
		warehouse_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   warehouse_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

## V12

### bills\_attachments\_create

`v12.bills_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }), "primary": false } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom,
>   primary?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### bills\_attachments\_delete

`v12.bills_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### bills\_attachments\_file

`v12.bills_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### bills\_attachments\_list

`v12.bills_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### bills\_attachments\_partial\_update

`v12.bills_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### bills\_attachments\_read

`v12.bills_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### bills\_create

`v12.bills_create`

Create a new bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_create({
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   related_documents?: string[],
>   delivery_notes?: string[],
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_delete

`v12.bills_delete`

Delete a bill.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### bills\_email\_create

`v12.bills_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_email\_from\_template

`v12.bills_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_email\_read

`v12.bills_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### bills\_list

`v12.bills_list`

Get the list of bills.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   overdue?: string,
>   supplier?: string,
>   currency_code?: string,
>   documenttype?: string,
>   self_billed?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   due_date?: string | null,
>   branch?: string | null,
>   supplier?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### bills\_mark\_void

`v12.bills_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### bills\_notes\_create

`v12.bills_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_notes\_delete

`v12.bills_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.bills_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### bills\_notes\_list

`v12.bills_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### bills\_notes\_update

`v12.bills_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### bills\_partial\_update

`v12.bills_partial_update`

Partially update a bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_pdf

`v12.bills_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### bills\_read

`v12.bills_read`

Get a single bill.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### bills\_sent-email-messages\_list

`v12.bills_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.bills_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### bills\_update

`v12.bills_update`

Update a bill.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.bills_update({
	path: { id: 'demo' },
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   related_documents?: string[],
>   delivery_notes?: string[],
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_attachments\_create

`v12.cashpayments_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashpayments\_attachments\_delete

`v12.cashpayments_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashpayments\_attachments\_file

`v12.cashpayments_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashpayments\_attachments\_list

`v12.cashpayments_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### cashpayments\_attachments\_partial\_update

`v12.cashpayments_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashpayments\_attachments\_read

`v12.cashpayments_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashpayments\_create

`v12.cashpayments_create`

Create a new payment sent.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_create({
	body: { transaction_type: 'ip', amount: '100.00', contact: '3300000040000100' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type: string,
>   title?: string,
>   amount: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_delete

`v12.cashpayments_delete`

Delete a payment sent.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashpayments\_list

`v12.cashpayments_list`

Get the list of payments sent. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   contact?: string,
>   currency_code?: string,
>   transaction_type?: string,
>   purchase?: string,
>   creditnote?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   title?: string,
>   amount?: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### cashpayments\_notes\_create

`v12.cashpayments_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### cashpayments\_notes\_delete

`v12.cashpayments_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashpayments\_notes\_list

`v12.cashpayments_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### cashpayments\_notes\_update

`v12.cashpayments_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### cashpayments\_pdf

`v12.cashpayments_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashpayments\_read

`v12.cashpayments_read`

Get a single payment sent.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashpayments\_update

`v12.cashpayments_update`

Update a payment sent.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashpayments_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   title?: string,
>   amount?: string,
>   exchange_rate?: string,
>   currency_code?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   purchase_payments?: {
>     purchase: string,
>     amount: string
>   }[],
>   creditnote_payments?: {
>     creditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `title` | `string` | No | — |
| `amount` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `purchase_payments` | `object[]` | No | — |
| `creditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] purchase\_payments full type
>
> ```ts theme={null}
> {
>   purchase: string,
>   amount: string
> }[]
> ```

> [accordion] creditnote\_payments full type
>
> ```ts theme={null}
> {
>   creditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_attachments\_create

`v12.cashreceipts_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashreceipts\_attachments\_delete

`v12.cashreceipts_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashreceipts\_attachments\_file

`v12.cashreceipts_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashreceipts\_attachments\_list

`v12.cashreceipts_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### cashreceipts\_attachments\_partial\_update

`v12.cashreceipts_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashreceipts\_attachments\_read

`v12.cashreceipts_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### cashreceipts\_create

`v12.cashreceipts_create`

Create a new payment received.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_create({
	body: { transaction_type: 'ip', contact: '3300000040000100', amount: '100.00' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   taxes?: string[],
>   amount: string,
>   status?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `string[]` | No | — |
| `amount` | `string` | No | — |
| `status` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_delete

`v12.cashreceipts_delete`

Delete a payment received.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashreceipts\_list

`v12.cashreceipts_list`

Get the list of payments received.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   contact?: string,
>   currency_code?: string,
>   pending_approval?: string,
>   is_void?: string,
>   transaction_type?: string,
>   invoice?: string,
>   purchasecreditnote?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   amount?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   status?: string,
>   payment_gateway?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### cashreceipts\_notes\_create

`v12.cashreceipts_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### cashreceipts\_notes\_delete

`v12.cashreceipts_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### cashreceipts\_notes\_list

`v12.cashreceipts_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### cashreceipts\_notes\_update

`v12.cashreceipts_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### cashreceipts\_pdf

`v12.cashreceipts_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### cashreceipts\_read

`v12.cashreceipts_read`

Get a single payment received.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `net` | `string \| null` | No | — |
| `taxes` | `object[]` | No | — |
| `amount` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `status` | `string` | No | — |
| `payment_gateway` | `string \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string
> }[]
> ```

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### cashreceipts\_update

`v12.cashreceipts_update`

Update a payment received.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.cashreceipts_update({
	path: { id: 'demo' },
	body: { contact: '3300000040000100' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   transaction_type?: string,
>   income_type?: string,
>   title?: string,
>   date?: string,
>   branch?: string | null,
>   contact: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   taxes?: string[],
>   amount?: string,
>   invoice_payments?: {
>     invoice: string,
>     amount: string
>   }[],
>   purchasecreditnote_payments?: {
>     purchasecreditnote: string,
>     amount: string
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `transaction_type` | `string` | No | — |
| `income_type` | `string` | No | — |
| `title` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `string[]` | No | — |
| `amount` | `string` | No | — |
| `invoice_payments` | `object[]` | No | — |
| `purchasecreditnote_payments` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] invoice\_payments full type
>
> ```ts theme={null}
> {
>   invoice: string,
>   amount: string
> }[]
> ```

> [accordion] purchasecreditnote\_payments full type
>
> ```ts theme={null}
> {
>   purchasecreditnote: string,
>   amount: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_attachments\_create

`v12.contacts_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### contacts\_attachments\_delete

`v12.contacts_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### contacts\_attachments\_file

`v12.contacts_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### contacts\_attachments\_list

`v12.contacts_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### contacts\_attachments\_partial\_update

`v12.contacts_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### contacts\_attachments\_read

`v12.contacts_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### contacts\_create

`v12.contacts_create`

Create a new contact.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_create({
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_template?: string,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_template` | `string` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_delete

`v12.contacts_delete`

Delete a contact.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.contacts_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### contacts\_list

`v12.contacts_list`

Get the list of contacts

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   letter?: string,
>   ctype?: string,
>   profession?: string,
>   company?: string,
>   active?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_template?: string,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### contacts\_notes\_create

`v12.contacts_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### contacts\_notes\_delete

`v12.contacts_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.contacts_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### contacts\_notes\_list

`v12.contacts_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### contacts\_notes\_update

`v12.contacts_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### contacts\_read

`v12.contacts_read`

Get the details of a single contact.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.contacts_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_template` | `string` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### contacts\_update

`v12.contacts_update`

Update a contact.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.contacts_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   active?: boolean,
>   first_name?: string,
>   last_name?: string,
>   company?: string,
>   display_name?: string,
>   profession?: string,
>   vat_number?: string,
>   is_client?: boolean,
>   is_supplier?: boolean,
>   default_language?: string,
>   default_template?: string,
>   default_taxes?: string[],
>   default_currency_code?: string,
>   addresses?: {
>     id?: string,
>     address: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     ad_type?: string,
>     branch_code?: number | null
>   }[],
>   email?: {
>     id?: string,
>     email: string,
>     primary: boolean
>   }[],
>   phones?: {
>     id?: string,
>     number: string,
>     primary: boolean
>   }[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `company` | `string` | No | — |
| `display_name` | `string` | No | — |
| `profession` | `string` | No | — |
| `vat_number` | `string` | No | — |
| `is_client` | `boolean` | No | — |
| `is_supplier` | `boolean` | No | — |
| `default_language` | `string` | No | — |
| `default_template` | `string` | No | — |
| `default_taxes` | `string[]` | No | — |
| `default_currency_code` | `string` | No | — |
| `addresses` | `object[]` | No | — |
| `email` | `object[]` | No | — |
| `phones` | `object[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: string,
>   address: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   ad_type?: string,
>   branch_code?: number | null
> }[]
> ```

> [accordion] email full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email: string,
>   primary: boolean
> }[]
> ```

> [accordion] phones full type
>
> ```ts theme={null}
> {
>   id?: string,
>   number: string,
>   primary: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_applied-credit\_create

`v12.creditnotes_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_applied-credit\_delete

`v12.creditnotes_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_applied-credit\_list

`v12.creditnotes_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   invoice?: string,
>   amount?: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_attachments\_create

`v12.creditnotes_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### creditnotes\_attachments\_delete

`v12.creditnotes_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_attachments\_file

`v12.creditnotes_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### creditnotes\_attachments\_list

`v12.creditnotes_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### creditnotes\_attachments\_partial\_update

`v12.creditnotes_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### creditnotes\_attachments\_read

`v12.creditnotes_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### creditnotes\_create

`v12.creditnotes_create`

Create a new credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_create({
	body: {
		date: '2018-10-25',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   paid?: string,
>   payable?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   related_documents?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `paid` | `string` | No | — |
| `payable` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_delete

`v12.creditnotes_delete`

Delete a credit note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_discussions\_create

`v12.creditnotes_discussions_create`

Create a new discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_discussions_create({
	path: { parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_discussions\_delete

`v12.creditnotes_discussions_delete`

Delete a discussion message.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_discussions_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_discussions\_list

`v12.creditnotes_discussions_list`

Get the client discussion.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_discussions_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### creditnotes\_discussions\_update

`v12.creditnotes_discussions_update`

Update a discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_discussions_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_email\_create

`v12.creditnotes_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_email\_from\_template

`v12.creditnotes_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_email\_read

`v12.creditnotes_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### creditnotes\_list

`v12.creditnotes_list`

Get the list of credit notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_mark\_void

`v12.creditnotes_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### creditnotes\_notes\_create

`v12.creditnotes_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_notes\_delete

`v12.creditnotes_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### creditnotes\_notes\_list

`v12.creditnotes_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### creditnotes\_notes\_update

`v12.creditnotes_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### creditnotes\_partial\_update

`v12.creditnotes_partial_update`

Partially update a credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_pdf

`v12.creditnotes_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### creditnotes\_read

`v12.creditnotes_read`

Get a single credit note.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### creditnotes\_sent-email-messages\_list

`v12.creditnotes_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### creditnotes\_update

`v12.creditnotes_update`

Update a credit note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.creditnotes_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   related_documents?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `related_documents` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### deliverynotes\_attachments\_create

`v12.deliverynotes_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### deliverynotes\_attachments\_delete

`v12.deliverynotes_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### deliverynotes\_attachments\_file

`v12.deliverynotes_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### deliverynotes\_attachments\_list

`v12.deliverynotes_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### deliverynotes\_attachments\_partial\_update

`v12.deliverynotes_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### deliverynotes\_attachments\_read

`v12.deliverynotes_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### deliverynotes\_create

`v12.deliverynotes_create`

Create a new delivery note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_create({
	body: {
		move_purpose: 1,
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   intra_transfer?: boolean,
>   is_reverse_delivery_note?: boolean,
>   reverse_delivery_note_purpose?: number | null,
>   branch?: string | null,
>   contact?: string | null,
>   contact_display_name?: string,
>   contact_profession?: string,
>   contact_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   contact_person?: string,
>   contact_phone_number?: string,
>   contact_email?: string,
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose: number,
>   other_move_purpose_title?: string,
>   to_weigh?: boolean,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure: string,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_mode?: string,
>     unit_discount_percentage?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     taric_code?: string,
>     unit_total?: string,
>     item_net?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean,
>     target_warehouse?: string | null,
>     move_purpose?: number | null,
>     other_move_purpose_title?: string
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   template?: string | null,
>   public_notes?: string,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `intra_transfer` | `boolean` | No | — |
| `is_reverse_delivery_note` | `boolean` | No | — |
| `reverse_delivery_note_purpose` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string \| null` | No | — |
| `contact_display_name` | `string` | No | — |
| `contact_profession` | `string` | No | — |
| `contact_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `loading_address` | `object` | No | — |
| `contact_person` | `string` | No | — |
| `contact_phone_number` | `string` | No | — |
| `contact_email` | `string` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number` | No | — |
| `other_move_purpose_title` | `string` | No | — |
| `to_weigh` | `boolean` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure: string,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_mode?: string,
>   unit_discount_percentage?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   taric_code?: string,
>   unit_total?: string,
>   item_net?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean,
>   target_warehouse?: string | null,
>   move_purpose?: number | null,
>   other_move_purpose_title?: string
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

***

### deliverynotes\_delete

`v12.deliverynotes_delete`

Delete a delivery note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### deliverynotes\_email\_create

`v12.deliverynotes_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### deliverynotes\_email\_from\_template

`v12.deliverynotes_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### deliverynotes\_email\_read

`v12.deliverynotes_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### deliverynotes\_list

`v12.deliverynotes_list`

Get the list of delivery notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   contact?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   is_reverse_delivery_note?: boolean,
>   reverse_delivery_note_purpose?: number | null,
>   branch?: string | null,
>   contact?: string | null,
>   contact_display_name?: string,
>   contact_profession?: string,
>   contact_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   contact_person?: string,
>   contact_phone_number?: string,
>   contact_email?: string,
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number,
>   to_weigh?: boolean,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   permalink?: string,
>   converted_invoice?: string,
>   purchase?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### deliverynotes\_mark\_void

`v12.deliverynotes_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### deliverynotes\_notes\_create

`v12.deliverynotes_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### deliverynotes\_notes\_delete

`v12.deliverynotes_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### deliverynotes\_notes\_list

`v12.deliverynotes_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### deliverynotes\_notes\_update

`v12.deliverynotes_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### deliverynotes\_partial\_update

`v12.deliverynotes_partial_update`

Partially update a delivery note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   draft?: boolean,
>   status?: string,
>   template?: string | null,
>   representation?: string,
>   converted_invoice?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `status` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `representation` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### deliverynotes\_pdf

`v12.deliverynotes_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### deliverynotes\_read

`v12.deliverynotes_read`

Get a single delivery note.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `intra_transfer` | `boolean` | No | — |
| `is_reverse_delivery_note` | `boolean` | No | — |
| `reverse_delivery_note_purpose` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string \| null` | No | — |
| `contact_display_name` | `string` | No | — |
| `contact_profession` | `string` | No | — |
| `contact_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `loading_address` | `object` | No | — |
| `contact_person` | `string` | No | — |
| `contact_phone_number` | `string` | No | — |
| `contact_email` | `string` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number` | No | — |
| `other_move_purpose_title` | `string` | No | — |
| `to_weigh` | `boolean` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `converted_invoice` | `string` | No | — |
| `purchase` | `string` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure: string,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_mode?: string,
>   unit_discount_percentage?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   taric_code?: string,
>   unit_total?: string,
>   item_net?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean,
>   target_warehouse?: string | null,
>   move_purpose?: number | null,
>   other_move_purpose_title?: string
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

***

### deliverynotes\_sent-email-messages\_list

`v12.deliverynotes_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### deliverynotes\_update

`v12.deliverynotes_update`

Update a delivery note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.deliverynotes_update({
	path: { id: 'demo' },
	body: {
		move_purpose: 1,
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   intra_transfer?: boolean,
>   is_reverse_delivery_note?: boolean,
>   reverse_delivery_note_purpose?: number | null,
>   branch?: string | null,
>   contact?: string | null,
>   contact_display_name?: string,
>   contact_profession?: string,
>   contact_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   contact_person?: string,
>   contact_phone_number?: string,
>   contact_email?: string,
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose: number,
>   other_move_purpose_title?: string,
>   to_weigh?: boolean,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure: string,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_mode?: string,
>     unit_discount_percentage?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     taric_code?: string,
>     unit_total?: string,
>     item_net?: string,
>     warehouse?: string | null,
>     skip_stock_update?: boolean,
>     target_warehouse?: string | null,
>     move_purpose?: number | null,
>     other_move_purpose_title?: string
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   template?: string | null,
>   public_notes?: string,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   converted_invoice?: string,
>   purchase?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `intra_transfer` | `boolean` | No | — |
| `is_reverse_delivery_note` | `boolean` | No | — |
| `reverse_delivery_note_purpose` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `contact` | `string \| null` | No | — |
| `contact_display_name` | `string` | No | — |
| `contact_profession` | `string` | No | — |
| `contact_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `loading_address` | `object` | No | — |
| `contact_person` | `string` | No | — |
| `contact_phone_number` | `string` | No | — |
| `contact_email` | `string` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number` | No | — |
| `other_move_purpose_title` | `string` | No | — |
| `to_weigh` | `boolean` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `converted_invoice` | `string` | No | — |
| `purchase` | `string` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure: string,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_mode?: string,
>   unit_discount_percentage?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   taric_code?: string,
>   unit_total?: string,
>   item_net?: string,
>   warehouse?: string | null,
>   skip_stock_update?: boolean,
>   target_warehouse?: string | null,
>   move_purpose?: number | null,
>   other_move_purpose_title?: string
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

***

### documenttypes\_list

`v12.documenttypes_list`

Get the list of document types. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   application?: string,
>   active?: string,
>   is_delivery_note?: string,
>   always_self_billed?: string,
>   is_reverse_delivery_note?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   active?: boolean,
>   application?: number,
>   default?: boolean,
>   default_sequence?: string,
>   always_self_billed?: boolean,
>   is_delivery_note?: boolean,
>   is_reverse_delivery_note?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### documenttypes\_read

`v12.documenttypes_read`

Get a single document type. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `title_translations` | `object` | No | — |
| `active` | `boolean` | No | — |
| `application` | `number` | No | — |
| `default` | `boolean` | No | — |
| `default_sequence` | `string` | No | — |
| `always_self_billed` | `boolean` | No | — |
| `is_delivery_note` | `boolean` | No | — |
| `is_reverse_delivery_note` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] title\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### documenttypes\_sequences\_create

`v12.documenttypes_sequences_create`

Create a numbering sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_sequences_create({
	path: { parent_pk: 'demo' },
	body: { name: 'SQC-123' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### documenttypes\_sequences\_delete\_sequence

`v12.documenttypes_sequences_delete_sequence`

Delete a numbering sequence. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_sequences_delete_sequence({
	path: { parent_pk: 'demo' },
	body: { name: 'SQC-123' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output:** `undefined`

***

### documenttypes\_sequences\_list

`v12.documenttypes_sequences_list`

Get the numbering sequences of a document type. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_sequences_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

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

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   count?: number,
>   results?: {
>     name?: string,
>     in_use?: string,
>     active?: boolean
>   }[]
> }[]
> ```

***

### documenttypes\_sequences\_rename\_sequence

`v12.documenttypes_sequences_rename_sequence`

Rename a numbering sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.documenttypes_sequences_rename_sequence({
	path: { parent_pk: 'demo' },
	body: { old_name: 'SQC-123', new_name: 'SQC-ABC' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   old_name: string,
>   new_name: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `old_name` | `string` | No | — |
| `new_name` | `string` | No | — |

***

### emailtemplates\_create

`v12.emailtemplates_create`

Create an email template. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.emailtemplates_create({
	body: { email_type: 'invoice', subject: 'Invoice from %COMPANY% (%DOCUMENTNAME%)', message: '<div style="white-space: pre-wrap;"><p>Hello %CNAME%,<br><br>Please visit %PERMALINK% to access the invoice.<br>You can also download a pdf version from that link.<br><br>Thanks,<br>%SNAME%</p></div>' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type: string,
>   subject: string,
>   message: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### emailtemplates\_delete

`v12.emailtemplates_delete`

Destroy an email template. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.emailtemplates_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### emailtemplates\_list

`v12.emailtemplates_list`

Get the list of email templates. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.emailtemplates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   email_type?: string,
>   ordering?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type?: string,
>   subject?: string,
>   message?: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### emailtemplates\_read

`v12.emailtemplates_read`

Get a single email template. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.emailtemplates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### emailtemplates\_update

`v12.emailtemplates_update`

Update an email template. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.emailtemplates_update({
	path: { id: 'demo' },
	body: { subject: 'Invoice from %COMPANY% (%DOCUMENTNAME%)', message: '<div style="white-space: pre-wrap;"><p>Hello %CNAME%,<br><br>Please visit %PERMALINK% to access the invoice.<br>You can also download a pdf version from that link.<br><br>Thanks,<br>%SNAME%</p></div>' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   email_type?: string,
>   subject: string,
>   message: string,
>   sender_type?: string,
>   sender_name?: string,
>   default?: boolean,
>   default_for_language?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `email_type` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_type` | `string` | No | — |
| `sender_name` | `string` | No | — |
| `default` | `boolean` | No | — |
| `default_for_language` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_attachments\_create

`v12.estimates_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### estimates\_attachments\_delete

`v12.estimates_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### estimates\_attachments\_file

`v12.estimates_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### estimates\_attachments\_list

`v12.estimates_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### estimates\_attachments\_partial\_update

`v12.estimates_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### estimates\_attachments\_read

`v12.estimates_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### estimates\_create

`v12.estimates_create`

Create a new estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_create({
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   accept_status?: string,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     line_type?: number | null
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

***

### estimates\_delete

`v12.estimates_delete`

Delete an estimate.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### estimates\_discussions\_create

`v12.estimates_discussions_create`

Create a new discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_discussions_create({
	path: { parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_discussions\_delete

`v12.estimates_discussions_delete`

Delete a discussion message.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_discussions_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### estimates\_discussions\_list

`v12.estimates_discussions_list`

Get the client discussion.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_discussions_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### estimates\_discussions\_update

`v12.estimates_discussions_update`

Update a discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_discussions_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_email\_create

`v12.estimates_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_email\_from\_template

`v12.estimates_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_email\_read

`v12.estimates_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### estimates\_list

`v12.estimates_list`

Get the list of estimates.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   active?: string,
>   status?: string,
>   draft?: string,
>   accept_status?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   permalink?: string,
>   converted_invoice?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### estimates\_notes\_create

`v12.estimates_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_notes\_delete

`v12.estimates_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.estimates_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### estimates\_notes\_list

`v12.estimates_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### estimates\_notes\_update

`v12.estimates_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_partial\_update

`v12.estimates_partial_update`

Partially update an estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   draft?: boolean,
>   status?: string,
>   template?: string,
>   representation?: string,
>   converted_invoice?: string,
>   accept_status?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `status` | `string` | No | — |
| `template` | `string` | No | — |
| `representation` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `accept_status` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### estimates\_pdf

`v12.estimates_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### estimates\_read

`v12.estimates_read`

Get a single estimate.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `permalink` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

***

### estimates\_sent-email-messages\_list

`v12.estimates_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.estimates_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### estimates\_update

`v12.estimates_update`

Update an estimate.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.estimates_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   accept_status?: string,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   currency_code?: string,
>   exchange_rate?: string,
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     line_type?: number | null
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   template?: string,
>   public_notes?: string,
>   converted_invoice?: string,
>   permalink?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `accept_status` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `template` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `converted_invoice` | `string` | No | — |
| `permalink` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

***

### expensecategories\_list

`v12.expensecategories_list`

Get the list of expense categories. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expensecategories_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   color?: string,
>   protected?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### expensecategories\_read

`v12.expensecategories_read`

Get a single expense category. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expensecategories_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `color` | `string` | No | — |
| `protected` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### expenses\_attachments\_create

`v12.expenses_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }), "primary": false } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom,
>   primary?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### expenses\_attachments\_delete

`v12.expenses_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### expenses\_attachments\_file

`v12.expenses_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### expenses\_attachments\_list

`v12.expenses_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### expenses\_attachments\_partial\_update

`v12.expenses_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### expenses\_attachments\_read

`v12.expenses_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### expenses\_create

`v12.expenses_create`

Create a new expense.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_create({
	body: {
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     expense_category?: string | null,
>     description?: string,
>     amount?: string,
>     item_net?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     project?: string | null,
>     billable?: boolean,
>     line_type?: number | null
>   }[],
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category?: string | null,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   project?: string | null,
>   billable?: boolean,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### expenses\_delete

`v12.expenses_delete`

Delete an expense. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.expenses_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### expenses\_list

`v12.expenses_list`

Get the list of expenses.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   supplier?: string,
>   currency_code?: string,
>   branch_id?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   net?: string,
>   total?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### expenses\_notes\_create

`v12.expenses_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### expenses\_notes\_delete

`v12.expenses_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.expenses_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### expenses\_notes\_list

`v12.expenses_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### expenses\_notes\_update

`v12.expenses_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### expenses\_read

`v12.expenses_read`

Get a single expense.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.expenses_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category?: string | null,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   project?: string | null,
>   billable?: boolean,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### expenses\_update

`v12.expenses_update`

To update the line items, the endpoint expects that you send a complete list of the new items. For existing lines you must send over their IDs (as returned by the retrieve endpoint

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.expenses_update({
	path: { id: 'demo' },
	body: {
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   date?: string,
>   reference?: string,
>   branch?: string | null,
>   supplier?: string | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     expense_category?: string | null,
>     description?: string,
>     amount?: string,
>     item_net?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     project?: string | null,
>     billable?: boolean,
>     line_type?: number | null
>   }[],
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `date` | `string` | No | — |
| `reference` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   expense_category?: string | null,
>   description?: string,
>   amount?: string,
>   item_net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   project?: string | null,
>   billable?: boolean,
>   line_type?: number | null
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### goodsreceipts\_create

`v12.goodsreceipts_create`

Create a new goods receipt.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_create({
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   template?: string | null,
>   public_notes?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `items` | `object[]` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

***

### goodsreceipts\_delete

`v12.goodsreceipts_delete`

Delete a goods receipt.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### goodsreceipts\_email\_create

`v12.goodsreceipts_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### goodsreceipts\_email\_from\_template

`v12.goodsreceipts_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### goodsreceipts\_email\_read

`v12.goodsreceipts_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### goodsreceipts\_list

`v12.goodsreceipts_list`

goodsreceipts list

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   supplier?: string,
>   sequence?: string,
>   branch_id?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   custom_id?: string,
>   status?: string,
>   draft?: boolean,
>   is_void?: boolean,
>   sequence_flat?: string,
>   number?: string,
>   branch?: string | null,
>   billing_address?: string,
>   supplier?: string,
>   supplier_display_name?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### goodsreceipts\_mark\_void

`v12.goodsreceipts_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### goodsreceipts\_notes\_create

`v12.goodsreceipts_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### goodsreceipts\_notes\_delete

`v12.goodsreceipts_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### goodsreceipts\_notes\_list

`v12.goodsreceipts_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### goodsreceipts\_notes\_update

`v12.goodsreceipts_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### goodsreceipts\_partial\_update

`v12.goodsreceipts_partial_update`

Partially update a goods receipt.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   draft?: boolean,
>   status?: string,
>   template?: string | null,
>   representation?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `status` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `representation` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### goodsreceipts\_pdf

`v12.goodsreceipts_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### goodsreceipts\_read

`v12.goodsreceipts_read`

Get a single goods receipt.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `representation` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `is_void` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `billing_address` | `string` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `items` | `object[]` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `date` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

***

### goodsreceipts\_sent-email-messages\_list

`v12.goodsreceipts_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### goodsreceipts\_update

`v12.goodsreceipts_update`

Update a goods receipt.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceipts_update({
	path: { id: 'demo' },
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     warehouse?: string | null,
>     skip_stock_update?: boolean
>   }[],
>   template?: string | null,
>   public_notes?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `items` | `object[]` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   warehouse?: string | null,
>   skip_stock_update?: boolean
> }[]
> ```

***

### goodsreceiptsequences\_create

`v12.goodsreceiptsequences_create`

Create a goods receipt sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceiptsequences_create({
	body: { name: 'SQC-123' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

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

***

### goodsreceiptsequences\_delete\_sequence

`v12.goodsreceiptsequences_delete_sequence`

Delete a numbering sequence. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceiptsequences_delete_sequence({
	body: { name: 'SQC-123' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### goodsreceiptsequences\_list

`v12.goodsreceiptsequences_list`

Get the list of goods receipt sequences. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceiptsequences_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   count?: number,
>   results?: {
>     name?: string,
>     in_use?: string,
>     active?: boolean
>   }[]
> }[]
> ```

***

### goodsreceiptsequences\_rename\_sequence

`v12.goodsreceiptsequences_rename_sequence`

Rename a numbering sequence. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.goodsreceiptsequences_rename_sequence({
	body: { old_name: 'SQC-123', new_name: 'SQC-ABC' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   old_name: string,
>   new_name: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `old_name` | `string` | No | — |
| `new_name` | `string` | No | — |

***

### invoices\_applied-credit\_create

`v12.invoices_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote: string,
>   amount: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_applied-credit\_delete

`v12.invoices_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_applied-credit\_list

`v12.invoices_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   creditnote?: string,
>   amount?: string,
>   currency_code?: string,
>   date?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_attachments\_create

`v12.invoices_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### invoices\_attachments\_delete

`v12.invoices_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_attachments\_file

`v12.invoices_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### invoices\_attachments\_list

`v12.invoices_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### invoices\_attachments\_partial\_update

`v12.invoices_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### invoices\_attachments\_read

`v12.invoices_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### invoices\_create

`v12.invoices_create`

Create a new invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_create({
	body: {
		date: '2018-10-25',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date: string,
>   due_days?: number | null,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   payment_gateways?: string[],
>   related_documents?: string[],
>   delivery_notes?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_delete

`v12.invoices_delete`

Delete an invoice.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_discussions\_create

`v12.invoices_discussions_create`

Create a new discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_discussions_create({
	path: { parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_discussions\_delete

`v12.invoices_discussions_delete`

Delete a discussion message.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_discussions_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_discussions\_list

`v12.invoices_discussions_list`

Get the client discussion.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_discussions_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### invoices\_discussions\_update

`v12.invoices_discussions_update`

Update a discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_discussions_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_email\_create

`v12.invoices_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_email\_from\_template

`v12.invoices_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_email\_read

`v12.invoices_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### invoices\_list

`v12.invoices_list`

Get the list of invoices.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   overdue?: string,
>   client?: string,
>   currency_code?: string,
>   documenttype?: string,
>   sequence?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   due_date?: string | null,
>   branch?: string | null,
>   client?: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_mark\_void

`v12.invoices_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### invoices\_notes\_create

`v12.invoices_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_notes\_delete

`v12.invoices_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.invoices_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### invoices\_notes\_list

`v12.invoices_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### invoices\_notes\_update

`v12.invoices_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### invoices\_partial\_update

`v12.invoices_partial_update`

Partially update an invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   payment_gateways?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_pdf

`v12.invoices_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### invoices\_read

`v12.invoices_read`

Get a single invoice.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### invoices\_sent-email-messages\_list

`v12.invoices_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.invoices_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### invoices\_update

`v12.invoices_update`

Update an invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.invoices_update({
	path: { id: 'demo' },
	body: {
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string,
>   sequence_flat?: string,
>   number?: string,
>   date?: string,
>   due_days?: number | null,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string,
>   terms?: string,
>   public_notes?: string,
>   payment_gateways?: string[],
>   related_documents?: string[],
>   delivery_notes?: string[],
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   permalink?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `number` | `string` | No | — |
| `date` | `string` | No | — |
| `due_days` | `number \| null` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string` | No | — |
| `terms` | `string` | No | — |
| `public_notes` | `string` | No | — |
| `payment_gateways` | `string[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `delivery_notes` | `string[]` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `permalink` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### organizationbranch\_create

`v12.organizationbranch_create`

Create an organization branch. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_create({
	body: {
		branch_name: 'demo',
		branch_code: -2147483648,
		branch_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   branch_name: string,
>   branch_code: number,
>   branch_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   phone?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `branch_name` | `string` | No | — |
| `branch_code` | `number` | No | — |
| `branch_address` | `object` | No | — |
| `phone` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] branch\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### organizationbranch\_delete

`v12.organizationbranch_delete`

Delete an organization branch. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### organizationbranch\_list

`v12.organizationbranch_list`

Get the list of organization branches. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   branch_name?: string,
>   branch_code?: number,
>   branch_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   phone?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### organizationbranch\_partial\_update

`v12.organizationbranch_partial_update`

Partially update an organization branch. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   branch_name?: string,
>   branch_code?: number,
>   branch_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   phone?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `branch_name` | `string` | No | — |
| `branch_code` | `number` | No | — |
| `branch_address` | `object` | No | — |
| `phone` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] branch\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### organizationbranch\_read

`v12.organizationbranch_read`

Get a single organization branch. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `branch_name` | `string` | No | — |
| `branch_code` | `number` | No | — |
| `branch_address` | `object` | No | — |
| `phone` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] branch\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### organizationbranch\_update

`v12.organizationbranch_update`

Update an organization branch. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.organizationbranch_update({
	path: { id: 'demo' },
	body: {
		branch_name: 'demo',
		branch_code: -2147483648,
		branch_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   branch_name: string,
>   branch_code: number,
>   branch_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   phone?: string,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `branch_name` | `string` | No | — |
| `branch_code` | `number` | No | — |
| `branch_address` | `object` | No | — |
| `phone` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] branch\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### paymentgateways\_list

`v12.paymentgateways_list`

Get the list of payment gateways. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.paymentgateways_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   backend?: string,
>   active?: string,
>   default?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   backend?: string,
>   active?: boolean,
>   default?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### products\_create

`v12.products_create`

Create a new product / service. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.products_create({
	body: { title: 'Pair of socks' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   initial_stock?: {
>     warehouse: string,
>     stock: string
>   }[],
>   stock?: string,
>   unit_measure?: string | null,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   active?: boolean,
>   taric_code?: string,
>   barcodes?: {
>     barcode: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `barcodes` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

> [accordion] barcodes full type
>
> ```ts theme={null}
> {
>   barcode: string
> }[]
> ```

***

### products\_delete

`v12.products_delete`

Delete a product / service.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.products_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### products\_list

`v12.products_list`

Get the list of products / services.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.products_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   sales?: string,
>   purchases?: string,
>   active?: string,
>   custom_id?: string,
>   ordering?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title?: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   stock?: string,
>   unit_measure?: string | null,
>   active?: boolean,
>   taric_code?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### products\_notes\_create

`v12.products_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.products_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### products\_notes\_delete

`v12.products_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.products_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### products\_notes\_list

`v12.products_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.products_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### products\_notes\_update

`v12.products_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.products_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### products\_read

`v12.products_read`

Get a single product / service.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.products_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `warehouses_stock` | `object[]` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `barcodes` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouses\_stock full type
>
> ```ts theme={null}
> {
>   warehouse: string,
>   stock: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

> [accordion] barcodes full type
>
> ```ts theme={null}
> {
>   barcode: string
> }[]
> ```

***

### products\_stockadjustments\_create

`v12.products_stockadjustments_create`

Create a new stock adjustment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.products_stockadjustments_create({
	path: { parent_pk: 'demo' },
	body: { warehouse: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   operand?: string,
>   quantity?: string,
>   date?: string,
>   notes?: string,
>   warehouse: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `operand` | `string` | No | — |
| `quantity` | `string` | No | — |
| `date` | `string` | No | — |
| `notes` | `string` | No | — |
| `warehouse` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### products\_stockadjustments\_delete

`v12.products_stockadjustments_delete`

Delete an existing stock adjustment.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.products_stockadjustments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### products\_stockadjustments\_list

`v12.products_stockadjustments_list`

Get the list of manual stock adjustments for the product / service.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.products_stockadjustments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   operand?: string,
>   quantity?: string,
>   date?: string,
>   notes?: string,
>   warehouse?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### products\_stockadjustments\_read

`v12.products_stockadjustments_read`

Get a single manual stock adjustment.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.products_stockadjustments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `operand` | `string` | No | — |
| `quantity` | `string` | No | — |
| `date` | `string` | No | — |
| `notes` | `string` | No | — |
| `warehouse` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### products\_update

`v12.products_update`

Update a product / service.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.products_update({
	path: { id: 'demo' },
	body: { title: 'Pair of socks' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   title: string,
>   code?: string,
>   description?: string,
>   sales?: boolean,
>   sale_value?: string,
>   sale_taxes?: string[],
>   purchases?: boolean,
>   purchase_value?: string,
>   purchase_taxes?: string[],
>   manage?: boolean,
>   stock?: string,
>   warehouses_stock?: {
>     warehouse: string,
>     stock: string
>   }[],
>   unit_measure?: string | null,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   active?: boolean,
>   taric_code?: string,
>   barcodes?: {
>     barcode: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `title` | `string` | No | — |
| `code` | `string` | No | — |
| `description` | `string` | No | — |
| `sales` | `boolean` | No | — |
| `sale_value` | `string` | No | — |
| `sale_taxes` | `string[]` | No | — |
| `purchases` | `boolean` | No | — |
| `purchase_value` | `string` | No | — |
| `purchase_taxes` | `string[]` | No | — |
| `manage` | `boolean` | No | — |
| `stock` | `string` | No | — |
| `warehouses_stock` | `object[]` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `active` | `boolean` | No | — |
| `taric_code` | `string` | No | — |
| `barcodes` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouses\_stock full type
>
> ```ts theme={null}
> {
>   warehouse: string,
>   stock: string
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

> [accordion] barcodes full type
>
> ```ts theme={null}
> {
>   barcode: string
> }[]
> ```

***

### projects\_attachments\_create

`v12.projects_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }) } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### projects\_attachments\_delete

`v12.projects_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### projects\_attachments\_file

`v12.projects_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### projects\_attachments\_list

`v12.projects_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   client_portal?: boolean,
>   created?: string,
>   file_size?: string
> }[]
> ```

***

### projects\_attachments\_partial\_update

`v12.projects_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   file_url?: string,
>   client_portal?: boolean,
>   created?: string,
>   file_size?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `client_portal` | `boolean` | No | — |
| `created` | `string` | No | — |
| `file_size` | `string` | No | — |

***

### projects\_attachments\_read

`v12.projects_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `file_url` | `string` | No | — |
| `client_portal` | `boolean` | No | — |
| `created` | `string` | No | — |
| `file_size` | `string` | No | — |

***

### projects\_create

`v12.projects_create`

Create a new project.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_create({
	body: {
		name: 'Web development',
		client: '3300000040000100',
		members: [],
		tasks: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   client: string,
>   billing_method?: string,
>   fixed_cost?: string,
>   hourly_rate?: string,
>   members: {
>     member: number,
>     manager?: boolean,
>     hourly_rate: string,
>     cost_per_hour?: string
>   }[],
>   tasks: {
>     id?: string,
>     name: string,
>     description?: string,
>     hourly_rate?: string
>   }[],
>   client_portal?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `client` | `string` | No | — |
| `billing_method` | `string` | No | — |
| `fixed_cost` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `members` | `object[]` | No | — |
| `tasks` | `object[]` | No | — |
| `client_portal` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] members full type
>
> ```ts theme={null}
> {
>   member: number,
>   manager?: boolean,
>   hourly_rate: string,
>   cost_per_hour?: string
> }[]
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   hourly_rate?: string
> }[]
> ```

***

### projects\_delete

`v12.projects_delete`

Delete a project. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.projects_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### projects\_discussions\_create

`v12.projects_discussions_create`

Create a new discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_discussions_create({
	path: { parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### projects\_discussions\_delete

`v12.projects_discussions_delete`

Delete a discussion message.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.projects_discussions_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### projects\_discussions\_list

`v12.projects_discussions_list`

Get the client discussion.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_discussions_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### projects\_discussions\_update

`v12.projects_discussions_update`

Update a discussion message.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_discussions_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { message: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   message: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   send_email_to_client?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `message` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### projects\_list

`v12.projects_list`

Get the list of projects. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   client?: string,
>   billing_method?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   description?: string,
>   client?: string,
>   billing_method?: string,
>   fixed_cost?: string,
>   hourly_rate?: string,
>   active?: boolean,
>   organization?: number,
>   members?: {
>     member: number,
>     member_repr?: string,
>     hourly_rate?: string,
>     cost_per_hour?: string
>   }[],
>   client_portal?: string,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### projects\_notes\_create

`v12.projects_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### projects\_notes\_delete

`v12.projects_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.projects_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### projects\_notes\_list

`v12.projects_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### projects\_notes\_update

`v12.projects_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### projects\_projectextrafees\_create

`v12.projects_projectextrafees_create`

Create a new project extra fee. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_create({
	path: { parent_pk: 'demo' },
	body: { date: '2018-10-25', title: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   date: string,
>   title: string,
>   description?: string,
>   quantity?: string,
>   amount?: string,
>   unit_measure?: string | null,
>   product?: string | null,
>   organization?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `date` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `quantity` | `string` | No | — |
| `amount` | `string` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `product` | `string \| null` | No | — |
| `organization` | `number` | No | — |

***

### projects\_projectextrafees\_delete

`v12.projects_projectextrafees_delete`

Delete a project extra fee. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### projects\_projectextrafees\_list

`v12.projects_projectextrafees_list`

Get the list of project extra fees. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   invoiced?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   date?: string,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   amount?: string,
>   unit_measure?: string | null,
>   product?: string | null,
>   organization?: number
> }[]
> ```

***

### projects\_projectextrafees\_partial\_update

`v12.projects_projectextrafees_partial_update`

Partially update a project extra fee. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   date?: string,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   amount?: string,
>   unit_measure?: string | null,
>   product?: string | null,
>   organization?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `date` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `quantity` | `string` | No | — |
| `amount` | `string` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `product` | `string \| null` | No | — |
| `organization` | `number` | No | — |

***

### projects\_projectextrafees\_read

`v12.projects_projectextrafees_read`

Get a single project extra fee. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `date` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `quantity` | `string` | No | — |
| `amount` | `string` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `product` | `string \| null` | No | — |
| `organization` | `number` | No | — |

***

### projects\_projectextrafees\_update

`v12.projects_projectextrafees_update`

Update a project extra fee. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_projectextrafees_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { date: '2018-10-25', title: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   date: string,
>   title: string,
>   description?: string,
>   quantity?: string,
>   amount?: string,
>   unit_measure?: string | null,
>   product?: string | null,
>   organization?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `date` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string` | No | — |
| `quantity` | `string` | No | — |
| `amount` | `string` | No | — |
| `unit_measure` | `string \| null` | No | — |
| `product` | `string \| null` | No | — |
| `organization` | `number` | No | — |

***

### projects\_read

`v12.projects_read`

Get a single project. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.projects_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `client` | `string` | No | — |
| `billing_method` | `string` | No | — |
| `fixed_cost` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `billed_amount` | `string` | No | — |
| `expenses_amount` | `string` | No | — |
| `unbilled_expenses_amount` | `string` | No | — |
| `unbilled_hours_amount` | `string` | No | — |
| `costs` | `string` | No | — |
| `billable_hours` | `string` | No | — |
| `total_hours` | `string` | No | — |
| `unbilled_hours` | `string` | No | — |
| `unbilled_extra_fees_amount` | `string` | No | — |
| `members` | `object[]` | No | — |
| `client_portal` | `string` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] members full type
>
> ```ts theme={null}
> {
>   member: number,
>   member_repr?: string,
>   manager?: string,
>   hourly_rate?: string,
>   cost_per_hour?: string
> }[]
> ```

***

### projects\_update

`v12.projects_update`

Update an existing project. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.projects_update({
	path: { id: 'demo' },
	body: {
		name: 'Web development',
		client: '3300000040000100',
		members: [],
		tasks: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   client: string,
>   billing_method?: string,
>   fixed_cost?: string,
>   hourly_rate?: string,
>   members: {
>     member: number,
>     manager?: boolean,
>     hourly_rate: string,
>     cost_per_hour?: string
>   }[],
>   tasks: {
>     id?: string,
>     name: string,
>     description?: string,
>     hourly_rate?: string
>   }[],
>   client_portal?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `client` | `string` | No | — |
| `billing_method` | `string` | No | — |
| `fixed_cost` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `members` | `object[]` | No | — |
| `tasks` | `object[]` | No | — |
| `client_portal` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] members full type
>
> ```ts theme={null}
> {
>   member: number,
>   manager?: boolean,
>   hourly_rate: string,
>   cost_per_hour?: string
> }[]
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   hourly_rate?: string
> }[]
> ```

***

### recurringinvoices\_create

`v12.recurringinvoices_create`

Create a new recurring invoice.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_create({
	body: {
		end_datetime: '2020-01-01T06:00:00Z',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence_flat?: string,
>   draft?: boolean,
>   auto_email?: boolean,
>   auto_email_attach_pdf?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `auto_email_attach_pdf` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### recurringinvoices\_delete

`v12.recurringinvoices_delete`

Delete a recurring invoice.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### recurringinvoices\_list

`v12.recurringinvoices_list`

Get the list of recurring invoices.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   documenttype?: string,
>   sequence?: string,
>   draft?: string,
>   client?: string,
>   currency_code?: string,
>   recurring_status?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime?: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence_flat?: string,
>   draft?: boolean,
>   auto_email?: boolean,
>   auto_email_attach_pdf?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### recurringinvoices\_notes\_create

`v12.recurringinvoices_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### recurringinvoices\_notes\_delete

`v12.recurringinvoices_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### recurringinvoices\_notes\_list

`v12.recurringinvoices_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### recurringinvoices\_notes\_update

`v12.recurringinvoices_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### recurringinvoices\_read

`v12.recurringinvoices_read`

Get a single recurring invoice.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `auto_email_attach_pdf` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### recurringinvoices\_update

`v12.recurringinvoices_update`

When changing the invoice client, all client fields will be updated based on the new contact record, unless you explicitly specify their values.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.recurringinvoices_update({
	path: { id: 'demo' },
	body: {
		end_datetime: '2020-01-01T06:00:00Z',
		client: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   start_datetime?: string,
>   interval?: number,
>   period?: string,
>   end_datetime: string,
>   last_execution?: string,
>   next_execution?: string,
>   paused?: boolean,
>   representation?: string,
>   documenttype?: string,
>   sequence_flat?: string,
>   draft?: boolean,
>   auto_email?: boolean,
>   auto_email_attach_pdf?: boolean,
>   due_days?: number | null,
>   template?: string,
>   branch?: string | null,
>   client: string,
>   client_display_name?: string,
>   client_profession?: string,
>   client_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   client_contact_person?: string,
>   client_phone_number?: string,
>   client_email?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     title?: string,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `interval` | `number` | No | — |
| `period` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `last_execution` | `string` | No | — |
| `next_execution` | `string` | No | — |
| `paused` | `boolean` | No | — |
| `representation` | `string` | No | — |
| `documenttype` | `string` | No | — |
| `sequence_flat` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `auto_email` | `boolean` | No | — |
| `auto_email_attach_pdf` | `boolean` | No | — |
| `due_days` | `number \| null` | No | — |
| `template` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `client` | `string` | No | — |
| `client_display_name` | `string` | No | — |
| `client_profession` | `string` | No | — |
| `client_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `client_contact_person` | `string` | No | — |
| `client_phone_number` | `string` | No | — |
| `client_email` | `string` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   title?: string,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_applied-credit\_create

`v12.suppliercredits_applied-credit_create`

Bulk apply credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_applied-credit_create({
	path: { parent_pk: 'demo' },
	body: [],
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object[]` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase: string,
>   date?: string,
>   currency_code?: string,
>   amount: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase: string,
>   date?: string,
>   currency_code?: string,
>   amount: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_applied-credit\_delete

`v12.suppliercredits_applied-credit_delete`

Delete applied credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_applied-credit_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_applied-credit\_list

`v12.suppliercredits_applied-credit_list`

Get the applied credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_applied-credit_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   representation?: string,
>   purchase?: string,
>   date?: string,
>   currency_code?: string,
>   amount?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_attachments\_create

`v12.suppliercredits_attachments_create`

Create a new attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_create({ path: {"parent_pk":"demo"}, form: { "title": "demo", "file": new Blob(["demo file"], { type: "application/octet-stream" }), "primary": false } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `form` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] form full type
>
> ```ts theme={null}
> {
>   title?: string,
>   file: custom,
>   primary?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | Yes | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### suppliercredits\_attachments\_delete

`v12.suppliercredits_attachments_delete`

Delete an attachment. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_attachments\_file

`v12.suppliercredits_attachments_file`

Get the actual attachment file.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_file({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### suppliercredits\_attachments\_list

`v12.suppliercredits_attachments_list`

Get the list of attachments.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }[]
> ```

***

### suppliercredits\_attachments\_partial\_update

`v12.suppliercredits_attachments_partial_update`

Partially update an attachment.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_partial_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   primary?: boolean,
>   file_url?: string,
>   file_size?: string,
>   created?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### suppliercredits\_attachments\_read

`v12.suppliercredits_attachments_read`

Get a single attachment. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_attachments_read({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `primary` | `boolean` | No | — |
| `file_url` | `string` | No | — |
| `file_size` | `string` | No | — |
| `created` | `string` | No | — |

***

### suppliercredits\_create

`v12.suppliercredits_create`

Create a new supplier credit. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_create({
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   related_documents?: string[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_delete

`v12.suppliercredits_delete`

Delete a supplier credit.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_email\_create

`v12.suppliercredits_email_create`

Send the document by email.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_email_create({
	path: { id: 'demo' },
	body: {
		to: 'someone@example.com',
		cc: [],
		bcc: [],
		subject: 'The email subject',
		message: 'Hello,<br/>please find the PDF attached.',
		attach_pdf: false,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc: string[],
>   bcc: string[],
>   reply_to?: string,
>   subject: string,
>   message: string,
>   attach_pdf: boolean,
>   sender_name?: string,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_email\_from\_template

`v12.suppliercredits_email_from_template`

The subject and message are rendered from the template resolved via templateid, or the organization's default template if not provided.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_email_from_template({
	path: { id: 'demo' },
	body: { to: 'someone@example.com' },
});
```

**Input**

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

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

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   to: string,
>   store_to?: boolean,
>   cc?: string[],
>   bcc?: string[],
>   reply_to?: string,
>   attach_pdf?: boolean,
>   attachments?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `from_email` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | Yes | — |
| `subject` | `string` | Yes | — |
| `message` | `string` | No | — |
| `attachments` | `string` | No | — |
| `attach_pdf` | `boolean` | No | — |
| `status` | `string` | No | — |
| `status_updated` | `string \| null` | No | — |
| `sent_via_smtp` | `boolean` | No | — |
| `smtp_error` | `string` | Yes | — |
| `smtp_error_code` | `number \| null` | No | — |
| `metadata` | `Record<string, string>` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_email\_read

`v12.suppliercredits_email_read`

Get the default document email fields.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_email_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `to` | `string` | No | — |
| `cc` | `string` | No | — |
| `bcc` | `string` | No | — |
| `reply_to` | `string` | No | — |
| `subject` | `string` | No | — |
| `message` | `string` | No | — |
| `sender_name` | `string` | No | — |

***

### suppliercredits\_list

`v12.suppliercredits_list`

Get the list of supplier credits.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   status?: string,
>   draft?: string,
>   pending_approval?: string,
>   fpaid?: string,
>   is_void?: string,
>   supplier?: string,
>   currency_code?: string,
>   documenttype?: string,
>   self_billed?: string,
>   custom_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier?: string,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   initial?: string,
>   net?: string,
>   total?: string,
>   payable?: string,
>   paid?: string,
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_mark\_void

`v12.suppliercredits_mark_void`

Mark the document as void or convert it from "void" back to "issued".

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_mark_void({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

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

**Output**

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

***

### suppliercredits\_notes\_create

`v12.suppliercredits_notes_create`

Create a new private note. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_notes_create({
	path: { parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_notes\_delete

`v12.suppliercredits_notes_delete`

Delete a private note.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_notes_delete({
	path: { id: 'demo', parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### suppliercredits\_notes\_list

`v12.suppliercredits_notes_list`

Get the list of private notes.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_notes_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `object[]`

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

***

### suppliercredits\_notes\_update

`v12.suppliercredits_notes_update`

Update a private note.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_notes_update({
	path: { id: 'demo', parent_pk: 'demo' },
	body: { notes: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   notes: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `notes` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### suppliercredits\_partial\_update

`v12.suppliercredits_partial_update`

Partially update a supplier credit. Note that you cannot delete supplier credits marked as issued (i.e. the draft field is set to false).

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   exchange_rate?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `exchange_rate` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_pdf

`v12.suppliercredits_pdf`

Get the document as PDF.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_pdf({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |
| `sizeBytes` | `number` | Yes | — |

***

### suppliercredits\_read

`v12.suppliercredits_read`

Get a single supplier credit.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### suppliercredits\_sent-email-messages\_list

`v12.suppliercredits_sent-email-messages_list`

Get the list of tracked email messages for this document.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_sent-email-messages_list({
	path: { parent_pk: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

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

> [accordion] query full type
>
> ```ts theme={null}
> {
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   from_email?: string,
>   to?: string,
>   cc?: string,
>   bcc?: string,
>   reply_to?: string,
>   subject?: string,
>   message?: string,
>   attachments?: string,
>   attach_pdf?: boolean,
>   status?: string,
>   status_updated?: string | null,
>   sent_via_smtp?: boolean,
>   smtp_error?: string,
>   smtp_error_code?: number | null,
>   metadata?: Record<string, string>,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### suppliercredits\_update

`v12.suppliercredits_update`

Update a supplier credit.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.suppliercredits_update({
	path: { id: 'demo' },
	body: {
		supplier: '3300000040000100',
		items: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   custom_id?: string,
>   representation?: string,
>   status?: string,
>   draft?: boolean,
>   documenttype?: string | null,
>   self_billed?: boolean,
>   sequence_flat?: string,
>   reference?: string,
>   date?: string,
>   branch?: string | null,
>   supplier: string,
>   supplier_display_name?: string,
>   supplier_profession?: string,
>   supplier_vat_number?: string,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   shipping_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   supplier_contact_person?: string,
>   supplier_phone_number?: string,
>   supplier_email?: string,
>   loading_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string,
>     branch_code?: number | null
>   },
>   dispatch_date?: string | null,
>   dispatch_time?: string | null,
>   vehicle_number?: string,
>   move_purpose?: number | null,
>   related_entities?: {
>     id?: string,
>     contact: string,
>     contact_display_name: string,
>     contact_vat_number?: string,
>     type: number,
>     billing_address?: {
>       address_line: string,
>       city: string,
>       state?: string,
>       zip: string,
>       country: string
>     }
>   }[] | null,
>   packages?: {
>     id?: string,
>     packaging_type: number,
>     quantity: number,
>     other_packaging_type_title?: string
>   }[] | null,
>   currency_code?: string,
>   exchange_rate?: string,
>   calculator_mode?: string,
>   items: {
>     id?: string,
>     product?: string | null,
>     description?: string,
>     quantity?: string,
>     unit_measure?: string | null,
>     unit_value?: string,
>     unit_value_gross?: string,
>     unit_discount?: string,
>     unit_discount_gross?: string,
>     unit_discount_percentage?: string,
>     unit_discount_mode?: string,
>     taxes?: {
>       tax: string,
>       auto_calculate?: boolean,
>       amount?: string,
>       vat_amount?: string,
>       auto_calculate_vat?: boolean
>     }[],
>     unit_total?: string,
>     item_net?: string,
>     project?: string | null,
>     billable?: boolean,
>     expense_category?: string | null,
>     taric_code?: string,
>     warehouse?: string | null,
>     line_type?: number | null,
>     skip_stock_update?: boolean
>   }[],
>   initial?: string,
>   net?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string
>   }[],
>   total?: string,
>   withholding_taxes?: {
>     tax: string,
>     amount?: string,
>     subtotal?: number,
>     auto_calculate?: boolean
>   }[],
>   payable?: string,
>   paid?: string,
>   template?: string | null,
>   public_notes?: string,
>   trackingcategories?: {
>     trackingcategory: string,
>     option: string
>   }[],
>   related_documents?: string[],
>   permalink?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `custom_id` | `string` | No | — |
| `representation` | `string` | No | — |
| `status` | `string` | No | — |
| `draft` | `boolean` | No | — |
| `documenttype` | `string \| null` | No | — |
| `self_billed` | `boolean` | No | — |
| `sequence_flat` | `string` | No | — |
| `reference` | `string` | No | — |
| `date` | `string` | No | — |
| `branch` | `string \| null` | No | — |
| `supplier` | `string` | No | — |
| `supplier_display_name` | `string` | No | — |
| `supplier_profession` | `string` | No | — |
| `supplier_vat_number` | `string` | No | — |
| `billing_address` | `object` | No | — |
| `shipping_address` | `object` | No | — |
| `supplier_contact_person` | `string` | No | — |
| `supplier_phone_number` | `string` | No | — |
| `supplier_email` | `string` | No | — |
| `loading_address` | `object` | No | — |
| `dispatch_date` | `string \| null` | No | — |
| `dispatch_time` | `string \| null` | No | — |
| `vehicle_number` | `string` | No | — |
| `move_purpose` | `number \| null` | No | — |
| `related_entities` | `object[] \| null` | No | — |
| `packages` | `object[] \| null` | No | — |
| `currency_code` | `string` | No | — |
| `exchange_rate` | `string` | No | — |
| `calculator_mode` | `string` | No | — |
| `items` | `object[]` | No | — |
| `initial` | `string` | No | — |
| `net` | `string` | No | — |
| `taxes` | `object[]` | No | — |
| `total` | `string` | No | — |
| `withholding_taxes` | `object[]` | No | — |
| `payable` | `string` | No | — |
| `paid` | `string` | No | — |
| `template` | `string \| null` | No | — |
| `public_notes` | `string` | No | — |
| `trackingcategories` | `object[]` | No | — |
| `related_documents` | `string[]` | No | — |
| `permalink` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] billing\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

> [accordion] shipping\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] loading\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string,
>   branch_code?: number | null
> }
> ```

> [accordion] related\_entities full type
>
> ```ts theme={null}
> {
>   id?: string,
>   contact: string,
>   contact_display_name: string,
>   contact_vat_number?: string,
>   type: number,
>   billing_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   }
> }[] | null
> ```

> [accordion] packages full type
>
> ```ts theme={null}
> {
>   id?: string,
>   packaging_type: number,
>   quantity: number,
>   other_packaging_type_title?: string
> }[] | null
> ```

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id?: string,
>   product?: string | null,
>   description?: string,
>   quantity?: string,
>   unit_measure?: string | null,
>   unit_value?: string,
>   unit_value_gross?: string,
>   unit_discount?: string,
>   unit_discount_gross?: string,
>   unit_discount_percentage?: string,
>   unit_discount_mode?: string,
>   taxes?: {
>     tax: string,
>     auto_calculate?: boolean,
>     amount?: string,
>     vat_amount?: string,
>     auto_calculate_vat?: boolean
>   }[],
>   unit_total?: string,
>   item_net?: string,
>   project?: string | null,
>   billable?: boolean,
>   expense_category?: string | null,
>   taric_code?: string,
>   warehouse?: string | null,
>   line_type?: number | null,
>   skip_stock_update?: boolean
> }[]
> ```

> [accordion] taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   auto_calculate?: boolean,
>   amount?: string
> }[]
> ```

> [accordion] withholding\_taxes full type
>
> ```ts theme={null}
> {
>   tax: string,
>   amount?: string,
>   subtotal?: number,
>   auto_calculate?: boolean
> }[]
> ```

> [accordion] trackingcategories full type
>
> ```ts theme={null}
> {
>   trackingcategory: string,
>   option: string
> }[]
> ```

***

### tasks\_create

`v12.tasks_create`

Create a new task.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.tasks_create({
	body: { name: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   hourly_rate?: string,
>   project?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   active?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `project` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |
| `active` | `boolean` | No | — |

***

### tasks\_delete

`v12.tasks_delete`

Delete a task. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.tasks_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### tasks\_list

`v12.tasks_list`

Get the list of tasks. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.tasks_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   project?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   description?: string,
>   hourly_rate?: string,
>   project?: string | null,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   active?: boolean
> }[]
> ```

***

### tasks\_read

`v12.tasks_read`

Get a single task. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.tasks_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `project` | `string \| null` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |
| `active` | `boolean` | No | — |

***

### tasks\_update

`v12.tasks_update`

Update an existing task. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.tasks_update({
	path: { id: 'demo' },
	body: { name: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   description?: string,
>   hourly_rate?: string,
>   project?: string,
>   organization?: number,
>   created?: string,
>   modified?: string,
>   active?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `description` | `string` | No | — |
| `hourly_rate` | `string` | No | — |
| `project` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |
| `active` | `boolean` | No | — |

***

### taxes\_list

`v12.taxes_list`

Get the list of taxes. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.taxes_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   operand?: string,
>   tax_type?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   tax_type?: string,
>   value_mode?: string,
>   operand?: string,
>   percentage?: string,
>   amount?: string,
>   per_unit?: boolean,
>   subject_to_vat?: boolean,
>   apply_on_document_lines?: boolean,
>   for_information_purposes?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### taxes\_read

`v12.taxes_read`

Get a single tax. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.taxes_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `title_translations` | `object` | No | — |
| `tax_type` | `string` | No | — |
| `value_mode` | `string` | No | — |
| `operand` | `string` | No | — |
| `percentage` | `string` | No | — |
| `amount` | `string` | No | — |
| `per_unit` | `boolean` | No | — |
| `subject_to_vat` | `boolean` | No | — |
| `apply_on_document_lines` | `boolean` | No | — |
| `for_information_purposes` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] title\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### templates\_list

`v12.templates_list`

Get the list of templates. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.templates_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   template?: string,
>   language?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   active?: boolean,
>   default?: boolean,
>   title?: string,
>   template?: string,
>   language?: string,
>   company_name?: string,
>   company_info?: string,
>   invoice_terms?: string,
>   creditnote_terms?: string,
>   estimate_terms?: string,
>   invoice_public_notes?: string,
>   creditnote_public_notes?: string,
>   estimate_public_notes?: string,
>   self_billed_public_notes?: string,
>   self_billed_supplier_credit_public_notes?: string,
>   deliverynote_public_notes?: string,
>   goodsreceipt_public_notes?: string,
>   slogan?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### templates\_read

`v12.templates_read`

Get a single template. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.templates_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `default` | `boolean` | No | — |
| `title` | `string` | No | — |
| `template` | `string` | No | — |
| `language` | `string` | No | — |
| `company_name` | `string` | No | — |
| `company_info` | `string` | No | — |
| `invoice_terms` | `string` | No | — |
| `creditnote_terms` | `string` | No | — |
| `estimate_terms` | `string` | No | — |
| `invoice_public_notes` | `string` | No | — |
| `creditnote_public_notes` | `string` | No | — |
| `estimate_public_notes` | `string` | No | — |
| `self_billed_public_notes` | `string` | No | — |
| `self_billed_supplier_credit_public_notes` | `string` | No | — |
| `deliverynote_public_notes` | `string` | No | — |
| `goodsreceipt_public_notes` | `string` | No | — |
| `slogan` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### timeentries\_create

`v12.timeentries_create`

Create a new time entry.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_create({
	body: { start_datetime: '2026-01-01T00:00:00Z', end_datetime: '2026-01-01T00:00:00Z', assignee: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   start_datetime: string,
>   end_datetime: string,
>   project?: string | null,
>   task?: string | null,
>   description?: string,
>   assignee: number,
>   user_team?: string | null,
>   billable?: boolean,
>   invoiceitem?: string,
>   forcibly_billed?: boolean,
>   is_billed?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `project` | `string \| null` | No | — |
| `task` | `string \| null` | No | — |
| `description` | `string` | No | — |
| `assignee` | `number` | No | — |
| `user_team` | `string \| null` | No | — |
| `billable` | `boolean` | No | — |
| `invoiceitem` | `string` | No | — |
| `forcibly_billed` | `boolean` | No | — |
| `is_billed` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### timeentries\_delete

`v12.timeentries_delete`

Delete an existing time entry.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### timeentries\_list

`v12.timeentries_list`

Get the list of time entries.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   project?: string,
>   task?: string,
>   billing_status?: string,
>   assignee?: string,
>   client?: string,
>   user_team?: string,
>   period_from?: string,
>   period_to?: string,
>   period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   start_datetime?: string,
>   end_datetime?: string,
>   duration?: number,
>   project?: string | null,
>   task?: string | null,
>   description?: string,
>   assignee?: number,
>   user_team?: string | null,
>   assignee_email?: string,
>   billable?: boolean,
>   invoiceitem?: string,
>   forcibly_billed?: boolean,
>   is_billed?: string,
>   project_billing_method?: string,
>   project_active?: string,
>   task_active?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### timeentries\_mark\_billed

`v12.timeentries_mark_billed`

Set a billed time entry as forcibly billed. Ignore already billed time entries.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_mark_billed({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### timeentries\_mark\_unbilled

`v12.timeentries_mark_unbilled`

Set a billed time entry as unbilled. Ignore already unbilled time entries.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_mark_unbilled({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### timeentries\_read

`v12.timeentries_read`

Retrieve an existing time entry.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `duration` | `number` | No | — |
| `project` | `string \| null` | No | — |
| `task` | `string \| null` | No | — |
| `description` | `string` | No | — |
| `assignee` | `number` | No | — |
| `user_team` | `string \| null` | No | — |
| `assignee_email` | `string` | No | — |
| `billable` | `boolean` | No | — |
| `invoiceitem` | `string` | No | — |
| `forcibly_billed` | `boolean` | No | — |
| `is_billed` | `string` | No | — |
| `project_billing_method` | `string` | No | — |
| `project_active` | `string` | No | — |
| `task_active` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### timeentries\_update

`v12.timeentries_update`

Update an existing time entry.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.timeentries_update({
	path: { id: 'demo' },
	body: { start_datetime: '2026-01-01T00:00:00Z', end_datetime: '2026-01-01T00:00:00Z', assignee: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   start_datetime: string,
>   end_datetime: string,
>   project?: string | null,
>   task?: string | null,
>   description?: string,
>   assignee: number,
>   user_team?: string | null,
>   billable?: boolean,
>   invoiceitem?: string,
>   forcibly_billed?: boolean,
>   is_billed?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `start_datetime` | `string` | No | — |
| `end_datetime` | `string` | No | — |
| `project` | `string \| null` | No | — |
| `task` | `string \| null` | No | — |
| `description` | `string` | No | — |
| `assignee` | `number` | No | — |
| `user_team` | `string \| null` | No | — |
| `billable` | `boolean` | No | — |
| `invoiceitem` | `string` | No | — |
| `forcibly_billed` | `boolean` | No | — |
| `is_billed` | `string` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### trackingcategories\_list

`v12.trackingcategories_list`

Get the list of tracking categories. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.trackingcategories_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   application?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   active?: boolean,
>   options?: string[],
>   application?: string[],
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### trackingcategories\_read

`v12.trackingcategories_read`

Get a single tracking category. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.trackingcategories_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `active` | `boolean` | No | — |
| `options` | `string[]` | No | — |
| `application` | `string[]` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

***

### unitofmeasurement\_create

`v12.unitofmeasurement_create`

Create a new unit of measurement.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_create({
	body: { title: 'demo', symbol: 'demo', group_id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title: string,
>   symbol: string,
>   symbol_translations?: {
>     bg?: string,
>     de?: string,
>     el?: string,
>     en?: string,
>     en-gb?: string,
>     es?: string,
>     fr?: string,
>     it?: string
>   },
>   group_id: string,
>   active?: boolean,
>   protected?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `symbol` | `string` | No | — |
| `symbol_translations` | `object` | No | — |
| `group_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `protected` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] symbol\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### unitofmeasurement\_delete

`v12.unitofmeasurement_delete`

Delete an existing unit of measurement.

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### unitofmeasurement\_list

`v12.unitofmeasurement_list`

Get list of units of measurement.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   group_id?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   symbol?: string,
>   symbol_translations?: {
>     bg?: string,
>     de?: string,
>     el?: string,
>     en?: string,
>     en-gb?: string,
>     es?: string,
>     fr?: string,
>     it?: string
>   },
>   group_id?: string,
>   active?: boolean,
>   protected?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### unitofmeasurement\_partial\_update

`v12.unitofmeasurement_partial_update`

Partially update an existing unit of measurement.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title?: string,
>   symbol?: string,
>   symbol_translations?: {
>     bg?: string,
>     de?: string,
>     el?: string,
>     en?: string,
>     en-gb?: string,
>     es?: string,
>     fr?: string,
>     it?: string
>   },
>   group_id?: string,
>   active?: boolean,
>   protected?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `symbol` | `string` | No | — |
| `symbol_translations` | `object` | No | — |
| `group_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `protected` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] symbol\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### unitofmeasurement\_read

`v12.unitofmeasurement_read`

Get a single unit of measurement.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `symbol` | `string` | No | — |
| `symbol_translations` | `object` | No | — |
| `group_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `protected` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] symbol\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### unitofmeasurement\_update

`v12.unitofmeasurement_update`

Update an existing unit of measurement.

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.unitofmeasurement_update({
	path: { id: 'demo' },
	body: { title: 'demo', symbol: 'demo', group_id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   title: string,
>   symbol: string,
>   symbol_translations?: {
>     bg?: string,
>     de?: string,
>     el?: string,
>     en?: string,
>     en-gb?: string,
>     es?: string,
>     fr?: string,
>     it?: string
>   },
>   group_id: string,
>   active?: boolean,
>   protected?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `title` | `string` | No | — |
| `symbol` | `string` | No | — |
| `symbol_translations` | `object` | No | — |
| `group_id` | `string` | No | — |
| `active` | `boolean` | No | — |
| `protected` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] symbol\_translations full type
>
> ```ts theme={null}
> {
>   bg?: string,
>   de?: string,
>   el?: string,
>   en?: string,
>   en-gb?: string,
>   es?: string,
>   fr?: string,
>   it?: string
> }
> ```

***

### users\_list

`v12.users_list`

Get the list of organization users.

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.users_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   user_id?: string,
>   first_name?: string,
>   last_name?: string,
>   email?: string,
>   active?: boolean,
>   created?: string
> }[]
> ```

***

### userteams\_list

`v12.userteams_list`

Get the list of user teams. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.userteams_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   team_name?: string,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### warehouse\_create

`v12.warehouse_create`

Create a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_create({
	body: {
		name: 'demo',
		warehouse_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   warehouse_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_delete

`v12.warehouse_delete`

Delete a warehouse. ---

**Risk:** `destructive`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_delete({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output:** `undefined`

***

### warehouse\_list

`v12.warehouse_list`

Get the list of warehouses. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `object` | No | — |
| `demo` | `boolean` | No | — |

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ordering?: string,
>   search?: string,
>   search_fields?: string,
>   active?: string,
>   created_after?: string,
>   created_before?: string,
>   modified_after?: string,
>   modified_before?: string,
>   modified_period?: string,
>   created_period?: string,
>   page?: number,
>   page_size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `count` | `number` | Yes | — |
| `next` | `string \| null` | No | — |
| `previous` | `string \| null` | No | — |
| `results` | `object[]` | Yes | — |

> [accordion] results full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   warehouse_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }[]
> ```

***

### warehouse\_partial\_update

`v12.warehouse_partial_update`

Partially update a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_partial_update({
	path: { id: 'demo' },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name?: string,
>   warehouse_address?: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_read

`v12.warehouse_read`

Get a single warehouse. ---

**Risk:** `read`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_read({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***

### warehouse\_update

`v12.warehouse_update`

Update a warehouse. ---

**Risk:** `write`

```ts theme={null}
await corsair.elorus.api.v12.warehouse_update({
	path: { id: 'demo' },
	body: {
		name: 'demo',
		warehouse_address: {
			address_line: '4 Catherine St.',
			city: 'Southaven',
			zip: '38671',
			country: 'US',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `body` | `object` | Yes | — |
| `demo` | `boolean` | No | — |

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

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: string,
>   name: string,
>   warehouse_address: {
>     address_line: string,
>     city: string,
>     state?: string,
>     zip: string,
>     country: string
>   },
>   default?: boolean,
>   active?: boolean,
>   organization?: number,
>   created?: string,
>   modified?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | No | — |
| `name` | `string` | No | — |
| `warehouse_address` | `object` | No | — |
| `default` | `boolean` | No | — |
| `active` | `boolean` | No | — |
| `organization` | `number` | No | — |
| `created` | `string` | No | — |
| `modified` | `string` | No | — |

> [accordion] warehouse\_address full type
>
> ```ts theme={null}
> {
>   address_line: string,
>   city: string,
>   state?: string,
>   zip: string,
>   country: string
> }
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.