Skip to main content
bexio logo
  • Category: accounting
  • Auth: OAUTH2, BEARER_TOKEN
  • Composio-managed OAuth available? No
  • Tools: 309
  • Triggers: 0
  • Slug: BEXIO
  • Version: 20261101_00

Tools

Slug: BEXIO_ACCEPT_QUOTEAccept a quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_ARCHIVE_PROJECTArchive a project.

Input Parameters

integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CANCEL_INVOICECancel an invoice. Applies the state-changing action immediately.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CANCEL_PAYMENTCancel a payment. Applies the state-changing action immediately.

Input Parameters

string
required
The payment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CHECK_BILL_DOCUMENT_NUMBERCheck whether a bill document number is available.

Input Parameters

string
required
document number to validate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CHECK_EXPENSE_DOCUMENT_NUMBERCheck whether an expense document number is available.

Input Parameters

string
required
document number to validate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_COPY_INVOICECopy a invoice.

Input Parameters

string
The title.
string
required
References a contact object
integer
required
the id of the invoice
string
The is valid from.
integer
References a contact object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_COPY_QUOTECopy a quote.

Input Parameters

string
The title.
integer
required
the id of the quote
string
required
References a contact object
string
The is valid from.
integer
References a project object
integer
References a contact object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_ADDITIONAL_ADDRESSCreate additional address.

Input Parameters

string
The city.
string
The name.
string
The subject.
string
The postcode.
integer
required
the id of the contact
integer
References a country object
string
The description.
string
Is required if house_number or address_addition are not NULL
string
Requires street_name if the value is not NULL
string
The name addition.
string
Requires street_name if the value is not NULL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_BILLCreate new Bill.

Input Parameters

string
The title.
object
required
Address
object
The payment.
string
required
The due date.
boolean
required
Indicates whether ‘amount’ in ‘line_items’ is net or gross.
string
required
The bill date.
array
required
The discounts.
number
Required when ‘manual_amount’ is true. Maximum of 17 digits and maximum of 2 decimal digits.
array
required
The line items.
string
The vendor ref.
number
Required when ‘manual_amount’ is false. Maximum of 17 digits and maximum of 2 decimal digits.
integer
required
The supplier id.
string
required
The currency code.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits.
boolean
required
indicates whether ‘amount_man’ or ‘amount_calc’ is required and considered as bill amount
array
required
The attachment ids.
integer
The purchase order id.
integer
required
The contact partner id.
string
The qr bill information.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 17 digits and maximum of 2 decimal digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_BUSINESS_ACTIVITYCreate business activity.

Input Parameters

string
required
The name.
integer
References an account object
boolean
The default is billable.
number
The default price per hour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CALENDAR_YEARCreate calendar year.

Input Parameters

string
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.
boolean
Determines if the calendar year is vat subjected or not.
boolean
Determines if the calendar year has annual reporting enabled.
string ("agreed" | "collected")
Vat accounting type.
integer
Determine default tax ID for income. References a tax object
string ("effective" | "net_tax")
Vat accounting method.
integer
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_COMMENTCreate a comment on a quote, order, or invoice.

Input Parameters

string
required
The text.
string
required
References a user object
boolean
The is public.
string
required
The user name.
string
The user email.
integer
required
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
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Comments can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CONTACTCreate contact.

Input Parameters

string
The fax.
string
The url.
string
The city.
string
The mail.
string
required
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
string
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
string
The remarks.
integer
required
References a user object
string
The birthday.
integer
required
The owner id.
string
The postcode.
integer
References a title object
integer
References a country object
string
The skype name.
integer
References a language object
string
The mail second.
string
The phone fixed.
string
Is required if house_number or address_addition are not NULL
string
Requires street_name if the value is not NULL
string
The phone mobile.
integer
References a salutation object
string
Contact number. Omit it to let bexio assign the number automatically; when supplied, use numeric text.
integer
required
Please use the value 1 for companies or 2 for persons
integer
The salutation form.
string
Requires street_name if the value is not NULL
string
References one ore multiple contact group objects
string
References one ore multiple contact sector objects
string
The phone fixed second.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CONTACT_GROUPCreate contact group.

Input Parameters

string
required
The name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CONTACT_RELATIONCreate contact relation.

Input Parameters

string
required
References a contact object
string
The description.
string
required
References a contact object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CONTACTS_BULKBulk create contacts.

Input Parameters

array
Items for the request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_COUNTRYCreate country.

Input Parameters

string
required
The name.
string
required
The name short.
string
required
The iso3166 alpha2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_CURRENCYCreate a currency.

Input Parameters

string
required
A name of the currency. Must be in the format “ISO 4217” and must be unique.
number
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_DEFAULT_POSITIONCreate a default position on a quote, order, or invoice.

Input Parameters

string
The text.
string
The amount.
integer
References a tax object 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).
integer
References a unit object
integer
References an account object
string
The price of one unit (max. 6 decimals)
string
The amount open.
integer
required
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
boolean
Only in the case of quotes or Orders
string
The amount reserved.
string
The amount completed.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Default positions can be added to quotes, orders and invoices
string
The discount (max. 6 decimals)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_DELIVERY_FROM_ORDERCreate delivery from order.

Input Parameters

integer
required
the id of the order
array
Please note that the positions array can be omitted to create a document with all positions from the source document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_DISCOUNT_POSITIONCreate a discount position.

Input Parameters

string
The text.
string
The value.
integer
required
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
boolean
The is percentual.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Discount positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_EMPLOYEECreate employee.

Input Parameters

string
The iban.
string
The email.
string ("male" | "female")
The gender.
object
The address.
string ("de" | "it" | "fr" | "en")
The language.
string
The last name.
string
The ahv number.
string
The first name.
string
Nation should be in ISO Alpha-2 format. Special values: ‘11’ means ‘unknown’, ‘22’ means ‘stateless’.
string
The phone number.
string
The date of birth.
string ("unknown" | "single" | "married" | "separated" | "registered_partnership" | "partnership_dissolved_by_law" | "partnership_dissolved_by_death" | "partnership_dissolved_by_declaration_of_lost" | "widowed" | "divorced")
The marital status.
string
The personal number.
integer
The annual vacation days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_EMPLOYEE_ABSENCECreate absence for employee.

Input Parameters

string
required
Currently supported reasons: Injury, Sickness, MaternityLeave, MilitaryLeave, Vacation, InterruptionOfWork. New reasons might be added in the future.
string
The end date.
boolean
The half day.
number
The disability.
number
The paid hours.
string
required
The start date.
string
required
Id of an employee
number
The continued pay.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_EXPENSECreate new Expense.

Input Parameters

string
The title.
number
required
Maximum of 17 digits and maximum of 2 decimal digits.
integer
The tax id.
object
Address
string
required
The paid on.
integer
The supplier id.
string
required
The currency code.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits.
array
required
List of file ids that should be attached to this Expense. Cannot have duplicates.
integer
The bank account id.
integer
The booking account id.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 17 digits and maximum of 2 decimal digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_FICTIONAL_USERCreate a fictional user.

