---
canonical_url: "https://docs.composio.dev/toolkits/bexio"
markdown_url: "https://docs.composio.dev/toolkits/bexio.md"
product: "platform"
version: null
last_updated: null
---

# bexio

bexio is a Swiss business management platform for accounting, invoicing, contacts, projects, banking, expenses, and payroll.

- **Category:** accounting
- **Auth:** OAUTH2, BEARER_TOKEN
- **Composio-managed OAuth available?** No
- **Tools:** 309
- **Triggers:** 0
- **Slug:** `BEXIO`
- **Version:** 00000000_00

## Tools

### Accept Quote

**Slug:** `BEXIO_ACCEPT_QUOTE`

Accept a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Project

**Slug:** `BEXIO_ARCHIVE_PROJECT`

Archive a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Invoice

**Slug:** `BEXIO_CANCEL_INVOICE`

Cancel an invoice. Applies the state-changing action immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Payment

**Slug:** `BEXIO_CANCEL_PAYMENT`

Cancel a payment. Applies the state-changing action immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | string | Yes | The payment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Bill Document Number

**Slug:** `BEXIO_CHECK_BILL_DOCUMENT_NUMBER`

Validate whether document number is available or not.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_no` | string | Yes | document number to validate |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Expense Document Number

**Slug:** `BEXIO_CHECK_EXPENSE_DOCUMENT_NUMBER`

Validate whether document number is available or not.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_no` | string | Yes | document number to validate |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Invoice

**Slug:** `BEXIO_COPY_INVOICE`

Copy a invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `contact_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |
| `invoice_id` | integer | Yes | the id of the invoice |
| `is_valid_from` | string | No | The is valid from. |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Quote

**Slug:** `BEXIO_COPY_QUOTE`

Copy a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `quote_id` | integer | Yes | the id of the quote |
| `contact_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Additional Address

**Slug:** `BEXIO_CREATE_ADDITIONAL_ADDRESS`