Input Parameters

string
required
The email address of the fictional user. Please note that an email address can only be used once for both regular and fictional users.
string
required
The last name of the fictional user
integer
A reference to a title
string
required
The first name of the fictional user
string ("male" | "female")
required
The salutation type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_FILECreate new file.

Input Parameters

object
required
File to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_INVOICECreate invoice.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
array
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.
string
The reference.
integer
References a contact object
integer
References a currency object
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784
string
The is valid to.
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_INVOICE_FROM_ORDERCreate invoice from order.

Input Parameters

integer
required
the id of the order
array
Please note that the positions array can be omitted to create a document with all positions from the source document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_INVOICE_FROM_QUOTECreate invoice from quote.

Input Parameters

integer
required
the id of the quote
array
Please note that the positions array can be omitted to create a document with all positions from the source document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_INVOICE_PAYMENTCreate payment.

Input Parameters

string
The date.
string
required
The value.
integer
required
the id of the invoice
integer
References a bank account object
integer ("1" | "2" | "3")
| value | description | |-----|------| | 1 | PayPal | | 2 | Stripe | | 3 | SIX Payments |

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_INVOICE_REMINDERCreate reminder.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_ITEMCreate item.

Input Parameters

integer
The width.
integer
The height.
integer
The volume.
integer
The weight.
string
The remarks.
integer
References a unit object
integer
References a user object (Currently, it has no impact, regardless of which user_id is sent.)
boolean
Requires stock_edit scope to work.
integer
References a stock location object
integer
Please note that the stock number can only be set if no bookings for this product have been made.
string
The html text.
integer
References an account object
integer
References a contact object
string
The sale price.
number
The sale total.
integer
References a currency object
string
The intern code.
string
The intern name.
integer
The stock min nr.
integer
References a tax object
string
The deliverer code.
string
The deliverer name.
number
The delivery price.
string
The purchase price.
number
The purchase total.
integer
References a stock area object
integer
References a tax object
integer
Please use the value 1 for physical products or 2 for services
integer
The article group id.
integer
References an account object
string
The intern description.
string
The deliverer description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_ITEM_POSITIONCreate an item position on a quote, order, or invoice.

Input Parameters

string
The text.
string
The amount.
integer
References a tax object 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).
integer
References a unit object
integer
References an account object
integer
References an item object
string
The price of one unit (max. 6 decimals)
string
The amount open.
integer
required
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
boolean
Only valid in the case of Quotes or Orders
string
The amount reserved.
string
The amount completed.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices
string
The discount (max. 6 decimals)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_MANUAL_ENTRYCreate manual entry.

Input Parameters

string
required
the booking date
string ("manual_single_entry" | "manual_compound_entry" | "manual_group_entry")
required
Choose one of the following three types:

manual_single_entry
Can be used to create a simple one line booking such as: | debit account | credit account | amount | |-----|------|----:| | 1020 | 3200 | 13600 | manual_compound_entry
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: | debit account | credit account | amount | |-----|------|----:| | 1020 | | 25000 | | | 3200 | 10000 | | | 3201 | 8000 | | | 3202 | 7000 | manual_group_entry
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: | debit account | credit account | amount | |-----|------|----:| | 1020 | 3200 | 13600 | | 1021 | 3201 | 7230 |
array
required
The entries.
string
A reference number for the booking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_MILESTONECreate milestone.

Input Parameters

string
required
The name of the milestone
string
Description for milestone
string
The end date for the milestone
integer
required
the id of the project
integer
Higher level milestone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_NOTECreate note.

Input Parameters

string
The info.
string
required
The subject.
integer
required
References a user object
integer
The entry id.
integer
The module id.
integer
References a contact object
string
required
The event start.
integer
References a project object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_ORDERCreate order.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
array
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.
integer
References a contact object
integer
References a currency object
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
integer ("0" | "1")
| value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_ORDER_FROM_QUOTECreate order from quote.

Input Parameters

integer
required
the id of the quote
array
Please note that the positions array can be omitted to create a document with all positions from the source document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_OUTGOING_PAYMENTCreate new Outgoing Payment.

Input Parameters

string
Not allowed for IBAN, QR.
number
required
Must be less or equal to Bill’s ‘pending_amount’. Maximum of 17 digits and maximum of 2 decimal digits.
string
required
Payment can be created only for Bill that is not in status DRAFT.
string
Not allowed for QR, MANUAL, CASH_DISCOUNT.
string ("BY_SENDER" | "BY_RECEIVER" | "BREAKDOWN" | "NO_FEE")
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.
string
Required for IBAN, QR. Not allowed for CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for CASH_DISCOUNT.
string
Not allowed for MANUAL, CASH_DISCOUNT.
string ("IBAN" | "MANUAL" | "CASH_DISCOUNT" | "QR")
required
Bill’s amount cannot be covered only by CASH_DISCOUNT payments.
string
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.
string
Not allowed for CASH_DISCOUNT.
string
required
Must be equal to Bill’s ‘currency_code’. Only ‘CHF’ and ‘EUR’ is allowed for QR.
number
required
Maximum of 5 digits and maximum of 10 decimal digits.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
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.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for CASH_DISCOUNT.
string
required
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.
string
Not allowed for MANUAL, CASH_DISCOUNT.
string
Not allowed for CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
Not allowed for CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for CASH_DISCOUNT.
string
Not allowed for MANUAL, CASH_DISCOUNT.
string
Not allowed for CASH_DISCOUNT.
boolean
required
Allowed to be set to true only for IBAN.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
Not allowed for MANUAL, CASH_DISCOUNT.
string
Not allowed for IBAN, QR, MANUAL, CASH_DISCOUNT.
string
Not allowed for CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_PAGEBREAK_POSITIONCreate a pagebreak position.

Input Parameters

boolean
The pagebreak.
integer
required
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
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Pagebreak positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_PAYMENTCreate a banking payment.

Input Parameters

string ("iban" | "qr")
required
Type of the payment. Each payment requires different fields
number
required
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
string
Multiline description of the payment
string
required
Currency in which send a payment, according to ISO 4217
string ("fee_paid_by_payer" | "fee_paid_by_payee" | "fee_split" | "no_fee")
For payments to other countries or with different currencies
string
required
If it is a salary payment
object
required
The recipient.
string
required
The account id.
string
required
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
object
The purchase reference.
string
A QR reference number or creditor reference number.
boolean
If set to true, editing will be restricted to the api client id which created the payment
string
Additional information on the payment slip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_PROJECTCreate project.

Input Parameters

string
required
The name.
string
The comment.
integer
required
References a user object
string
The end date.
integer
required
References a contact object
string
The start date.
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001721
integer
required
References a project status object
integer
References a contact object
number
The following budget types are available: | Id | Name | Description | | ------ | ------ | ------ | | 1 | type_budgeted_costs | Total budget costs | | 2 | type_budgeted_hours | Total budget hours | | 3 | type_service_budget | Budget for each client services | | 4 | type_service_employees | Budget for each employee |
integer
The following invoice types are available: | Id | Name | Description | | ------ | ------ | ------ | | 1 | type_hourly_rate_service | Hourly rate for client services | | 2 | type_hourly_rate_employee | Hourly rate for employee | | 3 | type_hourly_rate_project | Hourly rate for project | | 4 | type_fix | Fix price for project |
integer
required
References a project type object
string
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)
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_PURCHASE_ORDERCreate a purchase order.

Input Parameters

integer
The id of the purchase order
string
The mail address of the company
string
The title.
The footer.
string
The header.
integer
References a user object
object
The currency.
object
The language.
string ("included" | "excluded" | "exempt")
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
object
A purchase order can have multiple line items (positions). Please note that the line items must be grouped by required, optional and discount positions.
string
A reference which can be added to the document by the client.
integer
References a contact object
string
Creation date of the purchase order
integer
References a project object
string
Last time when purchase order was updated
integer
References a currency object
string
The date format.
string
The document nr.
string
The is valid to.
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
string
The template slug.
integer
References a contact object
string
The is valid until.
integer
References a bank account object
boolean
The is compact view.
integer
References a payment type object
integer
References a user object
integer
The maximum number of decimal digits to display for prices (line item prices, totals, etc.).
integer
The maximum number of decimal digits to display for amounts (number of items).
object
The custom translations.
boolean
The show position taxes.
string ("contact_address" | "manual")
The delivery address type.
string
Additional text which is displayed below the terms of payment
string
The contact address for the document. Newlines are in the format \n
integer
The kb payment template id.
string
The delivery address for order. Newlines are in the format \n

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_QUOTECreate quote.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
array
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.
integer
References a contact object
integer
References a currency object
string
Can not be used if automatic numbering is activated in frontend-settings. Required if automatic numbering deactivated. https://help.bexio.com/s/article/000001784
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
string
The is valid until.
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
string
The viewed by client at.
integer ("0" | "1")
| value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |
string
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.
string
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.
integer
The kb terms of payment template id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_SALUTATIONCreate salutation.

Input Parameters

string
required
The name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_SUBPOSITION_POSITIONCreate a sub position on a quote, order or invoice.

Input Parameters

string
The text.
integer
required
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
boolean
The show pos nr.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Sub positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_SUBTOTAL_POSITIONCreate a subtotal position.

Input Parameters

string
The text.
integer
required
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
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Subtotal positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_TASKCreate task.

Input Parameters

string
The info.
string
required
The subject.
integer
required
References a user object
integer
The entry id.
integer
The module id.
integer
References a contact object
string
The finish date.
boolean
The have remember.
integer
References a project object
integer
References a contact object
integer
The todo status id.
integer
Is required if have_remember is set to true.
integer
Is required if have_remember is set to true.
integer
The todo priority id.
integer
The communication kind id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_TEXT_POSITIONCreate a text position on a quote, order, or invoice.

Input Parameters

string
The text.
integer
required
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
boolean
The show pos nr.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Text positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_TIMESHEETCreate a timesheet with range-based time tracking.

Input Parameters

string
The text.
string
The charge.
integer
required
References a user object
object
required
Two different formats can be used to submit the tracked time. Either type range or type duration.
integer
References a timesheet status object
integer
References a contact object
integer
The pr package id.
integer
References a project object
boolean
required
The allowable bill.
string
The estimated time.
integer
References a contact object
integer
The pr milestone id.
integer
required
References a business activity object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_TITLECreate title.

Input Parameters

string
required
The name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_UNITCreate unit.

Input Parameters

string
required
The name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_CREATE_WORK_PACKAGECreate work package.

Input Parameters

string
required
The name of the work package
string
Description for work package
integer
required
the id of the project
integer
References a milestone object
number
time spent on work package
number
estimated time on work package

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DECLINE_QUOTEDecline a quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_ADDITIONAL_ADDRESSDelete an additional address. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the contact
integer
required
the id of the additional address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_BILLDelete Bill. Permanently removes the selected resource.

Input Parameters

string
required
id of Bill to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_CONTACTDelete a contact. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_CONTACT_GROUPDelete a contact group. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the contact group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_CONTACT_RELATIONDelete a contact relation. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the contact relation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_COUNTRYDelete a country. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the country

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_CURRENCYDelete a currency. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the currency

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_DEFAULT_POSITIONDelete a default position from a quote, order, or invoice. Permanently removes the selected resource.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Default positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_DISCOUNT_POSITIONDelete a discount position. Permanently removes the selected resource.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Discount positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_EMPLOYEE_ABSENCEDeleting employee absence with given id. Permanently removes the selected resource.

Input Parameters

string
required
Id of an absence
string
required
Id of an employee

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_EXPENSEDelete Expense. Permanently removes the selected resource.

Input Parameters

string
required
id of Expense to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_FICTIONAL_USERDelete a fictional user. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the fictional user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_FILEDelete a existing file. Permanently removes the selected resource.

Input Parameters

integer
required
File ID to show

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_INVOICEDelete an invoice. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_INVOICE_PAYMENTDelete a payment. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_INVOICE_REMINDERDelete a reminder. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the reminder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_ITEMDelete an item. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_ITEM_POSITIONDelete an item position from a quote, order, or invoice. Permanently removes the selected position.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_MANUAL_COMPOUND_ENTRY_FILEDelete connection between file and manual compound entry. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the currency
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_MANUAL_ENTRYDelete manual entry. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_MANUAL_ENTRY_FILEDelete connection between file and manual entry line. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the currency
integer
required
the id of a single entry in the manual_entry object
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_MILESTONEDelete a milestone. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the project
integer
required
the id of the milestone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_NOTEDelete a note. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_ORDERDelete an order. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_ORDER_REPETITIONDelete the repetition for a specified order.

Input Parameters

integer
required
the id of the order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_OUTGOING_PAYMENTDelete Outgoing Payment. Permanently removes the selected resource.

Input Parameters

string
required
Outgoing Payment id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_PAGEBREAK_POSITIONDelete a pagebreak position. Permanently removes the selected resource.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Pagebreak positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_PAYMENTDelete a banking payment.

Input Parameters

string
required
The payment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_PROJECTDelete a project. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_PURCHASE_ORDERDelete a purchase order. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_QUOTEDelete a quote. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_SALUTATIONDelete a salutation. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the salutation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_SUBPOSITION_POSITIONDelete a sub position from a quote, order or invoice. Permanently removes the selected resource.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Sub positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_SUBTOTAL_POSITIONDelete a subtotal position. Permanently removes the selected resource.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Subtotal positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_TASKDelete a task. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_TAXDelete a tax. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the tax

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_TEXT_POSITIONDelete a text position from a quote, order, or invoice.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Text positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_TIMESHEETDelete a timesheet. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the timesheet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_TITLEDelete a title. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_UNITDelete a unit. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DELETE_WORK_PACKAGEDelete a work package. Permanently removes the selected resource.

Input Parameters

integer
required
the id of the work package
integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DOWNLOAD_FILEDownload file.

Input Parameters

integer
required
File ID to show

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DOWNLOAD_PAYSTUB_PDFDownload paystub pdf for employee for given month.

Input Parameters

integer
required
Year for which report is being generated
integer
required
Month for which report is being generated
string
required
Id of an employee

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DUPLICATE_BILLCreate a duplicate of the selected bill.

Input Parameters

string
required
Id of a Bill for which action will be executed
string
required
Action to perform; must be DUPLICATE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_DUPLICATE_EXPENSECreate a duplicate of the selected expense.

Input Parameters

string
required
id of Expense for which action will be executed
string
required
Action to perform; must be DUPLICATE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ADDITIONAL_ADDRESSReturn the additional address.

Input Parameters

integer
required
the id of the contact
integer
required
the id of the additional address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_BANK_ACCOUNTReturn the single bank account.

Input Parameters

integer
required
ID of bank account to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_BILLReturn Bill.

Input Parameters

string
required
id of Bill to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_BUSINESS_YEARReturn the business year.

Input Parameters

integer
required
the id of the business_year

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CALENDAR_YEARReturn the calendar year.

Input Parameters

integer
required
the id of the calendar_year

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_COMMENTReturn a comment on a quote, order, or invoice.

Input Parameters

integer
required
the id of the comment
integer
required
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
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Comments can be used in quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_COMPANY_PROFILEReturn company profile.

Input Parameters

integer
required
the id of the company profile

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CONTACTReturn the contact.

Input Parameters

integer
required
the id of the contact
boolean
Show archived elements only

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CONTACT_GROUPReturn the contact group.

Input Parameters

integer
required
the id of the contact group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CONTACT_RELATIONReturn the contact relation.

Input Parameters

integer
required
the id of the contact relation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_COUNTRYReturn the country.

Input Parameters

integer
required
the id of the country

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CURRENCYReturn the currency.

Input Parameters

integer
required
the id of the currency

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_CURRENT_USERReturn the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_DEFAULT_POSITIONReturn a default position on a quote, order, or invoice.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Default positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_DELIVERYReturn the delivery.

Input Parameters

integer
required
the id of the delivery

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_DISCOUNT_POSITIONReturn the discount position.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Discount positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_EMPLOYEERetrieve a single employee on a specific date.

Input Parameters

string
required
Date of employee’s state
string
required
Id of an employee

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_EMPLOYEE_ABSENCERetrieving absence for employee with given absence id.

Input Parameters

string
required
Id of an absence
string
required
Id of an employee

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_EXPENSEReturn Expense.

Input Parameters

string
required
id of Expense to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_FICTIONAL_USERReturn the fictional User.

Input Parameters

integer
required
the id of the fictional user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_FILEReturn metadata for a single file; use Download File to retrieve its content.

Input Parameters

integer
required
File ID to show

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_FILE_USAGEReturn file usage.

Input Parameters

integer
required
File ID to show

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_INVOICEReturn the invoice.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_INVOICE_PAYMENTReturn the payment.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_INVOICE_PDFReturn PDF.

Input Parameters

integer ("0" | "1")
Whether the PDF should be generated using the letterhead, or not.
integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_INVOICE_REMINDERReturn the reminder.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the reminder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_INVOICE_REMINDER_PDFReturn reminder PDF.

Input Parameters

integer ("0" | "1")
Whether the PDF should be generated using the letterhead, or not.
integer
required
the id of the invoice
integer
required
the id of the reminder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ITEMReturn the item.

Input Parameters

integer
required
the id of the item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ITEM_POSITIONReturn an item position from a quote, order, or invoice.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_MANUAL_COMPOUND_ENTRY_FILEReturn file of manual compound entry.

Input Parameters

integer
required
the id of the file
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_MANUAL_ENTRY_FILEReturn file of manual entry line.

Input Parameters

integer
required
the id of the file
integer
required
the id of a single entry in the manual_entry object
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_MILESTONEReturn the milestone.

Input Parameters

integer
required
the id of the project
integer
required
the id of the milestone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_NEXT_REFERENCE_NUMBERReturn the suggested reference number for the next manual accounting entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_NOTEReturn the note.

Input Parameters

integer
required
the id of the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ORDERReturn the order.

Input Parameters

integer
required
the id of the order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ORDER_PDFReturn an order PDF as a JSON object containing file metadata and base64-encoded content.

Input Parameters

integer
required
the id of the order
integer ("0" | "1")
Whether the PDF should be generated using the letterhead, or not.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_ORDER_REPETITIONReturn the repetition settings for a specified order.

Input Parameters

integer
required
the id of the order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_OUTGOING_PAYMENTReturn Outgoing Payment.

Input Parameters

string
required
id of Outgoing Payment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_PAGEBREAK_POSITIONReturn the pagebreak position.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Pagebreak positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_PAYMENTReturn a banking payment.

Input Parameters

string
required
The payment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_PERMISSIONSReturn access information of logged in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_PROJECTReturn the project.

Input Parameters

integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_PURCHASE_ORDERReturn the single purchase order.

Input Parameters

integer
required
the id of the purchase order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_QUOTEReturn the quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_QUOTE_PDFReturn a quote PDF with its content encoded in base64 and associated file metadata.

Input Parameters

integer
required
the id of the quote
integer ("0" | "1")
Whether the PDF should be generated using the letterhead, or not.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_SALUTATIONReturn the salutation.

Input Parameters

integer
required
the id of the salutation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_SUBPOSITION_POSITIONReturn a sub position from a quote, order or invoice.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Sub positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_SUBTOTAL_POSITIONReturn the subtotal position.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Subtotal positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_TASKReturn the task.

Input Parameters

integer
required
the id of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_TAXReturn the tax.

Input Parameters

integer
required
the id of the tax

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_TEXT_POSITIONReturn a text position from a quote, order, or invoice.

Input Parameters

integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Text positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_TIMESHEETReturn the timesheet.

Input Parameters

integer
required
the id of the timesheet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_TITLEReturn the title.

Input Parameters

integer
required
the id of the title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_UNITReturn the unit.

Input Parameters

integer
required
the id of the unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_USERReturn the user.

Input Parameters

integer
required
the id of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_VAT_PERIODReturn the vat period.

Input Parameters

integer
required
the id of the vat_period

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_GET_WORK_PACKAGEReturn the work package.

Input Parameters

integer
required
the id of the work package
integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_ISSUE_DELIVERYIssue a delivery.

Input Parameters

integer
required
the id of the delivery

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_ISSUE_INVOICEIssue an invoice.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_ISSUE_QUOTEIssue a quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ACCOUNT_GROUPSReturn one page of account groups.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ACCOUNTSReturn one page of accounts.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ADDITIONAL_ADDRESSESReturn one page of additional addresses for a specified contact.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name" | "postcode" | "country_id")
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.
integer
required
the id of the contact
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_BANK_ACCOUNTSReturn one page of bank accounts.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_BILLSReturn Bills, one page at a time.

Input Parameters

string
field to sort by
integer
Limit the number of results (max is 500)
string
sorting order
string
filter for Bill ‘title’, text containing in field
array
fields for which search will be run (if no ‘fields[]’ is specified than searching will be done for all allowed fields)
string ("DRAFTS" | "TODO" | "PAID" | "OVERDUE")
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
string
filter for Bill ‘vendor’, text containing in fields lastname_company and firstname_suffix
number
filter for Bill ‘net’, the greatest accepted value
number
filter for Bill ‘net’, the lowest accepted value
number
filter for Bill ‘gross’, the greatest accepted value
number
filter for Bill ‘gross’, the lowest accepted value
string
filter for Bill ‘vendor_ref’, text containing in field
string
filter for Bill ‘document_no’, text containing in field
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
term for which application will look for (minimum 3 signs, maximum 255 signs)
integer
filter for Bill ‘supplier_id’
string
filter for Bill ‘due_date’, the latest accepted date
string
filter for Bill ‘bill_date’, the latest accepted date
string
filter for Bill ‘currency_code’, text containing in field
string
filter for Bill ‘due_date’, the earliest accepted date
string
filter for Bill ‘bill_date’, the earliest accepted date
number
filter for Bill ‘pending_amount’, the greatest accepted value
number
filter for Bill ‘pending_amount’, the lowest accepted value
boolean
indicates whether ‘average_exchange_rate_enabled’ is enabled, or not

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_BUSINESS_ACTIVITIESReturn one page of business activities.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_BUSINESS_YEARSReturn one page of business years.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CALENDAR_YEARSReturn one page of calendar years.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_COMMENTSReturn one page of comments on a quote, order, or invoice.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_COMMUNICATION_TYPESReturn one page of communication types.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_COMPANY_PROFILEReturn company profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CONTACT_GROUPSReturn one page of contact groups.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CONTACT_RELATIONSReturn one page of contact relations.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "contact_id" | "contact_sub_id" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CONTACTSReturn one page of contacts.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "nr" | "name_1" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
boolean
Show archived elements only

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CONTACT_SECTORSReturn one page of contact sectors.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_COUNTRIESReturn one page of countries.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name" | "name_short")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CURRENCIESReturn one page of currencies.

Input Parameters

string
the validity date for the fetched exchange rate
string
The embed parameters is being used for embedding related resources in the response.

Example
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
integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_CURRENCY_CODESReturn possible currency codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_DEFAULT_POSITIONSReturn one page of default positions.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Default positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_DELIVERIESReturn one page of deliveries.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_DISCOUNT_POSITIONSReturn one page of discount positions.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Discount positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_DOCUMENT_SETTINGSList document settings.

Input Parameters

string ("id" | "text")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_DOCUMENT_TEMPLATEList document templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_EMPLOYEE_ABSENCESRetrieving absences of employee for given year.

Input Parameters

string
required
Id of an employee
integer
required
Year of absence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_EMPLOYEESRetrieves all active employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_EXCHANGE_RATES_FOR_CURRENCYReturn exchange rates for a specified currency, optionally for a validity date.

Input Parameters

string
the validity date for the fetched exchange rate
integer
required
the id of the currency

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_EXPENSESReturn Expenses, one page at a time.

Input Parameters

string
field to sort by
integer
results per page
string
sorting order
string
filter for Expense ‘title’, text containing in field
string
filter for Expense ‘vendor’, text containing in fields lastname_company and firstname_suffix
number
filter for Expense ‘net’, the greatest accepted value
number
filter for Expense ‘net’, the lowest accepted value
number
filter for Expense ‘gross’, the greatest accepted value
number
filter for Expense ‘gross’, the lowest accepted value
string
filter for Expense ‘project_id’
string
filter for Expense ‘document_no’, text containing in field
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
filter for Expense ‘paid_on’, the latest accepted date
integer
filter for Expense ‘supplier_id’
string
filter for Expense ‘currency_code’, text containing in field
string
filter for Expense ‘paid_on’, the earliest accepted date
string
filter for Expense ‘created_at’, the latest accepted date
string
filter for Expense ‘created_at’, the earliest accepted date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_FICTIONAL_USERSReturn one page of fictional users.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_FILESReturn one page of files.

Input Parameters

string ("id" | "created_at" | "source_id" | "uuid" | "name" | "size_in_bytes")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
Include/Exclude archived files via filter (all, archived, not_archived)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_INVOICE_PAYMENTSReturn one page of payments.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
the id of the invoice
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_INVOICE_REMINDERSList reminders for an invoice.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_INVOICESReturn one page of invoices.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ITEM_POSITIONSReturn one page of item positions for a quote, order, or invoice.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ITEMSReturn one page of items.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "intern_name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_JOURNAL_ENTRIESJournal, one page at a time.

Input Parameters

string
Can be used to filter for entries until this date
string
Can be used to filter for entries after this date
integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
Can be used to filter for entries with account with uuid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_LANGUAGESReturn one page of languages.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_MANUAL_COMPOUND_ENTRY_FILESReturn files of manual compound entry, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_MANUAL_ENTRIESReturn one page of manual entries.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_MANUAL_ENTRY_FILESReturn files of manual entry line, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
the id of a single entry in the manual_entry object
string
Opaque continuation cursor returned by the previous call; omit for the first page.
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_MILESTONESReturn one page of milestones for a specified project.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
the id of the project
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_NOTESReturn one page of notes.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_ORDERSReturn one page of orders.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_OUTGOING_PAYMENTSRetrieve outgoing payments for a specified bill, one page at a time.

Input Parameters

string
field to sort by
integer
results per page
string ("asc" | "desc")
sorting order
string
required
id of Bill for which Outgoing Payments were created
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PAGEBREAK_POSITIONSReturn one page of pagebreak positions.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Pagebreak positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PAYMENTSReturn one page of payments.

Input Parameters

integer
Limit the number of results (max is 2000)
string
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PAYMENT_TYPESReturn one page of payment types.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name" | "name_short")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PROJECTSReturn one page of projects.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PROJECT_STATUSProject status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PROJECT_TYPEProject types.

Input Parameters

string ("id" | "name")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_PURCHASE_ORDERSReturn one page of purchase orders.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_QUOTESReturn one page of quotes.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_SALUTATIONSReturn one page of salutations.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_STOCK_AREASReturn one page of stock areas.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_STOCK_LOCATIONSReturn one page of stock locations.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_SUBPOSITION_POSITIONSReturn one page of sub positions.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Sub positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_SUBTOTAL_POSITIONSReturn one page of subtotal positions.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Subtotal positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TASK_PRIORITIESTask priorities, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TASKSReturn one page of tasks.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "finish_date")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TASK_STATUSTask status, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TAXESReturn one page of taxes.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TEXT_POSITIONSReturn one page of text positions for a quote, order, or invoice.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
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
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Text positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TIMESHEETSReturn one page of timesheets.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "date")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TIME_SHEET_STATUSTimesheet status, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_TITLESReturn one page of titles.

Input Parameters

integer
Limit the number of results (max is 2000)
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_UNITSReturn one page of units.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_USERSReturn one page of users.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_VAT_PERIODSReturn one page of vat periods.

Input Parameters

integer
Limit the number of results (max is 2000)
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_LIST_WORK_PACKAGESReturn one page of work packages.

Input Parameters

integer
Limit the number of results (max is 2000)
integer
required
the id of the project
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_MARK_AS_SENT_INVOICEMark invoice as sent.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_MARK_AS_SENT_INVOICE_REMINDERMark reminder as sent.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the reminder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_MARK_AS_SENT_QUOTEMark quote as sent.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_MARK_AS_UNSENT_INVOICE_REMINDERMark reminder as unsent.

Input Parameters

integer
required
the id of the invoice
integer
required
the id of the reminder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_PREVIEW_FILEReturn file preview.

Input Parameters

integer
required
File ID to get preview file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_REISSUE_QUOTEReissue a quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_RESTORE_CONTACTRestore a contact.

Input Parameters

integer
required
the id of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_REVERT_ISSUE_INVOICESets issued invoice to draft.

Input Parameters

integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_REVERT_ISSUE_QUOTERevert issue a quote.

Input Parameters

integer
required
the id of the quote

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_ACCOUNTSSearch Accounts, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_ADDITIONAL_ADDRESSESSearch additional addresses for a specified contact, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name" | "postcode" | "country_id")
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.
integer
required
the id of the contact
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_BUSINESS_ACTIVITIESSearch business activities, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_CALENDAR_YEARSSearch calendar years, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. Each filter must follow the documented field, value, and criteria schema.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_COMMUNICATION_TYPESSearch communication types, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_CONTACTSearch contacts, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "nr" | "name_1" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
boolean
Show archived elements only

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_CONTACT_GROUPSSearch contact groups, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_CONTACT_RELATIONSSearch contact relations, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "contact_id" | "contact_sub_id" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_CONTACT_SECTORSSearch contact sectors, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_COUNTRIESSearch countries, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name" | "name_short")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_FILESSearch files, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. Each filter must follow the documented field, value, and criteria schema.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
Include/Exclude archived files via filter (all, archived, not_archived)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_INVOICESSearch invoices, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_ITEMSSearch items, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "intern_name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_LANGUAGESSearch languages, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_NOTESSearch notes, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_ORDERSSearch orders, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_PAYMENT_TYPESSearch payment types, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name" | "name_short")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_PROJECTSSearch projects, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_QUOTESSearch quotes, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "total" | "total_net" | "total_gross" | "updated_at")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_REMINDERSSearch reminders for a specified invoice using filters.

Input Parameters

array
required
Search filters. Each filter must follow the documented field, value, and criteria schema.
integer
required
the id of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_SALUTATIONSSearch salutations, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_STOCK_AREASSearch stock areas, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_STOCK_LOCATIONSSearch stock locations, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_TASKSSearch tasks, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "finish_date")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_TIMESHEETSSearch timesheets, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. Each filter must follow the documented field, value, and criteria schema.
string ("id" | "date")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_TITLESSearch titles, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string ("id" | "name")
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.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEARCH_UNITSSearch units, one page at a time.

Input Parameters

integer
Limit the number of results (max is 2000)
array
required
Search filters. At least one documented field, value, and criteria filter is required.
string
Opaque continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEND_INVOICESend an invoice. Applies the state-changing action immediately.

Input Parameters

string
required
The placeholder “[Network Link]” must be part of the text.
string
required
The subject.
boolean
Attach PDF directly to the email
integer
required
the id of the invoice
boolean
The mark as open.
string
required
During the trial period, the recipient is limited to the email address associated to the access token provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEND_INVOICE_REMINDERSend an invoice reminder. Applies the state-changing action immediately.

Input Parameters

string
required
The placeholder “[Network Link]” must be part of the text.
string
required
The subject.
integer
required
the id of the invoice
integer
required
the id of the reminder
string
required
During the trial period, the recipient is limited to the email address associated to the access token provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_SEND_QUOTESend a quote. Applies the state-changing action immediately.

Input Parameters

string
required
The placeholder “[Network Link]” must be part of the text.
string
required
The subject.
integer
required
the id of the quote
boolean
Attach PDF directly to the email
boolean
The mark as open.
string
required
During the trial period, the recipient is limited to the email address associated to the access token provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UNARCHIVE_PROJECTUnarchive a project.

Input Parameters

integer
required
the id of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_ADDITIONAL_ADDRESSEdit an additional address.

Input Parameters

string
The city.
string
The name.
string
The subject.
string
The postcode.
integer
required
the id of the contact
integer
References a country object
string
The description.
string
Is required if house_number or address_addition are not NULL
string
Requires street_name if the value is not NULL
string
The name addition.
string
Requires street_name if the value is not NULL
integer
required
the id of the additional address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_BILLUpdate Bill.

Input Parameters

string
required
id of Bill to update
string
The title.
object
required
Address
object
The payment.
string
required
The due date.
boolean
required
The item net.
string
required
The bill date.
array
required
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.
number
Required when ‘manual_amount’ is true. Maximum of 17 digits and maximum of 2 decimal digits.
array
required
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.
string
The vendor ref.
number
Required when ‘manual_amount’ is false. Maximum of 17 digits and maximum of 2 decimal digits.
string
The document no.
integer
required
The supplier id.
string
required
The currency code.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits.
boolean
required
Indicates whether ‘amount_man’ or ‘amount_calc’ is required and considered as bill amount
array
required
The attachment ids.
integer
required
The contact partner id.
number
Maximum of 17 digits and maximum of 2 decimal digits.
boolean
required
Indicates whether Bill has multiple items (true) or single item (false). By items it means ‘line_items’ and ‘discounts’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_BILL_BOOKING_STATUSUpdate a bill’s booking status to DRAFT or BOOKED.

Input Parameters

string
required
id of Bill to update
string ("DRAFT" | "BOOKED")
required
Bill status to update to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_CONTACTEdit a contact.

Input Parameters

string
The fax.
string
The url.
string
The city.
string
The mail.
string
required
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
string
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
string
The remarks.
integer
required
References a user object
string
The birthday.
integer
required
The owner id.
string
The postcode.
integer
References a title object
integer
required
the id of the contact
integer
References a country object
string
The skype name.
integer
References a language object
string
The mail second.
string
The phone fixed.
string
Is required if house_number or address_addition are not NULL
string
Requires street_name if the value is not NULL
string
The phone mobile.
integer
References a salutation object
string
Contact number. Omit it to let bexio assign the number automatically; when supplied, use numeric text.
integer
required
Please use the value 1 for companies or 2 for persons
integer
The salutation form.
string
Requires street_name if the value is not NULL
string
References one ore multiple contact group objects
string
References one ore multiple contact sector objects
string
The phone fixed second.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_CONTACT_GROUPEdit a contact group.

Input Parameters

string
required
The name.
integer
required
the id of the contact group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_CONTACT_RELATIONEdit a contact relation.

Input Parameters

string
required
References a contact object
string
The description.
string
required
References a contact object
integer
required
the id of the contact relation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_COUNTRYEdit a country.

Input Parameters

string
required
The name.
integer
required
the id of the country
string
required
The name short.
string
required
The iso3166 alpha2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_CURRENCYUpdate the round factor of a currency.

Input Parameters

object
required
Request data matching the documented operation schema.
integer
required
the id of the currency

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_DEFAULT_POSITIONEdit a default position on a quote, order, or invoice.

Input Parameters

string
The text.
string
The amount.
integer
References a tax object 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).
integer
References a unit object
integer
References an account object
string
The price of one unit (max. 6 decimals)
string
The amount open.
integer
required
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
boolean
Only in the case of quotes or Orders
integer
required
the id of the position
string
The amount reserved.
string
The amount completed.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Default positions can be added to quotes, orders and invoices
string
The discount (max. 6 decimals)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_DISCOUNT_POSITIONEdit a discount position.

Input Parameters

string
The text.
string
The value.
integer
required
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
integer
required
the id of the position
boolean
The is percentual.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Discount positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_EMPLOYEEUpdate employee.

Input Parameters

string
The iban.
string
The email.
string ("male" | "female")
The gender.
object
The address.
string ("de" | "it" | "fr" | "en")
The language.
string
The last name.
string
The ahv number.
string
The first name.
string
required
Id of an employee
string
Nation should be in ISO Alpha-2 format. Special values: ‘11’ means ‘unknown’, ‘22’ means ‘stateless’.
string
The phone number.
string
The date of birth.
string ("unknown" | "single" | "married" | "separated" | "registered_partnership" | "partnership_dissolved_by_law" | "partnership_dissolved_by_death" | "partnership_dissolved_by_declaration_of_lost" | "widowed" | "divorced")
The marital status.
string
The personal number.
integer
The annual vacation days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_EMPLOYEE_ABSENCEUpdating existing absence.

Input Parameters

string
required
Currently supported reasons: Injury, Sickness, MaternityLeave, MilitaryLeave, Vacation, InterruptionOfWork. New reasons might be added in the future.
string
required
The end date.
boolean
required
The half day.
string
required
Id of an absence
number
required
The disability.
number
required
The paid hours.
string
required
The start date.
string
required
Id of an employee
number
required
The continued pay.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_EXPENSEUpdate Expense.

Input Parameters

string
required
id of Expense to update
string
The title.
number
required
Maximum of 17 digits and maximum of 2 decimal digits.
integer
The tax id.
object
Address
string
required
The paid on.
string
The document no.
integer
The supplier id.
string
required
The currency code.
number
Required when ‘currency_code’ is different from ‘base_currency_code’ (taken from settings). Maximum of 5 digits and maximum of 10 decimal digits.
array
required
List of file ids that should be attached to this Expense. Cannot have duplicates.
integer
The bank account id.
integer
The booking account id.
number
Maximum of 17 digits and maximum of 2 decimal digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_EXPENSE_BOOKING_STATUSUpdate Expense status.

Input Parameters

string
required
Id of Expense to update
string ("DRAFT" | "DONE")
required
Expense status to update to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_FICTIONAL_USERUpdate a fictional User.

Input Parameters

string
required
The email address of the fictional user. Please note that an email address can only be used once for both regular and fictional users.
string
required
The last name of the fictional user
integer
A reference to a title
string
required
The first name of the fictional user
string ("male" | "female")
required
The salutation type.
integer
required
the id of the fictional user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_FILEUpdate an existing file’s metadata, including its name, archived state, or source type.

Input Parameters

string
The name of the file
integer
required
File ID to show
boolean
Define archived state
string ("web" | "email" | "mobile")
type of the source (web, mobile, etc.) this file has been uploaded from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_INVOICEEdit an invoice.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
string
The reference.
integer
References a contact object
integer
required
the id of the invoice
integer
References a currency object
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784
string
The is valid to.
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_ITEMEdit an item.

Input Parameters

integer
The width.
integer
The height.
integer
The volume.
integer
The weight.
string
The remarks.
integer
References a unit object
integer
References a user object (Currently, it has no impact, regardless of which user_id is sent.)
integer
References a stock location object
integer
Please note that the stock number can only be set if no bookings for this product have been made.
string
The html text.
integer
References an account object
integer
required
the id of the item
integer
References a contact object
string
The sale price.
number
The sale total.
integer
References a currency object
string
The intern code.
string
The intern name.
integer
The stock min nr.
integer
References a tax object
string
The deliverer code.
string
The deliverer name.
number
The delivery price.
string
The purchase price.
number
The purchase total.
integer
References a stock area object
integer
References a tax object
integer
The article group id.
integer
References an account object
string
The intern description.
string
The deliverer description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_ITEM_POSITIONEdit an item position on a quote, order, or invoice.

Input Parameters

string
The text.
string
The amount.
integer
References a tax object 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).
integer
References a unit object
integer
References an account object
integer
References an item object
string
The price of one unit (max. 6 decimals)
string
The amount open.
integer
required
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
boolean
Only valid in the case of Quotes or Orders
integer
required
the id of the position
string
The amount reserved.
string
The amount completed.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Item positions can be added to quotes, orders and invoices
string
The discount (max. 6 decimals)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_MANUAL_ENTRYUpdate manual entry.

Input Parameters

string
required
the booking date
string ("manual_single_entry" | "manual_compound_entry" | "manual_group_entry")
required
Choose one of the following three types:

manual_single_entry
Can be used to create a simple one line booking such as: | debit account | credit account | amount | |-----|------|----:| | 1020 | 3200 | 13600 | manual_compound_entry
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: | debit account | credit account | amount | |-----|------|----:| | 1020 | | 25000 | | | 3200 | 10000 | | | 3201 | 8000 | | | 3202 | 7000 | manual_group_entry
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: | debit account | credit account | amount | |-----|------|----:| | 1020 | 3200 | 13600 | | 1021 | 3201 | 7230 |
array
required
The entries.
string
A reference number for the booking
integer
required
The id of the manual entry to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_MILESTONEEdit a milestone.

Input Parameters

string
required
The name of the milestone
string
Description for milestone
string
The end date for the milestone
integer
required
the id of the project
integer
required
the id of the milestone
integer
Higher level milestone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_NOTEEdit a note.

Input Parameters

string
The info.
integer
required
the id of the note
string
required
The subject.
integer
required
References a user object
integer
The entry id.
integer
The module id.
integer
References a contact object
string
required
The event start.
integer
References a project object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_ORDEREdit an order.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer
required
the id of the order
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
integer
References a contact object
integer
References a currency object
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
integer ("0" | "1")
| value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_ORDER_REPETITIONEdit an order’s repetition.

Input Parameters

string
Date until the repetition is supposed to run. If empty indefinite repetition is assumed.
string
The start.
integer
required
the id of the order
string
Four different formats can be used to define the repetition. Either type daily, weekly, monthly or type yearly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_OUTGOING_PAYMENTEdit Outgoing Payment.

Input Parameters

number
required
Must be less or equal to Bill’s ‘pending_amount’. Maximum of 17 digits and maximum of 2 decimal digits.
string
Not allowed for QR, MANUAL, CASH_DISCOUNT.
string ("BY_SENDER" | "BY_RECEIVER" | "BREAKDOWN" | "NO_FEE")
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.
string
required
The payment id.
string
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.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
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.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
required
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.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
boolean
required
Allowed to be set to true only for IBAN.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
Required for IBAN, QR. Not allowed for MANUAL, CASH_DISCOUNT.
string
The receiver country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_PAGEBREAK_POSITIONEdit a pagebreak position.

Input Parameters

boolean
The pagebreak.
integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Pagebreak positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_PAYMENTUpdate a payment.

Input Parameters

object
required
Request data matching the documented operation schema.
string
required
The payment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_PROJECTEdit a project.

Input Parameters

string
required
The name.
string
The comment.
integer
required
References a user object
string
The end date.
integer
required
References a contact object
integer
required
the id of the project
string
The start date.
string
Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001721
integer
required
References a project status object
integer
References a contact object
number
The following budget types are available: | Id | Name | Description | | ------ | ------ | ------ | | 1 | type_budgeted_costs | Total budget costs | | 2 | type_budgeted_hours | Total budget hours | | 3 | type_service_budget | Budget for each client services | | 4 | type_service_employees | Budget for each employee |
integer
The following invoice types are available: | Id | Name | Description | | ------ | ------ | ------ | | 1 | type_hourly_rate_service | Hourly rate for client services | | 2 | type_hourly_rate_employee | Hourly rate for employee | | 3 | type_hourly_rate_project | Hourly rate for project | | 4 | type_fix | Fix price for project |
integer
required
References a project type object
string
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)
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_PURCHASE_ORDERUpdate a single purchase order.

Input Parameters

integer
The id of the purchase order
string
The mail address of the company
string
The title.
The footer.
string
The header.
integer
References a user object
object
The currency.
object
The language.
string ("included" | "excluded" | "exempt")
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
string
A reference which can be added to the document by the client.
integer
References a contact object
string
Creation date of the purchase order
integer
References a project object
string
Last time when purchase order was updated
integer
References a currency object
string
The date format.
string
The document nr.
string
The is valid to.
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
string
The template slug.
integer
References a contact object
string
The is valid until.
integer
References a bank account object
boolean
The is compact view.
integer
References a payment type object
integer
References a user object
integer
The maximum number of decimal digits to display for prices (line item prices, totals, etc.).
integer
required
the id of the purchase order
integer
The maximum number of decimal digits to display for amounts (number of items).
object
The custom translations.
boolean
The show position taxes.
string ("contact_address" | "manual")
The delivery address type.
string
Additional text which is displayed below the terms of payment
string
The contact address for the document. Newlines are in the format \n
integer
The kb payment template id.
string
The delivery address for order. Newlines are in the format \n

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_QUOTEEdit a quote.

Input Parameters

string
The title.
The footer.
string
The header.
integer
References a user object
integer
required
the id of the quote
integer ("0" | "1" | "2")
| value | description | |-----|------| | 0 | including taxes | | 1 | excluding taxes | | 2 | exempt from taxes |
integer
References a contact object
integer
References a currency object
string
Can not be used if automatic numbering is activated in frontend-settings. Required if automatic numbering deactivated. https://help.bexio.com/s/article/000001784
integer
References a language object
boolean
This value affects the total if the field mwst_type has been set to 0.
false = Taxes are included in the total
true = Taxes will be added to the total
integer
The logopaper id.
string
This field can only be read and edited by the api. It can be used to save references to other systems.
string
The is valid from.
integer
References a project object
string
References a document template slug
integer
References a contact object
string
The is valid until.
integer
References a bank account object
integer
References a payment type object
boolean
The show position taxes.
string
The viewed by client at.
integer ("0" | "1")
| value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |
string
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.
string
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.
integer
The kb terms of payment template id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_SALUTATIONEdit a salutation.

Input Parameters

string
required
The name.
integer
required
the id of the salutation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_SUBPOSITION_POSITIONEdit a sub position on a quote, order or invoice.

Input Parameters

string
The text.
integer
required
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
integer
required
the id of the position
boolean
The show pos nr.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Sub positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_SUBTOTAL_POSITIONEdit a subtotal position.

Input Parameters

string
The text.
integer
required
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
integer
required
the id of the position
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Subtotal positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_TASKEdit a task.

Input Parameters

string
The info.
string
required
The subject.
integer
required
the id of the task
integer
required
References a user object
integer
The entry id.
integer
The module id.
integer
References a contact object
string
The finish date.
boolean
The have remember.
integer
References a project object
integer
References a contact object
integer
The todo status id.
integer
Is required if have_remember is set to true.
integer
Is required if have_remember is set to true.
integer
The todo priority id.
integer
The communication kind id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_TEXT_POSITIONEdit a text position on a quote, order, or invoice.

Input Parameters

string
The text.
integer
required
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
integer
required
the id of the position
boolean
The show pos nr.
string ("kb_offer" | "kb_order" | "kb_invoice")
required
The type of the document. Text positions can be added to quotes, orders and invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_TIMESHEETEdit a timesheet with range-based time tracking.

Input Parameters

string
The text.
string
The charge.
integer
required
References a user object
object
required
Two different formats can be used to submit the tracked time. Either type range or type duration.
integer
References a timesheet status object
integer
References a contact object
integer
required
the id of the timesheet
integer
The pr package id.
integer
References a project object
boolean
required
The allowable bill.
string
The estimated time.
integer
References a contact object
integer
The pr milestone id.
integer
required
References a business activity object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_TITLEEdit a title.

Input Parameters

string
required
The name.
integer
required
the id of the title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_UNITEdit a unit.

Input Parameters

string
required
The name.
integer
required
the id of the unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPDATE_WORK_PACKAGEEdit a work package.

Input Parameters

string
required
The name of the work package
string
Description for work package
integer
required
the id of the work package
integer
required
the id of the project
integer
References a milestone object
number
time spent on work package
number
estimated time on work package

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPLOAD_MANUAL_COMPOUND_ENTRY_FILEAdd file to manual compound entry.

Input Parameters

object
required
File to upload. Call this action once per file to upload multiple files.
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEXIO_UPLOAD_MANUAL_ENTRY_FILEAdd file to manual entry line.

Input Parameters

object
required
File to upload. Call this action once per file to upload multiple files.
integer
required
the id of a single entry in the manual_entry object
integer
required
the id of the manual_entry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not