Create additional address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | The city. |
| `name` | string | No | The name. |
| `subject` | string | No | The subject. |
| `postcode` | string | No | The postcode. |
| `contact_id` | integer | Yes | the id of the contact |
| `country_id` | integer | No | References a [country object](#operation/v2ListCountries) |
| `description` | string | No | The description. |
| `street_name` | string | No | Is required if `house_number` or `address_addition` are not **NULL** |
| `house_number` | string | No | Requires `street_name` if the value is not **NULL** |
| `name_addition` | string | No | The name addition. |
| `address_addition` | string | No | Requires `street_name` if the value is not **NULL** |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bill

**Slug:** `BEXIO_CREATE_BILL`

Create new Bill.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `address` | object | Yes | Address |
| `payment` | object | No | The payment. |
| `due_date` | string | Yes | The due date. |
| `item_net` | boolean | Yes | Indicates whether 'amount' in 'line_items' is net or gross. |
| `bill_date` | string | Yes | The bill date. |
| `discounts` | array | Yes | The discounts. |
| `amount_man` | number | No | Required when 'manual_amount' is true. Maximum of 17 digits and maximum of 2 decimal digits. |
| `line_items` | array | Yes | The line items. |
| `vendor_ref` | string | No | The vendor ref. |
| `amount_calc` | number | No | Required when 'manual_amount' is false. Maximum of 17 digits and maximum of 2 decimal digits. |
| `supplier_id` | integer | Yes | The supplier id. |
| `currency_code` | string | Yes | The currency code. |
| `exchange_rate` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits. |
| `manual_amount` | boolean | Yes | indicates whether 'amount_man' or 'amount_calc' is required and considered as bill amount |
| `attachment_ids` | array | Yes | The attachment ids. |
| `purchase_order_id` | integer | No | The purchase order id. |
| `contact_partner_id` | integer | Yes | The contact partner id. |
| `qr_bill_information` | string | No | The qr bill information. |
| `base_currency_amount` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 17 digits and maximum of 2 decimal digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Business Activity

**Slug:** `BEXIO_CREATE_BUSINESS_ACTIVITY`

Create business activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `account_id` | integer | No | References an [account object](#operation/ListAccounts) |
| `default_is_billable` | boolean | No | The default is billable. |
| `default_price_per_hour` | number | No | The default price per hour. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Calendar Year

**Slug:** `BEXIO_CREATE_CALENDAR_YEAR`

Create calendar year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | string | No | The year for which we want to create an entry. It is possible to create years 10 years ahead and higher than 2016 year. If it is a future year, we generate all in between with the settings the user has chosen. |
| `is_vat_subject` | boolean | No | Determines if the calendar year is vat subjected or not. |
| `is_annual_reporting` | boolean | No | Determines if the calendar year has annual reporting enabled. |
| `vat_accounting_type` | string ("agreed" | "collected") | No | Vat accounting type. |
| `default_tax_income_id` | integer | No | Determine default tax ID for income. References a [tax object](#operation/ListTaxes) |
| `vat_accounting_method` | string ("effective" | "net_tax") | No | Vat accounting method. |
| `default_tax_expense_id` | integer | No | Determine default tax ID for expense. Tax ID is not required if the client has the plan bexio mini. In this case, the year is created with the tax ID from the previous year. References a [tax object](#operation/ListTaxes). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Comment

**Slug:** `BEXIO_CREATE_COMMENT`

Create a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text. |
| `user_id` | string | Yes | References a [user object](#operation/v3ListUsers) |
| `is_public` | boolean | No | The is public. |
| `user_name` | string | Yes | The user name. |
| `user_email` | string | No | The user email. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Comments can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `BEXIO_CREATE_CONTACT`

Create contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | The fax. |
| `url` | string | No | The url. |
| `city` | string | No | The city. |
| `mail` | string | No | The mail. |
| `name_1` | string | Yes | This field is used as the company name if the field `contact_type_id` is set to `1`. Otherwise, the field is used as the last name of the person |
| `name_2` | string | No | This field is used as the company addition if the field `contact_type_id` is set to `1`. Otherwise, the field is used as the first name of the person |
| `remarks` | string | No | The remarks. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `birthday` | string | No | The birthday. |
| `owner_id` | integer | Yes | The owner id. |
| `postcode` | string | No | The postcode. |
| `title_id` | integer | No | References a [title object](#operation/v2ListTitles) |
| `country_id` | integer | No | References a [country object](#operation/v2ListCountries) |
| `skype_name` | string | No | The skype name. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mail_second` | string | No | The mail second. |
| `phone_fixed` | string | No | The phone fixed. |
| `street_name` | string | No | Is required if `house_number` or `address_addition` are not **NULL** |
| `house_number` | string | No | Requires `street_name` if the value is not **NULL** |
| `phone_mobile` | string | No | The phone mobile. |
| `salutation_id` | integer | No | References a [salutation object](#operation/v2ListSalutations) |
| `contact_number` | string | No | Contact number. Omit it to let bexio assign the number automatically; when supplied, use numeric text. |
| `contact_type_id` | integer | Yes | Please use the value `1` for companies or `2` for persons |
| `salutation_form` | integer | No | The salutation form. |
| `address_addition` | string | No | Requires `street_name` if the value is not **NULL** |
| `contact_group_ids` | string | No | References one ore multiple [contact group objects](#operation/v2ListContactGroups) |
| `contact_branch_ids` | string | No | References one ore multiple [contact sector objects](#operation/v2ListContactSectors) |
| `phone_fixed_second` | string | No | The phone fixed second. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Group

**Slug:** `BEXIO_CREATE_CONTACT_GROUP`

Create contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Relation

**Slug:** `BEXIO_CREATE_CONTACT_RELATION`

Create contact relation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |
| `description` | string | No | The description. |
| `contact_sub_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contacts Bulk

**Slug:** `BEXIO_CREATE_CONTACTS_BULK`

Bulk create contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | No | Items for the request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Country

**Slug:** `BEXIO_CREATE_COUNTRY`

Create country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `name_short` | string | Yes | The name short. |
| `iso3166_alpha2` | string | Yes | The iso3166 alpha2. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Currency

**Slug:** `BEXIO_CREATE_CURRENCY`

Create a currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A name of the currency. Must be in the format "ISO 4217" and must be unique. |
| `round_factor` | number | Yes | The round factor of the currency. E.g.: In order to round CHF to 5 Rp. the round_factor must be set to 0.05 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Default Position

**Slug:** `BEXIO_CREATE_DEFAULT_POSITION`

Create a default position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `amount` | string | No | The amount. |
| `tax_id` | integer | No | References a [tax object](#operation/ListTaxes) Please note that only active sales taxes can be used as references on the document types `quote`, `order` and `invoice`. An easy way to retrieve all valid taxes is by calling the taxes endpoint with the query parameters `types=sales_tax&scope=active` (this would result in the path `/3.0/taxes?types=sales_tax&scope=active`). |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `account_id` | integer | No | References an [account object](#operation/ListAccounts) |
| `unit_price` | string | No | The price of one unit (max. 6 decimals) |
| `amount_open` | string | No | The amount open. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `is_optional` | boolean | No | Only in the case of quotes or Orders |
| `amount_reserved` | string | No | The amount reserved. |
| `amount_completed` | string | No | The amount completed. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Default positions can be added to quotes, orders and invoices |
| `discount_in_percent` | string | No | The discount (max. 6 decimals) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Delivery From Order

**Slug:** `BEXIO_CREATE_DELIVERY_FROM_ORDER`

Create delivery from order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |
| `positions` | array | No | Please note that the positions array can be omitted to create a document with all positions from the source document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount Position

**Slug:** `BEXIO_CREATE_DISCOUNT_POSITION`

Create a discount position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `value` | string | No | The value. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `is_percentual` | boolean | No | The is percentual. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Discount positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee

**Slug:** `BEXIO_CREATE_EMPLOYEE`

Create employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iban` | string | No | The iban. |
| `email` | string | No | The email. |
| `gender` | string ("male" | "female") | No | The gender. |
| `address` | object | No | The address. |
| `language` | string ("de" | "it" | "fr" | "en") | No | The language. |
| `last_name` | string | No | The last name. |
| `ahv_number` | string | No | The ahv number. |
| `first_name` | string | No | The first name. |
| `nationality` | string | No | Nation should be in ISO Alpha-2 format. Special values: '11' means 'unknown', '22' means 'stateless'. |
| `phone_number` | string | No | The phone number. |
| `date_of_birth` | string | No | The date of birth. |
| `marital_status` | string ("unknown" | "single" | "married" | "separated" | "registered_partnership" | "partnership_dissolved_by_law" | "partnership_dissolved_by_death" | "partnership_dissolved_by_declaration_of_lost" | "widowed" | "divorced") | No | The marital status. |
| `personal_number` | string | No | The personal number. |
| `annual_vacation_days` | integer | No | The annual vacation days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Absence

**Slug:** `BEXIO_CREATE_EMPLOYEE_ABSENCE`

Create absence for employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | Yes | Currently supported reasons: Injury, Sickness, MaternityLeave, MilitaryLeave, Vacation, InterruptionOfWork. New reasons might be added in the future. |
| `end_date` | string | No | The end date. |
| `half_day` | boolean | No | The half day. |
| `disability` | number | No | The disability. |
| `paid_hours` | number | No | The paid hours. |
| `start_date` | string | Yes | The start date. |
| `employee_id` | string | Yes | Id of an employee |
| `continued_pay` | number | No | The continued pay. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Expense

**Slug:** `BEXIO_CREATE_EXPENSE`

Create new Expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `amount` | number | Yes | Maximum of 17 digits and maximum of 2 decimal digits. |
| `tax_id` | integer | No | The tax id. |
| `address` | object | No | Address |
| `paid_on` | string | Yes | The paid on. |
| `supplier_id` | integer | No | The supplier id. |
| `currency_code` | string | Yes | The currency code. |
| `exchange_rate` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits. |
| `attachment_ids` | array | Yes | List of file ids that should be attached to this Expense. Cannot have duplicates. |
| `bank_account_id` | integer | No | The bank account id. |
| `booking_account_id` | integer | No | The booking account id. |
| `base_currency_amount` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 17 digits and maximum of 2 decimal digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Fictional User

**Slug:** `BEXIO_CREATE_FICTIONAL_USER`

Create a fictional user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the fictional user. Please note that an email address can only be used once for both regular and fictional users. |
| `lastname` | string | Yes | The last name of the fictional user |
| `title_id` | integer | No | A reference to a title |
| `firstname` | string | Yes | The first name of the fictional user |
| `salutation_type` | string ("male" | "female") | Yes | The salutation type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create File

**Slug:** `BEXIO_CREATE_FILE`

Create new file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invoice

**Slug:** `BEXIO_CREATE_INVOICE`

Create invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `mwst_type` | integer ("0" | "1" | "2") | No | | value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |  |
| `positions` | array | No | Please note that you can combine multiple positions. This means that an array containing `KbPositionCustom` and `KbPositionArticle` positions is valid.  **Recommendation**: use a maximum of 150 positions when creating sales documents. Other positions can be added using the item creation endpoint.  |
| `reference` | string | No | The reference. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784 |
| `is_valid_to` | string | No | The is valid to. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invoice From Order

**Slug:** `BEXIO_CREATE_INVOICE_FROM_ORDER`

Create invoice from order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |
| `positions` | array | No | Please note that the positions array can be omitted to create a document with all positions from the source document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invoice From Quote

**Slug:** `BEXIO_CREATE_INVOICE_FROM_QUOTE`

Create invoice from quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |
| `positions` | array | No | Please note that the positions array can be omitted to create a document with all positions from the source document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invoice Payment

**Slug:** `BEXIO_CREATE_INVOICE_PAYMENT`

Create payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | The date. |
| `value` | string | Yes | The value. |
| `invoice_id` | integer | Yes | the id of the invoice |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_service_id` | integer ("1" | "2" | "3") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 1 &#124; PayPal &#124; &#124; 2 &#124; Stripe &#124; &#124; 3 &#124; SIX Payments &#124;  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invoice Reminder

**Slug:** `BEXIO_CREATE_INVOICE_REMINDER`

Create reminder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item

**Slug:** `BEXIO_CREATE_ITEM`

Create item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | integer | No | The width. |
| `height` | integer | No | The height. |
| `volume` | integer | No | The volume. |
| `weight` | integer | No | The weight. |
| `remarks` | string | No | The remarks. |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) (Currently, it has no impact, regardless of which user_id is sent.) |
| `is_stock` | boolean | No | Requires `stock_edit` scope to work. |
| `stock_id` | integer | No | References a [stock location object](#operation/v2ListStockLocations) |
| `stock_nr` | integer | No | Please note that the stock number can only be set if no bookings for this product have been made. |
| `html_text` | string | No | The html text. |
| `account_id` | integer | No | References an [account object](#operation/v2ListAccounts) |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `sale_price` | string | No | The sale price. |
| `sale_total` | number | No | The sale total. |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `intern_code` | string | No | The intern code. |
| `intern_name` | string | No | The intern name. |
| `stock_min_nr` | integer | No | The stock min nr. |
| `tax_income_id` | integer | No | References a [tax object](#operation/ListTaxes) |
| `deliverer_code` | string | No | The deliverer code. |
| `deliverer_name` | string | No | The deliverer name. |
| `delivery_price` | number | No | The delivery price. |
| `purchase_price` | string | No | The purchase price. |
| `purchase_total` | number | No | The purchase total. |
| `stock_place_id` | integer | No | References a [stock area object](#operation/v2ListStockAreas) |
| `tax_expense_id` | integer | No | References a [tax object](#operation/ListTaxes) |
| `article_type_id` | integer | No | Please use the value `1` for physical products or `2` for services |
| `article_group_id` | integer | No | The article group id. |
| `expense_account_id` | integer | No | References an [account object](#operation/v2ListAccounts) |
| `intern_description` | string | No | The intern description. |
| `deliverer_description` | string | No | The deliverer description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Position

**Slug:** `BEXIO_CREATE_ITEM_POSITION`

Create an item position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `amount` | string | No | The amount. |
| `tax_id` | integer | No | References a [tax object](#operation/ListTaxes)  Please note that only active sales taxes can be used as references on the document types `quote`, `order` and `invoice`. An easy way to retrieve all valid taxes is by calling the taxes endpoint with the query parameters `types=sales_tax&scope=active` (this would result in the path `/3.0/taxes?types=sales_tax&scope=active`).  |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `account_id` | integer | No | References an [account object](#operation/ListAccounts) |
| `article_id` | integer | No | References an [item object](#operation/v2ListItems) |
| `unit_price` | string | No | The price of one unit (max. 6 decimals) |
| `amount_open` | string | No | The amount open. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `is_optional` | boolean | No | Only valid in the case of Quotes or Orders |
| `amount_reserved` | string | No | The amount reserved. |
| `amount_completed` | string | No | The amount completed. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |
| `discount_in_percent` | string | No | The discount (max. 6 decimals) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Manual Entry

**Slug:** `BEXIO_CREATE_MANUAL_ENTRY`

Create manual entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | the booking date |
| `type` | string ("manual_single_entry" | "manual_compound_entry" | "manual_group_entry") | Yes | Choose one of the following three types:<br><br> **manual_single_entry**<br> Can be used to create a simple one line booking such as:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124; 3200 &#124; 13600 &#124;  **manual_compound_entry** <br> Can be used to create a more complex booking where the total amount can be distributed among multiple accounts. The following example shows how a received bank transaction can be booked on multiple accounts:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124;  &#124; 25000 &#124; &#124; &#124; 3200 &#124; 10000 &#124; &#124; &#124; 3201 &#124; 8000 &#124; &#124; &#124; 3202 &#124; 7000 &#124;  **manual_group_entry** <br> Can be used to create multiple one line bookings in one group entry. This means that the bookings will have the same `reference_nr` but can differ in accounts, currencies, etc. The following example shows how two received bank transaction can be booked on different accounts:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124; 3200 &#124; 13600 &#124; &#124; 1021 &#124; 3201 &#124; 7230 &#124;  |
| `entries` | array | Yes | The entries. |
| `reference_nr` | string | No | A reference number for the booking |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Milestone

**Slug:** `BEXIO_CREATE_MILESTONE`

Create milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the milestone |
| `comment` | string | No | Description for milestone |
| `end_date` | string | No | The end date for the milestone |
| `project_id` | integer | Yes | the id of the project |
| `pr_parent_milestone_id` | integer | No | Higher level milestone |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Note

**Slug:** `BEXIO_CREATE_NOTE`

Create note.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `info` | string | No | The info. |
| `subject` | string | Yes | The subject. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `entry_id` | integer | No | The entry id. |
| `module_id` | integer | No | The module id. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `event_start` | string | Yes | The event start. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `BEXIO_CREATE_ORDER`

Create order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `mwst_type` | integer ("0" | "1" | "2") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 0 &#124; including taxes &#124; &#124; 1 &#124; excluding taxes &#124; &#124; 2 &#124; exempt from taxes &#124; |
| `positions` | array | No | Please note that you can combine multiple positions. This means that an array containing `KbPositionCustom` and `KbPositionArticle` positions is valid. **Recommendation**: use a maximum of 150 positions when creating sales documents. Other positions can be added using the item creation endpoint. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784 |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `delivery_address_type` | integer ("0" | "1") | No | &#124; value &#124; description &#124; &#124;-------&#124;-------------&#124; &#124; 0 &#124; use invoice address &#124; &#124; 1 &#124; use custom address &#124; |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |
| `delivery_address_manual` | string | No | This field can be used to set a delivery address manually if `delivery_address_type` is set to `1`. If not in use or `null` the invoice address will be taken. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order From Quote

**Slug:** `BEXIO_CREATE_ORDER_FROM_QUOTE`

Create order from quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |
| `positions` | array | No | Please note that the positions array can be omitted to create a document with all positions from the source document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Outgoing Payment

**Slug:** `BEXIO_CREATE_OUTGOING_PAYMENT`

Create new Outgoing Payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Not allowed for IBAN, QR. |
| `amount` | number | Yes | Must be less or equal to Bill's 'pending_amount'. Maximum of 17 digits and maximum of 2 decimal digits. |
| `bill_id` | string | Yes | Payment can be created only for Bill that is not in status DRAFT. |
| `message` | string | No | Not allowed for QR, MANUAL, CASH_DISCOUNT. |
| `fee_type` | string ("BY_SENDER" | "BY_RECEIVER" | "BREAKDOWN" | "NO_FEE") | No | Required for IBAN. Not allowed for QR, MANUAL, CASH_DISCOUNT. Must be set to NO_FEE when 'receiver_iban' is a domestic IBAN (same country as 'sender_bank_account_id' Bank Account IBAN country). Cannot be set to NO_FEE when 'receiver_iban' is not a domestic IBAN. |
| `sender_city` | string | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. |
| `sender_iban` | string | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. |
| `sender_name` | string | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. |
| `booking_text` | string | No | Not allowed for MANUAL, CASH_DISCOUNT. |
| `payment_type` | string ("IBAN" | "MANUAL" | "CASH_DISCOUNT" | "QR") | Yes | Bill's amount cannot be covered only by CASH_DISCOUNT payments. |
| `reference_no` | string | No | Not allowed for IBAN, MANUAL, CASH_DISCOUNT. For QR, when 'receiver_iban' is QR Iban then 'reference_no' must be valid Isr Account number. For QR, when 'receiver_iban' is not QR Iban then 'reference_no' must be valid Creaditor Reference. |
| `sender_bc_no` | string | No | Not allowed for CASH_DISCOUNT. |
| `currency_code` | string | Yes | Must be equal to Bill's 'currency_code'. Only 'CHF' and 'EUR' is allowed for QR. |
| `exchange_rate` | number | Yes | Maximum of 5 digits and maximum of 10 decimal digits. |
| `receiver_city` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_iban` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. Must be valid Iban for IBAN Payment or must be valid QR Iban for QR Payment. |
| `receiver_name` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `sender_street` | string | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. |
| `execution_date` | string | Yes | Must be after or equal to Bill's 'bill_date'. Cannot be in CLOSED or LOCKED Business Year. Must be in existing Business Year. For IBAN and QR must be in present or future and cannot be on the weekend. |
| `receiver_bc_no` | string | No | Not allowed for MANUAL, CASH_DISCOUNT. |
| `sender_bank_no` | string | No | Not allowed for CASH_DISCOUNT. |
| `receiver_street` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `sender_house_no` | string | No | Not allowed for CASH_DISCOUNT. |
| `sender_postcode` | string | No | Required for IBAN, QR. Not allowed for CASH_DISCOUNT. |
| `receiver_bank_no` | string | No | Not allowed for MANUAL, CASH_DISCOUNT. |
| `sender_bank_name` | string | No | Not allowed for CASH_DISCOUNT. |
| `is_salary_payment` | boolean | Yes | Allowed to be set to true only for IBAN. |
| `receiver_house_no` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_postcode` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_bank_name` | string | No | Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_account_no` | string | No | Not allowed for IBAN, QR, MANUAL, CASH_DISCOUNT. |
| `sender_country_code` | string | No | Not allowed for CASH_DISCOUNT. |
| `receiver_country_code` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `sender_bank_account_id` | integer | Yes | Required for IBAN, MANUAL, QR. Not allowed for CASH_DISCOUNT. For [IBAN, QR] it must be Bank Account with type 'bank'. For MANUAL it could be Bank Account with type 'bank' or 'cash'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Pagebreak Position

**Slug:** `BEXIO_CREATE_PAGEBREAK_POSITION`

Create a pagebreak position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pagebreak` | boolean | No | The pagebreak. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Pagebreak positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Payment

**Slug:** `BEXIO_CREATE_PAYMENT`

Create a payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("iban" | "qr") | Yes | Type of the payment. Each payment requires different fields |
| `amount` | number | Yes | The amount (decimal number) to send in the chosen currency. The amount may be exchanged by the bank if a currency is different from the currency of an account |
| `message` | string | No | Multiline description of the payment |
| `currency` | string | Yes | Currency in which send a payment, according to ISO 4217 |
| `allowance` | string ("fee_paid_by_payer" | "fee_paid_by_payee" | "fee_split" | "no_fee") | No | For payments to other countries or with different currencies |
| `is_salary` | string | Yes | If it is a salary payment |
| `recipient` | object | Yes | The recipient. |
| `account_id` | string | Yes | The account id. |
| `execution_date` | string | Yes | Date according to ISO 8601. Execution date of a payment (when the payment should be carried out by the bank), should be at least the next working day |
| `purchase_reference` | object | No | The purchase reference. |
| `qr_reference_number` | string | No | A QR reference number or creditor reference number. |
| `is_editing_restricted` | boolean | No | If set to true, editing will be restricted to the api client id which created the payment |
| `additional_information` | string | No | Additional information on the payment slip |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `BEXIO_CREATE_PROJECT`

Create project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `comment` | string | No | The comment. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `end_date` | string | No | The end date. |
| `contact_id` | integer | Yes | References a [contact object](#operation/v2ListContacts) |
| `start_date` | string | No | The start date. |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001721 |
| `pr_state_id` | integer | Yes | References a [project status object](#operation/v2ListProjectStatus) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `pr_budget_type_id` | number | No | The following budget types are available: &#124; Id &#124; Name &#124; Description &#124; &#124; ------ &#124; ------ &#124; ------ &#124; &#124; 1 &#124; type_budgeted_costs &#124; Total budget costs &#124; &#124; 2 &#124; type_budgeted_hours &#124; Total budget hours &#124; &#124; 3 &#124; type_service_budget &#124; Budget for each client services &#124; &#124; 4 &#124; type_service_employees &#124; Budget for each employee &#124; |
| `pr_invoice_type_id` | integer | No | The following invoice types are available: &#124; Id &#124; Name &#124; Description &#124; &#124; ------ &#124; ------ &#124; ------ &#124; &#124; 1 &#124; type_hourly_rate_service &#124; Hourly rate for client services &#124; &#124; 2 &#124; type_hourly_rate_employee &#124; Hourly rate for employee &#124; &#124; 3 &#124; type_hourly_rate_project &#124; Hourly rate for project &#124; &#124; 4 &#124; type_fix &#124; Fix price for project &#124; |
| `pr_project_type_id` | integer | Yes | References a [project type object](#operation/v2ListProjectType) |
| `pr_budget_type_amount` | string | No | This field can only be edited if the `pr_budget_type` is set. (Only supported for budget types: `type_budgeted_costs` and `type_budgeted_hours`) |
| `pr_invoice_type_amount` | string | No | This field can only be edited if the `pr_invoice_type` is set. (Only supported for invoice types: `type_hourly_rate_project` and `type_fix`) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Purchase Order

**Slug:** `BEXIO_CREATE_PURCHASE_ORDER`

Create a purchase order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The id of the purchase order |
| `mail` | string | No | The mail address of the company |
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `currency` | object | No | The currency. |
| `language` | object | No | The language. |
| `mwst_type` | string ("included" | "excluded" | "exempt") | No | Possible values are  * `included` - included means that the tax is included in the total price  * `excluded` - excluded means that the tax is excluded from the total price  * `exempt` - exempt means that no tax is charged  |
| `positions` | object | No | A purchase order can have multiple line items (positions). Please note that the line items must be grouped by required, optional and discount positions.  |
| `reference` | string | No | A reference which can be added to the document by the client. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `created_at` | string | No | Creation date of the purchase order |
| `project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `updated_at` | string | No | Last time when purchase order was updated |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `date_format` | string | No | The date format. |
| `document_nr` | string | No | The document nr. |
| `is_valid_to` | string | No | The is valid to. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `template_slug` | string | No | The template slug. |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `is_valid_until` | string | No | The is valid until. |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `is_compact_view` | boolean | No | The is compact view. |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `salesman_user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `nb_decimals_price` | integer | No | The maximum number of decimal digits to display for prices (line item prices, totals, etc.). |
| `nb_decimals_amount` | integer | No | The maximum number of decimal digits to display for amounts (number of items). |
| `custom_translations` | object | No | The custom translations. |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `delivery_address_type` | string ("contact_address" | "manual") | No | The delivery address type. |
| `terms_of_payment_text` | string | No | Additional text which is displayed below the terms of payment |
| `contact_address_manual` | string | No | The contact address for the document. Newlines are in the format `\n` |
| `kb_payment_template_id` | integer | No | The kb payment template id. |
| `delivery_address_manual` | string | No | The delivery address for order. Newlines are in the format `\n` |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Quote

**Slug:** `BEXIO_CREATE_QUOTE`

Create quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `mwst_type` | integer ("0" | "1" | "2") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 0 &#124; including taxes &#124; &#124; 1 &#124; excluding taxes &#124; &#124; 2 &#124; exempt from taxes &#124;  |
| `positions` | array | No | Please note that you can combine multiple positions. This means that an array containing `KbPositionCustom` and `KbPositionArticle` positions is valid.  **Recommendation**: use a maximum of 150 positions when creating sales documents. Other positions can be added using the item creation endpoint.  |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if automatic numbering is activated in frontend-settings. Required if automatic numbering deactivated. https://help.bexio.com/s/article/000001784 |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `is_valid_until` | string | No | The is valid until. |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `viewed_by_client_at` | string | No | The viewed by client at. |
| `delivery_address_type` | integer ("0" | "1") | No | &#124; value &#124; description &#124; &#124;-------&#124;-------------&#124; &#124;   0   &#124; use invoice address &#124; &#124;   1   &#124; use custom address &#124;  |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |
| `delivery_address_manual` | string | No | This field can be used to set a delivery address manually if `delivery_address_type` is set to `1`. If not in use or `null` the invoice address will be taken. |
| `kb_terms_of_payment_template_id` | integer | No | The kb terms of payment template id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Salutation

**Slug:** `BEXIO_CREATE_SALUTATION`

Create salutation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subposition Position

**Slug:** `BEXIO_CREATE_SUBPOSITION_POSITION`

Create a sub position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `show_pos_nr` | boolean | No | The show pos nr. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Sub positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subtotal Position

**Slug:** `BEXIO_CREATE_SUBTOTAL_POSITION`

Create a subtotal position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Subtotal positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task

**Slug:** `BEXIO_CREATE_TASK`

Create task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `info` | string | No | The info. |
| `subject` | string | Yes | The subject. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `entry_id` | integer | No | The entry id. |
| `module_id` | integer | No | The module id. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `finish_date` | string | No | The finish date. |
| `have_remember` | boolean | No | The have remember. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `sub_contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `todo_status_id` | integer | No | The todo status id. |
| `remember_time_id` | integer | No | Is required if `have_remember` is set to true. |
| `remember_type_id` | integer | No | Is required if `have_remember` is set to true. |
| `todo_priority_id` | integer | No | The todo priority id. |
| `communication_kind_id` | integer | No | The communication kind id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Text Position

**Slug:** `BEXIO_CREATE_TEXT_POSITION`

Create a text position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `show_pos_nr` | boolean | No | The show pos nr. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Text positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Timesheet

**Slug:** `BEXIO_CREATE_TIMESHEET`

Create timesheet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `charge` | string | No | The charge. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `tracking` | object | Yes | Two different formats can be used to submit the tracked time. Either type `range` or type `duration`. |
| `status_id` | integer | No | References a [timesheet status object](#operation/v2ListTimeSheetStatus) |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `pr_package_id` | integer | No | The pr package id. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `allowable_bill` | boolean | Yes | The allowable bill. |
| `estimated_time` | string | No | The estimated time. |
| `sub_contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `pr_milestone_id` | integer | No | The pr milestone id. |
| `client_service_id` | integer | Yes | References a [business activity object](#operation/v2ListBusinessActivities) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Title

**Slug:** `BEXIO_CREATE_TITLE`

Create title.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Unit

**Slug:** `BEXIO_CREATE_UNIT`

Create unit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Work Package

**Slug:** `BEXIO_CREATE_WORK_PACKAGE`

Create work package.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the work package |
| `comment` | string | No | Description for work package |
| `project_id` | integer | Yes | the id of the project |
| `pr_milestone_id` | integer | No | References a [milestone object](#operation/ListMilestones) |
| `spent_time_in_hours` | number | No | time spent on work package |
| `estimated_time_in_hours` | number | No | estimated time on work package |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decline Quote

**Slug:** `BEXIO_DECLINE_QUOTE`

Decline a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Additional Address

**Slug:** `BEXIO_DELETE_ADDITIONAL_ADDRESS`

Delete an additional address. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | the id of the contact |
| `additional_address_id` | integer | Yes | the id of the additional address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bill

**Slug:** `BEXIO_DELETE_BILL`

Delete Bill. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Bill to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `BEXIO_DELETE_CONTACT`

Delete a contact. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | the id of the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact Group

**Slug:** `BEXIO_DELETE_CONTACT_GROUP`

Delete a contact group. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_group_id` | integer | Yes | the id of the contact group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact Relation

**Slug:** `BEXIO_DELETE_CONTACT_RELATION`

Delete a contact relation. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_relation_id` | integer | Yes | the id of the contact relation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Country

**Slug:** `BEXIO_DELETE_COUNTRY`

Delete a country. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_id` | integer | Yes | the id of the country |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Currency

**Slug:** `BEXIO_DELETE_CURRENCY`

Delete a currency. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency_id` | integer | Yes | the id of the currency |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Default Position

**Slug:** `BEXIO_DELETE_DEFAULT_POSITION`

Delete a default position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Default positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount Position

**Slug:** `BEXIO_DELETE_DISCOUNT_POSITION`

Delete a discount position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Discount positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Employee Absence

**Slug:** `BEXIO_DELETE_EMPLOYEE_ABSENCE`

Deleting employee absence with given id. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `absence_id` | string | Yes | Id of an absence |
| `employee_id` | string | Yes | Id of an employee |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Expense

**Slug:** `BEXIO_DELETE_EXPENSE`

Delete Expense. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Expense to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Fictional User

**Slug:** `BEXIO_DELETE_FICTIONAL_USER`

Delete a fictional user. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fictional_user_id` | integer | Yes | the id of the fictional user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete File

**Slug:** `BEXIO_DELETE_FILE`

Delete a existing file. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | File ID to show |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Invoice

**Slug:** `BEXIO_DELETE_INVOICE`

Delete an invoice. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Invoice Payment

**Slug:** `BEXIO_DELETE_INVOICE_PAYMENT`

Delete a payment. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `payment_id` | integer | Yes | the id of the payment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Invoice Reminder

**Slug:** `BEXIO_DELETE_INVOICE_REMINDER`

Delete a reminder. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item

**Slug:** `BEXIO_DELETE_ITEM`

Delete an item. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | integer | Yes | the id of the item |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item Position

**Slug:** `BEXIO_DELETE_ITEM_POSITION`

Delete a item position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Manual Compound Entry File

**Slug:** `BEXIO_DELETE_MANUAL_COMPOUND_ENTRY_FILE`

Delete connection between file and manual compound entry. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | the id of the currency |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Manual Entry

**Slug:** `BEXIO_DELETE_MANUAL_ENTRY`

Delete manual entry. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Manual Entry File

**Slug:** `BEXIO_DELETE_MANUAL_ENTRY_FILE`

Delete connection between file and manual entry line. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | the id of the currency |
| `entry_id` | integer | Yes | the id of a single entry in the manual_entry object |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Milestone

**Slug:** `BEXIO_DELETE_MILESTONE`

Delete a milestone. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |
| `milestone_id` | integer | Yes | the id of the milestone |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Note

**Slug:** `BEXIO_DELETE_NOTE`

Delete a note. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | integer | Yes | the id of the note |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order

**Slug:** `BEXIO_DELETE_ORDER`

Delete an order. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Repetition

**Slug:** `BEXIO_DELETE_ORDER_REPETITION`

Delete a repetition. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Outgoing Payment

**Slug:** `BEXIO_DELETE_OUTGOING_PAYMENT`

Delete Outgoing Payment. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Outgoing Payment id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Pagebreak Position

**Slug:** `BEXIO_DELETE_PAGEBREAK_POSITION`

Delete a pagebreak position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Pagebreak positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Payment

**Slug:** `BEXIO_DELETE_PAYMENT`

Delete a payment. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | string | Yes | The payment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `BEXIO_DELETE_PROJECT`

Delete a project. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Purchase Order

**Slug:** `BEXIO_DELETE_PURCHASE_ORDER`

Delete a purchase order. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `purchase_order_id` | integer | Yes | the id of the purchase order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Quote

**Slug:** `BEXIO_DELETE_QUOTE`

Delete a quote. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Salutation

**Slug:** `BEXIO_DELETE_SALUTATION`

Delete a salutation. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `salutation_id` | integer | Yes | the id of the salutation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subposition Position

**Slug:** `BEXIO_DELETE_SUBPOSITION_POSITION`

Delete a sub position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Sub positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subtotal Position

**Slug:** `BEXIO_DELETE_SUBTOTAL_POSITION`

Delete a subtotal position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Subtotal positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task

**Slug:** `BEXIO_DELETE_TASK`

Delete a task. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | the id of the task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tax

**Slug:** `BEXIO_DELETE_TAX`

Delete a tax. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_id` | integer | Yes | the id of the tax |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Text Position

**Slug:** `BEXIO_DELETE_TEXT_POSITION`

Delete a text position. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Text positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Timesheet

**Slug:** `BEXIO_DELETE_TIMESHEET`

Delete a timesheet. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timesheet_id` | integer | Yes | the id of the timesheet |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Title

**Slug:** `BEXIO_DELETE_TITLE`

Delete a title. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title_id` | integer | Yes | the id of the title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Unit

**Slug:** `BEXIO_DELETE_UNIT`

Delete a unit. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit_id` | integer | Yes | the id of the unit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Work Package

**Slug:** `BEXIO_DELETE_WORK_PACKAGE`

Delete a work package. Permanently removes the selected resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | integer | Yes | the id of the work package |
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File

**Slug:** `BEXIO_DOWNLOAD_FILE`

Download file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | File ID to show |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Paystub Pdf

**Slug:** `BEXIO_DOWNLOAD_PAYSTUB_PDF`

Download paystub pdf for employee for given month.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Year for which report is being generated |
| `month` | integer | Yes | Month for which report is being generated |
| `employee_id` | string | Yes | Id of an employee |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Bill

**Slug:** `BEXIO_DUPLICATE_BILL`

Create a duplicate of the selected bill.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of a Bill for which action will be executed |
| `action` | string | Yes | Action to perform; must be `DUPLICATE`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Expense

**Slug:** `BEXIO_DUPLICATE_EXPENSE`

Create a duplicate of the selected expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Expense for which action will be executed |
| `action` | string | Yes | Action to perform; must be `DUPLICATE`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Additional Address

**Slug:** `BEXIO_GET_ADDITIONAL_ADDRESS`

Return the additional address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | the id of the contact |
| `additional_address_id` | integer | Yes | the id of the additional address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bank Account

**Slug:** `BEXIO_GET_BANK_ACCOUNT`

Return the single bank account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bank_account_id` | integer | Yes | ID of bank account to return |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bill

**Slug:** `BEXIO_GET_BILL`

Return Bill.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Bill to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Business Year

**Slug:** `BEXIO_GET_BUSINESS_YEAR`

Return the business year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `business_year_id` | integer | Yes | the id of the business_year |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Calendar Year

**Slug:** `BEXIO_GET_CALENDAR_YEAR`

Return the calendar year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `calendar_year_id` | integer | Yes | the id of the calendar_year |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Comment

**Slug:** `BEXIO_GET_COMMENT`

Return the comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | integer | Yes | the id of the comment |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Comments can be used in quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Profile

**Slug:** `BEXIO_GET_COMPANY_PROFILE`

Return company profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | integer | Yes | the id of the company profile |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact

**Slug:** `BEXIO_GET_CONTACT`

Return the contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | the id of the contact |
| `show_archived` | boolean | No | Show archived elements only |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Group

**Slug:** `BEXIO_GET_CONTACT_GROUP`

Return the contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_group_id` | integer | Yes | the id of the contact group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Relation

**Slug:** `BEXIO_GET_CONTACT_RELATION`

Return the contact relation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_relation_id` | integer | Yes | the id of the contact relation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country

**Slug:** `BEXIO_GET_COUNTRY`

Return the country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_id` | integer | Yes | the id of the country |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Currency

**Slug:** `BEXIO_GET_CURRENCY`

Return the currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency_id` | integer | Yes | the id of the currency |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `BEXIO_GET_CURRENT_USER`

Return the authenticated user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Default Position

**Slug:** `BEXIO_GET_DEFAULT_POSITION`

Return the default position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Default positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Delivery

**Slug:** `BEXIO_GET_DELIVERY`

Return the delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delivery_id` | integer | Yes | the id of the delivery |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Discount Position

**Slug:** `BEXIO_GET_DISCOUNT_POSITION`

Return the discount position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Discount positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee

**Slug:** `BEXIO_GET_EMPLOYEE`

Retrieve a single employee on a specific date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Date of employee's state |
| `employee_id` | string | Yes | Id of an employee |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Absence

**Slug:** `BEXIO_GET_EMPLOYEE_ABSENCE`

Retrieving absence for employee with given absence id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `absence_id` | string | Yes | Id of an absence |
| `employee_id` | string | Yes | Id of an employee |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Expense

**Slug:** `BEXIO_GET_EXPENSE`

Return Expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Expense to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fictional User

**Slug:** `BEXIO_GET_FICTIONAL_USER`

Return the fictional User.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fictional_user_id` | integer | Yes | the id of the fictional user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File

**Slug:** `BEXIO_GET_FILE`

Return metadata for a single file; use Download File to retrieve its content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | File ID to show |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File Usage

**Slug:** `BEXIO_GET_FILE_USAGE`

Return file usage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | File ID to show |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice

**Slug:** `BEXIO_GET_INVOICE`

Return the invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice Payment

**Slug:** `BEXIO_GET_INVOICE_PAYMENT`

Return the payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `payment_id` | integer | Yes | the id of the payment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice Pdf

**Slug:** `BEXIO_GET_INVOICE_PDF`

Return PDF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logopaper` | integer ("0" | "1") | No | Whether the PDF should be generated using the letterhead, or not. |
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice Reminder

**Slug:** `BEXIO_GET_INVOICE_REMINDER`

Return the reminder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice Reminder Pdf

**Slug:** `BEXIO_GET_INVOICE_REMINDER_PDF`

Return reminder PDF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logopaper` | integer ("0" | "1") | No | Whether the PDF should be generated using the letterhead, or not. |
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item

**Slug:** `BEXIO_GET_ITEM`

Return the item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | integer | Yes | the id of the item |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item Position

**Slug:** `BEXIO_GET_ITEM_POSITION`

Return the item position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Manual Compound Entry File

**Slug:** `BEXIO_GET_MANUAL_COMPOUND_ENTRY_FILE`

Return file of manual compound entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | the id of the file |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Manual Entry File

**Slug:** `BEXIO_GET_MANUAL_ENTRY_FILE`

Return file of manual entry line.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | the id of the file |
| `entry_id` | integer | Yes | the id of a single entry in the manual_entry object |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Milestone

**Slug:** `BEXIO_GET_MILESTONE`

Return the milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |
| `milestone_id` | integer | Yes | the id of the milestone |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Next Reference Number

**Slug:** `BEXIO_GET_NEXT_REFERENCE_NUMBER`

Return next reference number.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Note

**Slug:** `BEXIO_GET_NOTE`

Return the note.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | integer | Yes | the id of the note |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `BEXIO_GET_ORDER`

Return the order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Pdf

**Slug:** `BEXIO_GET_ORDER_PDF`

Return PDF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |
| `logopaper` | integer ("0" | "1") | No | Whether the PDF should be generated using the letterhead, or not. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Repetition

**Slug:** `BEXIO_GET_ORDER_REPETITION`

Return repetition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | the id of the order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Outgoing Payment

**Slug:** `BEXIO_GET_OUTGOING_PAYMENT`

Return Outgoing Payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Outgoing Payment to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pagebreak Position

**Slug:** `BEXIO_GET_PAGEBREAK_POSITION`

Return the pagebreak position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Pagebreak positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment

**Slug:** `BEXIO_GET_PAYMENT`

Return a payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | string | Yes | The payment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Permissions

**Slug:** `BEXIO_GET_PERMISSIONS`

Return access information of logged in user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `BEXIO_GET_PROJECT`

Return the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Purchase Order

**Slug:** `BEXIO_GET_PURCHASE_ORDER`

Return the single purchase order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `purchase_order_id` | integer | Yes | the id of the purchase order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote

**Slug:** `BEXIO_GET_QUOTE`

Return the quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote Pdf

**Slug:** `BEXIO_GET_QUOTE_PDF`

Return PDF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |
| `logopaper` | integer ("0" | "1") | No | Whether the PDF should be generated using the letterhead, or not. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Salutation

**Slug:** `BEXIO_GET_SALUTATION`

Return the salutation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `salutation_id` | integer | Yes | the id of the salutation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subposition Position

**Slug:** `BEXIO_GET_SUBPOSITION_POSITION`

Return the sub position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Sub positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subtotal Position

**Slug:** `BEXIO_GET_SUBTOTAL_POSITION`

Return the subtotal position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Subtotal positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `BEXIO_GET_TASK`

Return the task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | the id of the task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tax

**Slug:** `BEXIO_GET_TAX`

Return the tax.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_id` | integer | Yes | the id of the tax |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Text Position

**Slug:** `BEXIO_GET_TEXT_POSITION`

Return the text position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Text positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timesheet

**Slug:** `BEXIO_GET_TIMESHEET`

Return the timesheet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timesheet_id` | integer | Yes | the id of the timesheet |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Title

**Slug:** `BEXIO_GET_TITLE`

Return the title.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title_id` | integer | Yes | the id of the title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unit

**Slug:** `BEXIO_GET_UNIT`

Return the unit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit_id` | integer | Yes | the id of the unit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `BEXIO_GET_USER`

Return the user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | the id of the user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vat Period

**Slug:** `BEXIO_GET_VAT_PERIOD`

Return the vat period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vat_period_id` | integer | Yes | the id of the vat_period |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Work Package

**Slug:** `BEXIO_GET_WORK_PACKAGE`

Return the work package.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | integer | Yes | the id of the work package |
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Issue Delivery

**Slug:** `BEXIO_ISSUE_DELIVERY`

Issue a delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delivery_id` | integer | Yes | the id of the delivery |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Issue Invoice

**Slug:** `BEXIO_ISSUE_INVOICE`

Issue an invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Issue Quote

**Slug:** `BEXIO_ISSUE_QUOTE`

Issue a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Groups

**Slug:** `BEXIO_LIST_ACCOUNT_GROUPS`

Return one page of account groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounts

**Slug:** `BEXIO_LIST_ACCOUNTS`

Return one page of accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Additional Addresses

**Slug:** `BEXIO_LIST_ADDITIONAL_ADDRESSES`

Return one page of additional addresses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name" | "postcode" | "country_id") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `contact_id` | integer | Yes | the id of the contact |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bank Accounts

**Slug:** `BEXIO_LIST_BANK_ACCOUNTS`

Return one page of bank accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bills

**Slug:** `BEXIO_LIST_BILLS`

Return Bills, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | field to sort by |
| `limit` | integer | No | Limit the number of results (max is 500) |
| `order` | string | No | sorting order |
| `title` | string | No | filter for Bill 'title', text containing in field |
| `fields` | array | No | fields for which search will be run (if no 'fields[]' is specified than searching will be done for all allowed fields) |
| `status` | string ("DRAFTS" | "TODO" | "PAID" | "OVERDUE") | No | filter for Bill 'status' (DRAFTS: [DRAFT], TODO: [BOOKED, PARTIALLY_CREATED, CREATED, PARTIALLY_SENT, SENT, PARTIALLY_DOWNLOADED, DOWNLOADED, PARTIALLY_PAID, PARTIALLY_FAILED, FAILED], PAID: [PAID], OVERDUE: [BOOKED, PARTIALLY_CREATED, CREATED, PARTIALLY_SENT, SENT, PARTIALLY_DOWNLOADED, DOWNLOADED, PARTIALLY_PAID, PARTIALLY_FAILED, FAILED]) and for 'onlyOverdue' (DRAFTS: [FALSE], TODOS: [FALSE], PAID: [FALSE], OVERDUE: [TRUE]). Choosing OVERDUE means that only Bills with 'due_date' before now will be shown |
| `vendor` | string | No | filter for Bill 'vendor', text containing in fields lastname_company and firstname_suffix |
| `net_max` | number | No | filter for Bill 'net', the greatest accepted value |
| `net_min` | number | No | filter for Bill 'net', the lowest accepted value |
| `gross_max` | number | No | filter for Bill 'gross', the greatest accepted value |
| `gross_min` | number | No | filter for Bill 'gross', the lowest accepted value |
| `vendor_ref` | string | No | filter for Bill 'vendor_ref', text containing in field |
| `document_no` | string | No | filter for Bill 'document_no', text containing in field |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `search_term` | string | No | term for which application will look for (minimum 3 signs, maximum 255 signs) |
| `supplier_id` | integer | No | filter for Bill 'supplier_id' |
| `due_date_end` | string | No | filter for Bill 'due_date', the latest accepted date |
| `bill_date_end` | string | No | filter for Bill 'bill_date', the latest accepted date |
| `currency_code` | string | No | filter for Bill 'currency_code', text containing in field |
| `due_date_start` | string | No | filter for Bill 'due_date', the earliest accepted date |
| `bill_date_start` | string | No | filter for Bill 'bill_date', the earliest accepted date |
| `pending_amount_max` | number | No | filter for Bill 'pending_amount', the greatest accepted value |
| `pending_amount_min` | number | No | filter for Bill 'pending_amount', the lowest accepted value |
| `average_exchange_rate_enabled` | boolean | No | indicates whether 'average_exchange_rate_enabled' is enabled, or not |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Business Activities

**Slug:** `BEXIO_LIST_BUSINESS_ACTIVITIES`

Return one page of business activities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Business Years

**Slug:** `BEXIO_LIST_BUSINESS_YEARS`

Return one page of business years.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calendar Years

**Slug:** `BEXIO_LIST_CALENDAR_YEARS`

Return one page of calendar years.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Comments

**Slug:** `BEXIO_LIST_COMMENTS`

Return one page of comments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Communication Types

**Slug:** `BEXIO_LIST_COMMUNICATION_TYPES`

Return one page of communication types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Profile

**Slug:** `BEXIO_LIST_COMPANY_PROFILE`

Return one page of company profiles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Groups

**Slug:** `BEXIO_LIST_CONTACT_GROUPS`

Return one page of contact groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Relations

**Slug:** `BEXIO_LIST_CONTACT_RELATIONS`

Return one page of contact relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "contact_id" | "contact_sub_id" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `BEXIO_LIST_CONTACTS`

Return one page of contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "nr" | "name_1" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `show_archived` | boolean | No | Show archived elements only |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Sectors

**Slug:** `BEXIO_LIST_CONTACT_SECTORS`

Return one page of contact sectors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `BEXIO_LIST_COUNTRIES`

Return one page of countries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name" | "name_short") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Currencies

**Slug:** `BEXIO_LIST_CURRENCIES`

Return one page of currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | the validity date for the fetched exchange rate |
| `embed` | string | No | The embed parameters is being used for embedding related resources in the response. <br><br> **Example** <br> In case of ```embed=exchange_rate``` the fields ```exchange_rate```, ```exchange_rate_id```, ```ratio```, ```exchange_rate_to_ratio```, ```source```, ```source_reason``` and ```exchange_rate_date``` are shown |
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Currency Codes

**Slug:** `BEXIO_LIST_CURRENCY_CODES`

Return one page of possible currency codes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Default Positions

**Slug:** `BEXIO_LIST_DEFAULT_POSITIONS`

Return one page of default positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Default positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deliveries

**Slug:** `BEXIO_LIST_DELIVERIES`

Return one page of deliveries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discount Positions

**Slug:** `BEXIO_LIST_DISCOUNT_POSITIONS`

Return one page of discount positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Discount positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Settings

**Slug:** `BEXIO_LIST_DOCUMENT_SETTINGS`

Return one page of document settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string ("id" | "text") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Template

**Slug:** `BEXIO_LIST_DOCUMENT_TEMPLATE`

List document templates.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Absences

**Slug:** `BEXIO_LIST_EMPLOYEE_ABSENCES`

Retrieving absences of employee for given year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | string | Yes | Id of an employee |
| `business_year` | integer | Yes | Year of absence |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `BEXIO_LIST_EMPLOYEES`

Retrieves all active employees.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Exchange Rates For Currency

**Slug:** `BEXIO_LIST_EXCHANGE_RATES_FOR_CURRENCY`

Return exchange rates for currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | the validity date for the fetched exchange rate |
| `currency_id` | integer | Yes | the id of the currency |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Expenses

**Slug:** `BEXIO_LIST_EXPENSES`

Return Expenses, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | field to sort by |
| `limit` | integer | No | results per page |
| `order` | string | No | sorting order |
| `title` | string | No | filter for Expense 'title', text containing in field |
| `vendor` | string | No | filter for Expense 'vendor', text containing in fields lastname_company and firstname_suffix |
| `net_max` | number | No | filter for Expense 'net', the greatest accepted value |
| `net_min` | number | No | filter for Expense 'net', the lowest accepted value |
| `gross_max` | number | No | filter for Expense 'gross', the greatest accepted value |
| `gross_min` | number | No | filter for Expense 'gross', the lowest accepted value |
| `project_id` | string | No | filter for Expense 'project_id' |
| `document_no` | string | No | filter for Expense 'document_no', text containing in field |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `paid_on_end` | string | No | filter for Expense 'paid_on', the latest accepted date |
| `supplier_id` | integer | No | filter for Expense 'supplier_id' |
| `currency_code` | string | No | filter for Expense 'currency_code', text containing in field |
| `paid_on_start` | string | No | filter for Expense 'paid_on', the earliest accepted date |
| `created_at_end` | string | No | filter for Expense 'created_at', the latest accepted date |
| `created_at_start` | string | No | filter for Expense 'created_at', the earliest accepted date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fictional Users

**Slug:** `BEXIO_LIST_FICTIONAL_USERS`

Return one page of fictional users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `BEXIO_LIST_FILES`

Return one page of files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string ("id" | "created_at" | "source_id" | "uuid" | "name" | "size_in_bytes") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `archived_state` | string | No | Include/Exclude archived files via filter (all, archived, not_archived) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoice Payments

**Slug:** `BEXIO_LIST_INVOICE_PAYMENTS`

Return one page of payments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `invoice_id` | integer | Yes | the id of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoice Reminders

**Slug:** `BEXIO_LIST_INVOICE_REMINDERS`

Return one page of reminders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `BEXIO_LIST_INVOICES`

Return one page of invoices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Positions

**Slug:** `BEXIO_LIST_ITEM_POSITIONS`

Return one page of item positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `BEXIO_LIST_ITEMS`

Return one page of items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "intern_name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Journal Entries

**Slug:** `BEXIO_LIST_JOURNAL_ENTRIES`

Journal, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Can be used to filter for entries until this date |
| `from` | string | No | Can be used to filter for entries after this date |
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `account_uuid` | string | No | Can be used to filter for entries with account with uuid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Languages

**Slug:** `BEXIO_LIST_LANGUAGES`

Return one page of languages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manual Compound Entry Files

**Slug:** `BEXIO_LIST_MANUAL_COMPOUND_ENTRY_FILES`

Return files of manual compound entry, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manual Entries

**Slug:** `BEXIO_LIST_MANUAL_ENTRIES`

Return one page of manual entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manual Entry Files

**Slug:** `BEXIO_LIST_MANUAL_ENTRY_FILES`

Return files of manual entry line, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `entry_id` | integer | Yes | the id of a single entry in the manual_entry object |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Milestones

**Slug:** `BEXIO_LIST_MILESTONES`

Return one page of milestones.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `project_id` | integer | Yes | the id of the project |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `BEXIO_LIST_NOTES`

Return one page of notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `BEXIO_LIST_ORDERS`

Return one page of orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Outgoing Payments

**Slug:** `BEXIO_LIST_OUTGOING_PAYMENTS`

Retrieve Outgoing Payments, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | field to sort by |
| `limit` | integer | No | results per page |
| `order` | string ("asc" | "desc") | No | sorting order |
| `bill_id` | string | Yes | id of Bill for which Outgoing Payments were created |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pagebreak Positions

**Slug:** `BEXIO_LIST_PAGEBREAK_POSITIONS`

Return one page of pagebreak positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Pagebreak positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `BEXIO_LIST_PAYMENTS`

Return one page of payments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filter_by` | string | No | Filters can be used in range `_`, separated by `;`, example multiple filter - `filter-by=amount:11.16_16.11;execution_date:2025-11-16_2025-12-16` |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Types

**Slug:** `BEXIO_LIST_PAYMENT_TYPES`

Return one page of payment types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name" | "name_short") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `BEXIO_LIST_PROJECTS`

Return one page of projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Status

**Slug:** `BEXIO_LIST_PROJECT_STATUS`

Project status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Type

**Slug:** `BEXIO_LIST_PROJECT_TYPE`

Project types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Purchase Orders

**Slug:** `BEXIO_LIST_PURCHASE_ORDERS`

Return one page of purchase orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Quotes

**Slug:** `BEXIO_LIST_QUOTES`

Return one page of quotes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Salutations

**Slug:** `BEXIO_LIST_SALUTATIONS`

Return one page of salutations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stock Areas

**Slug:** `BEXIO_LIST_STOCK_AREAS`

Return one page of stock areas.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stock Locations

**Slug:** `BEXIO_LIST_STOCK_LOCATIONS`

Return one page of stock locations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subposition Positions

**Slug:** `BEXIO_LIST_SUBPOSITION_POSITIONS`

Return one page of sub positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Sub positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subtotal Positions

**Slug:** `BEXIO_LIST_SUBTOTAL_POSITIONS`

Return one page of subtotal positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Subtotal positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Task Priorities

**Slug:** `BEXIO_LIST_TASK_PRIORITIES`

Task priorities, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `BEXIO_LIST_TASKS`

Return one page of tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "finish_date") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Task Status

**Slug:** `BEXIO_LIST_TASK_STATUS`

Task status, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Taxes

**Slug:** `BEXIO_LIST_TAXES`

Return one page of taxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Displays all taxes which are active at the date given |
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `scope` | string ("active" | "inactive") | No | Can be used to filter for active or inactive taxes |
| `types` | string ("sales_tax" | "pre_tax") | No | Filter the types of the tax |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Text Positions

**Slug:** `BEXIO_LIST_TEXT_POSITIONS`

Return one page of text positions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Text positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Timesheets

**Slug:** `BEXIO_LIST_TIMESHEETS`

Return one page of timesheets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "date") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Time Sheet Status

**Slug:** `BEXIO_LIST_TIME_SHEET_STATUS`

Timesheet status, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Titles

**Slug:** `BEXIO_LIST_TITLES`

Return one page of titles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Units

**Slug:** `BEXIO_LIST_UNITS`

Return one page of units.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `BEXIO_LIST_USERS`

Return one page of users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Vat Periods

**Slug:** `BEXIO_LIST_VAT_PERIODS`

Return one page of vat periods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Work Packages

**Slug:** `BEXIO_LIST_WORK_PACKAGES`

Return one page of work packages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `project_id` | integer | Yes | the id of the project |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark As Sent Invoice

**Slug:** `BEXIO_MARK_AS_SENT_INVOICE`

Mark invoice as sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark As Sent Invoice Reminder

**Slug:** `BEXIO_MARK_AS_SENT_INVOICE_REMINDER`

Mark reminder as sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark As Sent Quote

**Slug:** `BEXIO_MARK_AS_SENT_QUOTE`

Mark quote as sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark As Unsent Invoice Reminder

**Slug:** `BEXIO_MARK_AS_UNSENT_INVOICE_REMINDER`

Mark reminder as unsent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview File

**Slug:** `BEXIO_PREVIEW_FILE`

Return file preview.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | File ID to get preview file |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reissue Quote

**Slug:** `BEXIO_REISSUE_QUOTE`

Reissue a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Contact

**Slug:** `BEXIO_RESTORE_CONTACT`

Restore a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | the id of the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revert Issue Invoice

**Slug:** `BEXIO_REVERT_ISSUE_INVOICE`

Sets issued invoice to draft.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revert Issue Quote

**Slug:** `BEXIO_REVERT_ISSUE_QUOTE`

Revert issue a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote_id` | integer | Yes | the id of the quote |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Accounts

**Slug:** `BEXIO_SEARCH_ACCOUNTS`

Search Accounts, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Additional Addresses

**Slug:** `BEXIO_SEARCH_ADDITIONAL_ADDRESSES`

Search additional addresses, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name" | "postcode" | "country_id") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `contact_id` | integer | Yes | the id of the contact |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Business Activities

**Slug:** `BEXIO_SEARCH_BUSINESS_ACTIVITIES`

Search business activities, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Calendar Years

**Slug:** `BEXIO_SEARCH_CALENDAR_YEARS`

Search calendar years, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. Each filter must follow the documented field, value, and criteria schema. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Communication Types

**Slug:** `BEXIO_SEARCH_COMMUNICATION_TYPES`

Search communication types, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact

**Slug:** `BEXIO_SEARCH_CONTACT`

Search contacts, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "nr" | "name_1" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `show_archived` | boolean | No | Show archived elements only |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Groups

**Slug:** `BEXIO_SEARCH_CONTACT_GROUPS`

Search contact groups, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Relations

**Slug:** `BEXIO_SEARCH_CONTACT_RELATIONS`

Search contact relations, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "contact_id" | "contact_sub_id" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Sectors

**Slug:** `BEXIO_SEARCH_CONTACT_SECTORS`

Search contact sectors, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Countries

**Slug:** `BEXIO_SEARCH_COUNTRIES`

Search countries, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name" | "name_short") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Files

**Slug:** `BEXIO_SEARCH_FILES`

Search files, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. Each filter must follow the documented field, value, and criteria schema. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `archived_state` | string | No | Include/Exclude archived files via filter (all, archived, not_archived) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Invoices

**Slug:** `BEXIO_SEARCH_INVOICES`

Search invoices, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Items

**Slug:** `BEXIO_SEARCH_ITEMS`

Search items, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "intern_name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Languages

**Slug:** `BEXIO_SEARCH_LANGUAGES`

Search languages, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Notes

**Slug:** `BEXIO_SEARCH_NOTES`

Search notes, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Orders

**Slug:** `BEXIO_SEARCH_ORDERS`

Search orders, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Payment Types

**Slug:** `BEXIO_SEARCH_PAYMENT_TYPES`

Search payment types, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name" | "name_short") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Projects

**Slug:** `BEXIO_SEARCH_PROJECTS`

Search projects, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Quotes

**Slug:** `BEXIO_SEARCH_QUOTES`

Search quotes, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "total" | "total_net" | "total_gross" | "updated_at") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Reminders

**Slug:** `BEXIO_SEARCH_REMINDERS`

Search invoice reminders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | Yes | Search filters. Each filter must follow the documented field, value, and criteria schema. |
| `invoice_id` | integer | Yes | the id of the invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Salutations

**Slug:** `BEXIO_SEARCH_SALUTATIONS`

Search salutations, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Stock Areas

**Slug:** `BEXIO_SEARCH_STOCK_AREAS`

Search stock areas, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Stock Locations

**Slug:** `BEXIO_SEARCH_STOCK_LOCATIONS`

Search stock locations, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Tasks

**Slug:** `BEXIO_SEARCH_TASKS`

Search tasks, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "finish_date") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Timesheets

**Slug:** `BEXIO_SEARCH_TIMESHEETS`

Search timesheets, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. Each filter must follow the documented field, value, and criteria schema. |
| `order_by` | string ("id" | "date") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Titles

**Slug:** `BEXIO_SEARCH_TITLES`

Search titles, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `order_by` | string ("id" | "name") | No | Defines the order of the results. Multiple sort parameters can be combined by using a comma separator. `_asc` and `_desc` can be appended to any parameter to either sort ascending (default) or descending. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Units

**Slug:** `BEXIO_SEARCH_UNITS`

Search units, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results (max is 2000) |
| `filters` | array | Yes | Search filters. At least one documented field, value, and criteria filter is required. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Invoice

**Slug:** `BEXIO_SEND_INVOICE`

Send an invoice. Applies the state-changing action immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | The placeholder "[Network Link]" must be part of the text.  |
| `subject` | string | Yes | The subject. |
| `attach_pdf` | boolean | No | Attach PDF directly to the email |
| `invoice_id` | integer | Yes | the id of the invoice |
| `mark_as_open` | boolean | No | The mark as open. |
| `recipient_email` | string | Yes | During the trial period, the recipient is limited to the email address associated to the access token provided.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Invoice Reminder

**Slug:** `BEXIO_SEND_INVOICE_REMINDER`

Send a reminder. Applies the state-changing action immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | The placeholder "[Network Link]" must be part of the text.  |
| `subject` | string | Yes | The subject. |
| `invoice_id` | integer | Yes | the id of the invoice |
| `reminder_id` | integer | Yes | the id of the reminder |
| `recipient_email` | string | Yes | During the trial period, the recipient is limited to the email address associated to the access token provided.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Quote

**Slug:** `BEXIO_SEND_QUOTE`

Send a quote. Applies the state-changing action immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | The placeholder "[Network Link]" must be part of the text.  |
| `subject` | string | Yes | The subject. |
| `quote_id` | integer | Yes | the id of the quote |
| `attach_pdf` | boolean | No | Attach PDF directly to the email |
| `mark_as_open` | boolean | No | The mark as open. |
| `recipient_email` | string | Yes | During the trial period, the recipient is limited to the email address associated to the access token provided.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive Project

**Slug:** `BEXIO_UNARCHIVE_PROJECT`

Unarchive a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | the id of the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Additional Address

**Slug:** `BEXIO_UPDATE_ADDITIONAL_ADDRESS`

Edit an additional address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | The city. |
| `name` | string | No | The name. |
| `subject` | string | No | The subject. |
| `postcode` | string | No | The postcode. |
| `contact_id` | integer | Yes | the id of the contact |
| `country_id` | integer | No | References a [country object](#operation/v2ListCountries) |
| `description` | string | No | The description. |
| `street_name` | string | No | Is required if `house_number` or `address_addition` are not **NULL** |
| `house_number` | string | No | Requires `street_name` if the value is not **NULL** |
| `name_addition` | string | No | The name addition. |
| `address_addition` | string | No | Requires `street_name` if the value is not **NULL** |
| `additional_address_id` | integer | Yes | the id of the additional address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bill

**Slug:** `BEXIO_UPDATE_BILL`

Update Bill.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Bill to update |
| `title` | string | No | The title. |
| `address` | object | Yes | Address |
| `payment` | object | No | The payment. |
| `due_date` | string | Yes | The due date. |
| `item_net` | boolean | Yes | The item net. |
| `bill_date` | string | Yes | The bill date. |
| `discounts` | array | Yes | Each of Discount's 'id' must be unique (no duplicates) and already existing on the Bill or it should be null for creating new Discount. When 'split_into_line_items' is false then there must 0 Discounts. |
| `amount_man` | number | No | Required when 'manual_amount' is true. Maximum of 17 digits and maximum of 2 decimal digits. |
| `line_items` | array | Yes | Each of Line Item's 'id' must be unique (no duplicates) and already existing on the Bill or it should be null for creating new Line Item. When 'split_into_line_items' is false then there must be only 1 Line Item. |
| `vendor_ref` | string | No | The vendor ref. |
| `amount_calc` | number | No | Required when 'manual_amount' is false. Maximum of 17 digits and maximum of 2 decimal digits. |
| `document_no` | string | No | The document no. |
| `supplier_id` | integer | Yes | The supplier id. |
| `currency_code` | string | Yes | The currency code. |
| `exchange_rate` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits. |
| `manual_amount` | boolean | Yes | Indicates whether 'amount_man' or 'amount_calc' is required and considered as bill amount |
| `attachment_ids` | array | Yes | The attachment ids. |
| `contact_partner_id` | integer | Yes | The contact partner id. |
| `base_currency_amount` | number | No | Maximum of 17 digits and maximum of 2 decimal digits. |
| `split_into_line_items` | boolean | Yes | Indicates whether Bill has multiple items (true) or single item (false). By items it means 'line_items' and 'discounts'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bill Booking Status

**Slug:** `BEXIO_UPDATE_BILL_BOOKING_STATUS`

Update Bill status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Bill to update |
| `status` | string ("DRAFT" | "BOOKED") | Yes | Bill status to update to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `BEXIO_UPDATE_CONTACT`

Edit a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | The fax. |
| `url` | string | No | The url. |
| `city` | string | No | The city. |
| `mail` | string | No | The mail. |
| `name_1` | string | Yes | This field is used as the company name if the field `contact_type_id` is set to `1`. Otherwise, the field is used as the last name of the person |
| `name_2` | string | No | This field is used as the company addition if the field `contact_type_id` is set to `1`. Otherwise, the field is used as the first name of the person |
| `remarks` | string | No | The remarks. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `birthday` | string | No | The birthday. |
| `owner_id` | integer | Yes | The owner id. |
| `postcode` | string | No | The postcode. |
| `title_id` | integer | No | References a [title object](#operation/v2ListTitles) |
| `contact_id` | integer | Yes | the id of the contact |
| `country_id` | integer | No | References a [country object](#operation/v2ListCountries) |
| `skype_name` | string | No | The skype name. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mail_second` | string | No | The mail second. |
| `phone_fixed` | string | No | The phone fixed. |
| `street_name` | string | No | Is required if `house_number` or `address_addition` are not **NULL** |
| `house_number` | string | No | Requires `street_name` if the value is not **NULL** |
| `phone_mobile` | string | No | The phone mobile. |
| `salutation_id` | integer | No | References a [salutation object](#operation/v2ListSalutations) |
| `contact_number` | string | No | Contact number. Omit it to let bexio assign the number automatically; when supplied, use numeric text. |
| `contact_type_id` | integer | Yes | Please use the value `1` for companies or `2` for persons |
| `salutation_form` | integer | No | The salutation form. |
| `address_addition` | string | No | Requires `street_name` if the value is not **NULL** |
| `contact_group_ids` | string | No | References one ore multiple [contact group objects](#operation/v2ListContactGroups) |
| `contact_branch_ids` | string | No | References one ore multiple [contact sector objects](#operation/v2ListContactSectors) |
| `phone_fixed_second` | string | No | The phone fixed second. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact Group

**Slug:** `BEXIO_UPDATE_CONTACT_GROUP`

Edit a contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `contact_group_id` | integer | Yes | the id of the contact group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact Relation

**Slug:** `BEXIO_UPDATE_CONTACT_RELATION`

Edit a contact relation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |
| `description` | string | No | The description. |
| `contact_sub_id` | string | Yes | References a [contact object](#operation/v2ListContacts) |
| `contact_relation_id` | integer | Yes | the id of the contact relation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Country

**Slug:** `BEXIO_UPDATE_COUNTRY`

Edit a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `country_id` | integer | Yes | the id of the country |
| `name_short` | string | Yes | The name short. |
| `iso3166_alpha2` | string | Yes | The iso3166 alpha2. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Currency

**Slug:** `BEXIO_UPDATE_CURRENCY`

Update a currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request data matching the documented operation schema. |
| `currency_id` | integer | Yes | the id of the currency |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Default Position

**Slug:** `BEXIO_UPDATE_DEFAULT_POSITION`

Edit a default position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `amount` | string | No | The amount. |
| `tax_id` | integer | No | References a [tax object](#operation/ListTaxes) Please note that only active sales taxes can be used as references on the document types `quote`, `order` and `invoice`. An easy way to retrieve all valid taxes is by calling the taxes endpoint with the query parameters `types=sales_tax&scope=active` (this would result in the path `/3.0/taxes?types=sales_tax&scope=active`). |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `account_id` | integer | No | References an [account object](#operation/ListAccounts) |
| `unit_price` | string | No | The price of one unit (max. 6 decimals) |
| `amount_open` | string | No | The amount open. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `is_optional` | boolean | No | Only in the case of quotes or Orders |
| `position_id` | integer | Yes | the id of the position |
| `amount_reserved` | string | No | The amount reserved. |
| `amount_completed` | string | No | The amount completed. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Default positions can be added to quotes, orders and invoices |
| `discount_in_percent` | string | No | The discount (max. 6 decimals) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Discount Position

**Slug:** `BEXIO_UPDATE_DISCOUNT_POSITION`

Edit a discount position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `value` | string | No | The value. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `is_percentual` | boolean | No | The is percentual. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Discount positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee

**Slug:** `BEXIO_UPDATE_EMPLOYEE`

Update employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iban` | string | No | The iban. |
| `email` | string | No | The email. |
| `gender` | string ("male" | "female") | No | The gender. |
| `address` | object | No | The address. |
| `language` | string ("de" | "it" | "fr" | "en") | No | The language. |
| `last_name` | string | No | The last name. |
| `ahv_number` | string | No | The ahv number. |
| `first_name` | string | No | The first name. |
| `employee_id` | string | Yes | Id of an employee |
| `nationality` | string | No | Nation should be in ISO Alpha-2 format. Special values: '11' means 'unknown', '22' means 'stateless'. |
| `phone_number` | string | No | The phone number. |
| `date_of_birth` | string | No | The date of birth. |
| `marital_status` | string ("unknown" | "single" | "married" | "separated" | "registered_partnership" | "partnership_dissolved_by_law" | "partnership_dissolved_by_death" | "partnership_dissolved_by_declaration_of_lost" | "widowed" | "divorced") | No | The marital status. |
| `personal_number` | string | No | The personal number. |
| `annual_vacation_days` | integer | No | The annual vacation days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Absence

**Slug:** `BEXIO_UPDATE_EMPLOYEE_ABSENCE`

Updating existing absence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | Yes | Currently supported reasons: Injury, Sickness, MaternityLeave, MilitaryLeave, Vacation, InterruptionOfWork. New reasons might be added in the future. |
| `end_date` | string | Yes | The end date. |
| `half_day` | boolean | Yes | The half day. |
| `absence_id` | string | Yes | Id of an absence |
| `disability` | number | Yes | The disability. |
| `paid_hours` | number | Yes | The paid hours. |
| `start_date` | string | Yes | The start date. |
| `employee_id` | string | Yes | Id of an employee |
| `continued_pay` | number | Yes | The continued pay. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense

**Slug:** `BEXIO_UPDATE_EXPENSE`

Update Expense.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | id of Expense to update |
| `title` | string | No | The title. |
| `amount` | number | Yes | Maximum of 17 digits and maximum of 2 decimal digits. |
| `tax_id` | integer | No | The tax id. |
| `address` | object | No | Address |
| `paid_on` | string | Yes | The paid on. |
| `document_no` | string | No | The document no. |
| `supplier_id` | integer | No | The supplier id. |
| `currency_code` | string | Yes | The currency code. |
| `exchange_rate` | number | No | Required when 'currency_code' is different from 'base_currency_code' (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits. |
| `attachment_ids` | array | Yes | List of file ids that should be attached to this Expense. Cannot have duplicates. |
| `bank_account_id` | integer | No | The bank account id. |
| `booking_account_id` | integer | No | The booking account id. |
| `base_currency_amount` | number | No | Maximum of 17 digits and maximum of 2 decimal digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Booking Status

**Slug:** `BEXIO_UPDATE_EXPENSE_BOOKING_STATUS`

Update Expense status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of Expense to update |
| `status` | string ("DRAFT" | "DONE") | Yes | Expense status to update to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Fictional User

**Slug:** `BEXIO_UPDATE_FICTIONAL_USER`

Update a fictional User.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the fictional user. Please note that an email address can only be used once for both regular and fictional users. |
| `lastname` | string | Yes | The last name of the fictional user |
| `title_id` | integer | No | A reference to a title |
| `firstname` | string | Yes | The first name of the fictional user |
| `salutation_type` | string ("male" | "female") | Yes | The salutation type. |
| `fictional_user_id` | integer | Yes | the id of the fictional user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update File

**Slug:** `BEXIO_UPDATE_FILE`

Update existing file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the file |
| `file_id` | integer | Yes | File ID to show |
| `is_archived` | boolean | No | Define archived state |
| `source_type` | string ("web" | "email" | "mobile") | No | type of the source (web, mobile, etc.) this file has been uploaded from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Invoice

**Slug:** `BEXIO_UPDATE_INVOICE`

Edit an invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `mwst_type` | integer ("0" | "1" | "2") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 0 &#124; including taxes &#124; &#124; 1 &#124; excluding taxes &#124; &#124; 2 &#124; exempt from taxes &#124;  |
| `reference` | string | No | The reference. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `invoice_id` | integer | Yes | the id of the invoice |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784 |
| `is_valid_to` | string | No | The is valid to. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item

**Slug:** `BEXIO_UPDATE_ITEM`

Edit an item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | integer | No | The width. |
| `height` | integer | No | The height. |
| `volume` | integer | No | The volume. |
| `weight` | integer | No | The weight. |
| `remarks` | string | No | The remarks. |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) (Currently, it has no impact, regardless of which user_id is sent.) |
| `stock_id` | integer | No | References a [stock location object](#operation/v2ListStockLocations) |
| `stock_nr` | integer | No | Please note that the stock number can only be set if no bookings for this product have been made. |
| `html_text` | string | No | The html text. |
| `account_id` | integer | No | References an [account object](#operation/v2ListAccounts) |
| `article_id` | integer | Yes | the id of the item |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `sale_price` | string | No | The sale price. |
| `sale_total` | number | No | The sale total. |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `intern_code` | string | No | The intern code. |
| `intern_name` | string | No | The intern name. |
| `stock_min_nr` | integer | No | The stock min nr. |
| `tax_income_id` | integer | No | References a [tax object](#operation/ListTaxes) |
| `deliverer_code` | string | No | The deliverer code. |
| `deliverer_name` | string | No | The deliverer name. |
| `delivery_price` | number | No | The delivery price. |
| `purchase_price` | string | No | The purchase price. |
| `purchase_total` | number | No | The purchase total. |
| `stock_place_id` | integer | No | References a [stock area object](#operation/v2ListStockAreas) |
| `tax_expense_id` | integer | No | References a [tax object](#operation/ListTaxes) |
| `article_group_id` | integer | No | The article group id. |
| `expense_account_id` | integer | No | References an [account object](#operation/v2ListAccounts) |
| `intern_description` | string | No | The intern description. |
| `deliverer_description` | string | No | The deliverer description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item Position

**Slug:** `BEXIO_UPDATE_ITEM_POSITION`

Edit an item position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `amount` | string | No | The amount. |
| `tax_id` | integer | No | References a [tax object](#operation/ListTaxes)  Please note that only active sales taxes can be used as references on the document types `quote`, `order` and `invoice`. An easy way to retrieve all valid taxes is by calling the taxes endpoint with the query parameters `types=sales_tax&scope=active` (this would result in the path `/3.0/taxes?types=sales_tax&scope=active`).  |
| `unit_id` | integer | No | References a [unit object](#operation/v2ListUnits) |
| `account_id` | integer | No | References an [account object](#operation/ListAccounts) |
| `article_id` | integer | No | References an [item object](#operation/v2ListItems) |
| `unit_price` | string | No | The price of one unit (max. 6 decimals) |
| `amount_open` | string | No | The amount open. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `is_optional` | boolean | No | Only valid in the case of Quotes or Orders |
| `position_id` | integer | Yes | the id of the position |
| `amount_reserved` | string | No | The amount reserved. |
| `amount_completed` | string | No | The amount completed. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Item positions can be added to quotes, orders and invoices |
| `discount_in_percent` | string | No | The discount (max. 6 decimals) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Manual Entry

**Slug:** `BEXIO_UPDATE_MANUAL_ENTRY`

Update manual entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | the booking date |
| `type` | string ("manual_single_entry" | "manual_compound_entry" | "manual_group_entry") | Yes | Choose one of the following three types:<br><br> **manual_single_entry**<br> Can be used to create a simple one line booking such as:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124; 3200 &#124; 13600 &#124;  **manual_compound_entry** <br> Can be used to create a more complex booking where the total amount can be distributed among multiple accounts. The following example shows how a received bank transaction can be booked on multiple accounts:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124;  &#124; 25000 &#124; &#124; &#124; 3200 &#124; 10000 &#124; &#124; &#124; 3201 &#124; 8000 &#124; &#124; &#124; 3202 &#124; 7000 &#124;  **manual_group_entry** <br> Can be used to create multiple one line bookings in one group entry. This means that the bookings will have the same `reference_nr` but can differ in accounts, currencies, etc. The following example shows how two received bank transaction can be booked on different accounts:  &#124; debit account &#124; credit account &#124; amount &#124; &#124;-----&#124;------&#124;----:&#124; &#124; 1020 &#124; 3200 &#124; 13600 &#124; &#124; 1021 &#124; 3201 &#124; 7230 &#124;  |
| `entries` | array | Yes | The entries. |
| `reference_nr` | string | No | A reference number for the booking |
| `manual_entry_id` | integer | Yes | The id of the manual entry to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Milestone

**Slug:** `BEXIO_UPDATE_MILESTONE`

Edit a milestone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the milestone |
| `comment` | string | No | Description for milestone |
| `end_date` | string | No | The end date for the milestone |
| `project_id` | integer | Yes | the id of the project |
| `milestone_id` | integer | Yes | the id of the milestone |
| `pr_parent_milestone_id` | integer | No | Higher level milestone |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Note

**Slug:** `BEXIO_UPDATE_NOTE`

Edit a note.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `info` | string | No | The info. |
| `note_id` | integer | Yes | the id of the note |
| `subject` | string | Yes | The subject. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `entry_id` | integer | No | The entry id. |
| `module_id` | integer | No | The module id. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `event_start` | string | Yes | The event start. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `BEXIO_UPDATE_ORDER`

Edit an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `order_id` | integer | Yes | the id of the order |
| `mwst_type` | integer ("0" | "1" | "2") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 0 &#124; including taxes &#124; &#124; 1 &#124; excluding taxes &#124; &#124; 2 &#124; exempt from taxes &#124; |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784 |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `delivery_address_type` | integer ("0" | "1") | No | &#124; value &#124; description &#124; &#124;-------&#124;-------------&#124; &#124; 0 &#124; use invoice address &#124; &#124; 1 &#124; use custom address &#124; |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |
| `delivery_address_manual` | string | No | This field can be used to set a delivery address manually if `delivery_address_type` is set to `1`. If not in use or `null` the invoice address will be taken. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order Repetition

**Slug:** `BEXIO_UPDATE_ORDER_REPETITION`

Edit a repetition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Date until the repetition is supposed to run. If empty indefinite repetition is assumed. |
| `start` | string | No | The start. |
| `order_id` | integer | Yes | the id of the order |
| `repetition` | string | No | Four different formats can be used to define the repetition. Either type `daily`, `weekly`, `monthly` or type `yearly`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Outgoing Payment

**Slug:** `BEXIO_UPDATE_OUTGOING_PAYMENT`

Edit Outgoing Payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | Must be less or equal to Bill's 'pending_amount'. Maximum of 17 digits and maximum of 2 decimal digits. |
| `message` | string | No | Not allowed for QR, MANUAL, CASH_DISCOUNT. |
| `fee_type` | string ("BY_SENDER" | "BY_RECEIVER" | "BREAKDOWN" | "NO_FEE") | No | Required for IBAN. Not allowed for QR, MANUAL, CASH_DISCOUNT. Must be set to NO_FEE when 'receiver_iban' is a domestic IBAN (same country as 'sender_bank_account_id' Bank Account IBAN country). Cannot be set to NO_FEE when 'receiver_iban' is not a domestic IBAN. |
| `payment_id` | string | Yes | The payment id. |
| `reference_no` | string | No | Not allowed for IBAN, MANUAL, CASH_DISCOUNT. For QR, when 'receiver_iban' is QR Iban then 'reference_no' must be valid Isr Account number. For QR, when 'receiver_iban' is not QR Iban then 'reference_no' must be valid Creditor Reference. |
| `receiver_city` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_iban` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. Must be valid Iban for IBAN Payment or must be valid QR Iban for QR Payment. |
| `receiver_name` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `execution_date` | string | Yes | Must be after or equal to Bill's 'bill_date'. Cannot be in CLOSED or LOCKED Business Year. Must be in existing Business Year. For IBAN and QR must be in present or future and cannot be on the weekend. |
| `receiver_street` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `is_salary_payment` | boolean | Yes | Allowed to be set to true only for IBAN. |
| `receiver_house_no` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_postcode` | string | No | Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT. |
| `receiver_country_code` | string | No | The receiver country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Pagebreak Position

**Slug:** `BEXIO_UPDATE_PAGEBREAK_POSITION`

Edit a pagebreak position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pagebreak` | boolean | No | The pagebreak. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Pagebreak positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Payment

**Slug:** `BEXIO_UPDATE_PAYMENT`

Update a payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request data matching the documented operation schema. |
| `payment_id` | string | Yes | The payment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `BEXIO_UPDATE_PROJECT`

Edit a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `comment` | string | No | The comment. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `end_date` | string | No | The end date. |
| `contact_id` | integer | Yes | References a [contact object](#operation/v2ListContacts) |
| `project_id` | integer | Yes | the id of the project |
| `start_date` | string | No | The start date. |
| `document_nr` | string | No | Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001721 |
| `pr_state_id` | integer | Yes | References a [project status object](#operation/v2ListProjectStatus) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `pr_budget_type_id` | number | No | The following budget types are available: &#124; Id &#124; Name &#124; Description &#124; &#124; ------ &#124; ------ &#124; ------ &#124; &#124; 1 &#124; type_budgeted_costs &#124; Total budget costs &#124; &#124; 2 &#124; type_budgeted_hours &#124; Total budget hours &#124; &#124; 3 &#124; type_service_budget &#124; Budget for each client services &#124; &#124; 4 &#124; type_service_employees &#124; Budget for each employee &#124; |
| `pr_invoice_type_id` | integer | No | The following invoice types are available: &#124; Id &#124; Name &#124; Description &#124; &#124; ------ &#124; ------ &#124; ------ &#124; &#124; 1 &#124; type_hourly_rate_service &#124; Hourly rate for client services &#124; &#124; 2 &#124; type_hourly_rate_employee &#124; Hourly rate for employee &#124; &#124; 3 &#124; type_hourly_rate_project &#124; Hourly rate for project &#124; &#124; 4 &#124; type_fix &#124; Fix price for project &#124; |
| `pr_project_type_id` | integer | Yes | References a [project type object](#operation/v2ListProjectType) |
| `pr_budget_type_amount` | string | No | This field can only be edited if the `pr_budget_type` is set. (Only supported for budget types: `type_budgeted_costs` and `type_budgeted_hours`) |
| `pr_invoice_type_amount` | string | No | This field can only be edited if the `pr_invoice_type` is set. (Only supported for invoice types: `type_hourly_rate_project` and `type_fix`) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Purchase Order

**Slug:** `BEXIO_UPDATE_PURCHASE_ORDER`

Update a single purchase order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The id of the purchase order |
| `mail` | string | No | The mail address of the company |
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `currency` | object | No | The currency. |
| `language` | object | No | The language. |
| `mwst_type` | string ("included" | "excluded" | "exempt") | No | Possible values are  * `included` - included means that the tax is included in the total price  * `excluded` - excluded means that the tax is excluded from the total price  * `exempt` - exempt means that no tax is charged  |
| `reference` | string | No | A reference which can be added to the document by the client. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `created_at` | string | No | Creation date of the purchase order |
| `project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `updated_at` | string | No | Last time when purchase order was updated |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `date_format` | string | No | The date format. |
| `document_nr` | string | No | The document nr. |
| `is_valid_to` | string | No | The is valid to. |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `template_slug` | string | No | The template slug. |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `is_valid_until` | string | No | The is valid until. |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `is_compact_view` | boolean | No | The is compact view. |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `salesman_user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `nb_decimals_price` | integer | No | The maximum number of decimal digits to display for prices (line item prices, totals, etc.). |
| `purchase_order_id` | integer | Yes | the id of the purchase order |
| `nb_decimals_amount` | integer | No | The maximum number of decimal digits to display for amounts (number of items). |
| `custom_translations` | object | No | The custom translations. |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `delivery_address_type` | string ("contact_address" | "manual") | No | The delivery address type. |
| `terms_of_payment_text` | string | No | Additional text which is displayed below the terms of payment |
| `contact_address_manual` | string | No | The contact address for the document. Newlines are in the format `\n` |
| `kb_payment_template_id` | integer | No | The kb payment template id. |
| `delivery_address_manual` | string | No | The delivery address for order. Newlines are in the format `\n` |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Quote

**Slug:** `BEXIO_UPDATE_QUOTE`

Edit a quote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title. |
| `footer` | string | No | The footer. |
| `header` | string | No | The header. |
| `user_id` | integer | No | References a [user object](#operation/v3ListUsers) |
| `quote_id` | integer | Yes | the id of the quote |
| `mwst_type` | integer ("0" | "1" | "2") | No | &#124; value &#124; description &#124; &#124;-----&#124;------&#124; &#124; 0 &#124; including taxes &#124; &#124; 1 &#124; excluding taxes &#124; &#124; 2 &#124; exempt from taxes &#124;  |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `currency_id` | integer | No | References a [currency object](#operation/ListCurrencies) |
| `document_nr` | string | No | Can not be used if automatic numbering is activated in frontend-settings. Required if automatic numbering deactivated. https://help.bexio.com/s/article/000001784 |
| `language_id` | integer | No | References a [language object](#operation/v2ListLanguages) |
| `mwst_is_net` | boolean | No | This value affects the total if the field `mwst_type` has been set to 0.<br> `false` = Taxes are included in the total<br> `true` = Taxes will be added to the total  |
| `logopaper_id` | integer | No | The logopaper id. |
| `api_reference` | string | No | This field can only be read and edited by the api. It can be used to save references to other systems. |
| `is_valid_from` | string | No | The is valid from. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `template_slug` | string | No | References a [document template slug](#operation/v3ListDocumentTemplate) |
| `contact_sub_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `is_valid_until` | string | No | The is valid until. |
| `bank_account_id` | integer | No | References a [bank account object](#operation/ListBankAccounts) |
| `payment_type_id` | integer | No | References a [payment type object](#operation/v2ListPaymentTypes) |
| `show_position_taxes` | boolean | No | The show position taxes. |
| `viewed_by_client_at` | string | No | The viewed by client at. |
| `delivery_address_type` | integer ("0" | "1") | No | &#124; value &#124; description &#124; &#124;-------&#124;-------------&#124; &#124;   0   &#124; use invoice address &#124; &#124;   1   &#124; use custom address &#124;  |
| `contact_address_manual` | string | No | This field can be used to set a contact address manually. If not in use or `null` the invoice address of the contact will be taken. |
| `delivery_address_manual` | string | No | This field can be used to set a delivery address manually if `delivery_address_type` is set to `1`. If not in use or `null` the invoice address will be taken. |
| `kb_terms_of_payment_template_id` | integer | No | The kb terms of payment template id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Salutation

**Slug:** `BEXIO_UPDATE_SALUTATION`

Edit a salutation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `salutation_id` | integer | Yes | the id of the salutation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subposition Position

**Slug:** `BEXIO_UPDATE_SUBPOSITION_POSITION`

Edit a sub position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `show_pos_nr` | boolean | No | The show pos nr. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Sub positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subtotal Position

**Slug:** `BEXIO_UPDATE_SUBTOTAL_POSITION`

Edit a subtotal position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Subtotal positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task

**Slug:** `BEXIO_UPDATE_TASK`

Edit a task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `info` | string | No | The info. |
| `subject` | string | Yes | The subject. |
| `task_id` | integer | Yes | the id of the task |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `entry_id` | integer | No | The entry id. |
| `module_id` | integer | No | The module id. |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `finish_date` | string | No | The finish date. |
| `have_remember` | boolean | No | The have remember. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `sub_contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `todo_status_id` | integer | No | The todo status id. |
| `remember_time_id` | integer | No | Is required if `have_remember` is set to true. |
| `remember_type_id` | integer | No | Is required if `have_remember` is set to true. |
| `todo_priority_id` | integer | No | The todo priority id. |
| `communication_kind_id` | integer | No | The communication kind id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Text Position

**Slug:** `BEXIO_UPDATE_TEXT_POSITION`

Edit a text position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `document_id` | integer | Yes | the id of the document. E.g. if the `kb_document_type` is set to `kb_invoice` the `document_id` must be set to the ID of the invoice |
| `position_id` | integer | Yes | the id of the position |
| `show_pos_nr` | boolean | No | The show pos nr. |
| `kb_document_type` | string ("kb_offer" | "kb_order" | "kb_invoice") | Yes | The type of the document. Text positions can be added to quotes, orders and invoices |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Timesheet

**Slug:** `BEXIO_UPDATE_TIMESHEET`

Edit a timesheet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The text. |
| `charge` | string | No | The charge. |
| `user_id` | integer | Yes | References a [user object](#operation/v3ListUsers) |
| `tracking` | object | Yes | Two different formats can be used to submit the tracked time. Either type `range` or type `duration`. |
| `status_id` | integer | No | References a [timesheet status object](#operation/v2ListTimeSheetStatus) |
| `contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `timesheet_id` | integer | Yes | the id of the timesheet |
| `pr_package_id` | integer | No | The pr package id. |
| `pr_project_id` | integer | No | References a [project object](#operation/v2ListProjects) |
| `allowable_bill` | boolean | Yes | The allowable bill. |
| `estimated_time` | string | No | The estimated time. |
| `sub_contact_id` | integer | No | References a [contact object](#operation/v2ListContacts) |
| `pr_milestone_id` | integer | No | The pr milestone id. |
| `client_service_id` | integer | Yes | References a [business activity object](#operation/v2ListBusinessActivities) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Title

**Slug:** `BEXIO_UPDATE_TITLE`

Edit a title.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `title_id` | integer | Yes | the id of the title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Unit

**Slug:** `BEXIO_UPDATE_UNIT`

Edit a unit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name. |
| `unit_id` | integer | Yes | the id of the unit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Work Package

**Slug:** `BEXIO_UPDATE_WORK_PACKAGE`

Edit a work package.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the work package |
| `comment` | string | No | Description for work package |
| `package_id` | integer | Yes | the id of the work package |
| `project_id` | integer | Yes | the id of the project |
| `pr_milestone_id` | integer | No | References a [milestone object](#operation/ListMilestones) |
| `spent_time_in_hours` | number | No | time spent on work package |
| `estimated_time_in_hours` | number | No | estimated time on work package |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Manual Compound Entry File

**Slug:** `BEXIO_UPLOAD_MANUAL_COMPOUND_ENTRY_FILE`

Add file to manual compound entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. Call this action once per file to upload multiple files. |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Manual Entry File

**Slug:** `BEXIO_UPLOAD_MANUAL_ENTRY_FILE`

Add file to manual entry line.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. Call this action once per file to upload multiple files. |
| `entry_id` | integer | Yes | the id of a single entry in the manual_entry object |
| `manual_entry_id` | integer | Yes | the id of the manual_entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |