The bexio connector lets your AI agent act in each user's bexio account. Each user connects their own bexio access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 33 · 23 · 433 read23 write4 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the bexio connection
In AgentKit > Connections, create a bexio connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'bexio'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize bexio:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'bexio_accounts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "bexio"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize bexio:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="bexio_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their bexio credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbexio_accounts_listList the chart of accounts.Read-onlyList Accounts
List the chart of accounts. Returns an array of objects with id, uuid, account_no, name, account_type, tax_id, fibu_account_group_id, is_active. Use bexio_accounts_list to find an account ID.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
bexio_bill_getGet one supplier bill.Read-onlyGet Supplier Bill
Get one supplier bill. Returns an object with id, document_no, title, status, firstname_suffix, lastname_company, created_at, supplier_id, vendor_ref, pending_amount, and more. Use bexio_bill_get for one bill.
Inputs
bill_idstringrequired- Bill ID (UUID). Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
bexio_bills_listList supplier bills (purchase invoices), filtered by status or date.Read-onlyList Supplier Bills
List supplier bills (purchase invoices), filtered by status or date. Returns data[] (each with id, document_no, title, status, firstname_suffix, lastname_company, vendor, created_at) plus paging. Use bexio_bills_list to review payables. Use bexio_bill_get for one bill.
Inputs
average_exchange_rate_enabledboolean- Indicates whether 'average_exchange_rate_enabled' is enabled, or not. Example: False
bill_date_endstring- Filter for Bill 'bill_date', the latest accepted date. Example: 2019-04-27
bill_date_startstring- Filter for Bill 'bill_date', the earliest accepted date. Example: 2019-04-19
currency_codestring- Filter for Bill 'currency_code', text containing in field. Example: CHF
document_nostring- Filter for Bill 'document_no', text containing in field. Example: DC-123
due_date_endstring- Filter for Bill 'due_date', the latest accepted date. Example: 2019-05-27
due_date_startstring- Filter for Bill 'due_date', the earliest accepted date. Example: 2019-05-19
gross_maxnumber- Filter for Bill 'gross', the greatest accepted value. Example: 465.75
gross_minnumber- Filter for Bill 'gross', the lowest accepted value. Example: 438.32
limitinteger- Maximum number of results (up to 500). Example: 100
net_maxnumber- Filter for Bill 'net', the greatest accepted value. Example: 465.75
net_minnumber- Filter for Bill 'net', the lowest accepted value. Example: 438.32
orderstring- Sorting order. Example: ['asc', 'desc']
pageinteger- Page number. Example: 1
pending_amount_maxnumber- Filter for Bill 'pending_amount', the greatest accepted value. Example: 465.75
pending_amount_minnumber- Filter for Bill 'pending_amount', the lowest accepted value. Example: 438.32
search_termstring- Term for which application will look for (minimum 3 signs, maximum 255 signs) Example: term
sortstring- Field to sort by. Example: document_no
statusstring- 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], OVERD... One of: DRAFTS, TODO, PAID, OVERDUE. Example: TODOone of
DRAFTSTODOPAIDOVERDUE supplier_idinteger- Filter for Bill 'supplier_id'. Example: 1234
titlestring- Filter for Bill 'title', text containing in field. Example: Some Title
vendorstring- Filter for Bill 'vendor', text containing in fields lastname_company and firstname_suffix. Example: bexio ag
vendor_refstring- Filter for Bill 'vendor_ref', text containing in field. Example: reference
bexio_company_profile_listGet the company profile (name, address, VAT number, bank details).Read-onlyGet Company Profile
Get the company profile (name, address, VAT number, bank details). Returns an array of objects with id, name, address, address_nr, postcode, city, country_id, legal_form. Use bexio_company_profile_list for the company details of the account.
Inputs
This tool takes no inputs.
bexio_contact_getGet one contact with address, email, phone and groups.Read-onlyGet Contact
Get one contact with address, email, phone and groups. Returns an object with id, nr, contact_type_id, name_1, name_2, salutation_id, salutation_form, title_id, titel_id, birthday, and more. Use bexio_contact_get for one contact.
Inputs
contact_idintegerrequired- Contact ID, from bexio_contacts_list or bexio_contacts_search. Example: 4
show_archivedboolean- Show archived elements only. Example: True
bexio_contact_groups_listList contact groups.Read-onlyList Contact Groups
List contact groups. Returns an array of objects with id, name. Use bexio_contact_groups_list to find contact_group_ids.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, name. Example: id_descone of
idname
bexio_contact_relations_listList relations between contacts (for example a person working at a company).Read-onlyList Contact Relations
List relations between contacts (for example a person working at a company). Returns an array of objects with id, contact_id, contact_sub_id, description, updated_at. Use bexio_contact_relations_list to see who belongs to which company.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, contact_id, contact_sub_id, updated_at. Example: id_descone of
idcontact_idcontact_sub_idupdated_at
bexio_contacts_listList contacts (companies and people).Read-onlyList Contacts
List contacts (companies and people). Returns an array of objects with id, nr, contact_type_id, name_1, name_2, salutation_id, salutation_form, title_id. Use bexio_contacts_list to browse. Use bexio_contacts_search to find contacts by name, email or other fields.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, nr, name_1, updated_at. Example: id_descone of
idnrname_1updated_at show_archivedboolean- If true, list archived contacts only. Example: false
bexio_contacts_searchSearch contacts by fields such as name_1, name_2, nr, mail, city, postcode or contact_group_ids.Read-onlySearch Contacts
Search contacts by fields such as name_1, name_2, nr, mail, city, postcode or contact_group_ids. Returns an array of objects with id, nr, contact_type_id, name_1, name_2, salutation_id, salutation_form, title_id. Use bexio_contacts_search to find a contact ID.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator (=, !=, >, <, >=, <=, like, not_like, is_null, not_null, in, not_in). Criteria are combined with AND. Example: [{"field": "name_1", "value": "Muster", "criteria": "like"}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, nr, name_1, updated_at. Example: id_descone of
idnrname_1updated_at show_archivedboolean- If true, search archived contacts only. Example: false
bexio_currencies_listList the currencies set up in the company.Read-onlyList Currencies
List the currencies set up in the company. Returns an array of objects with id, name, round_factor, exchange_rate, exchange_rate_id, ratio, exchange_rate_to_ratio, source. Use bexio_currencies_list to find a currency_id.
Inputs
datestring- The validity date for the fetched exchange rate. Example: 2019-05-17
embedstring- 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.
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
bexio_expenses_listList expenses.Read-onlyList Expenses
List expenses. Returns data[] (each with id, document_no, title, status, firstname_suffix, lastname_company, vendor, created_at) plus paging. Use bexio_expenses_list to review spending.
Inputs
created_at_endstring- Filter for Expense 'created_at', the latest accepted date. Example: 2020-01-27T13:08:01+0000
created_at_startstring- Filter for Expense 'created_at', the earliest accepted date. Example: 2020-01-24T13:08:01+0000
currency_codestring- Filter for Expense 'currency_code', text containing in field. Example: CHF
document_nostring- Filter for Expense 'document_no', text containing in field. Example: DC-123
gross_maxnumber- Filter for Expense 'gross', the greatest accepted value. Example: 465.75
gross_minnumber- Filter for Expense 'gross', the lowest accepted value. Example: 438.32
limitinteger- Maximum number of results (up to 500). Example: 100
net_maxnumber- Filter for Expense 'net', the greatest accepted value. Example: 465.75
net_minnumber- Filter for Expense 'net', the lowest accepted value. Example: 438.32
orderstring- Sorting order. Example: ['asc', 'desc']
pageinteger- Page number. Example: 1
paid_on_endstring- Filter for Expense 'paid_on', the latest accepted date. Example: 2019-04-27
paid_on_startstring- Filter for Expense 'paid_on', the earliest accepted date. Example: 2019-04-19
project_idstring- Filter for Expense 'project_id'. Example: 1a1864c0-ba80-46a8-ad89-ffd128db9456
sortstring- Field to sort by. Example: document_no
supplier_idinteger- Filter for Expense 'supplier_id'. Example: 1234
titlestring- Filter for Expense 'title', text containing in field. Example: Some Title
vendorstring- Filter for Expense 'vendor', text containing in fields lastname_company and firstname_suffix. Example: bexio ag
bexio_invoice_getGet one invoice with positions, totals, taxes and status.Read-onlyGet Invoice
Get one invoice with positions, totals, taxes and status. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_invoice_get for one invoice.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
bexio_invoice_payments_listList the payments recorded on an invoice.Read-onlyList Invoice Payments
List the payments recorded on an invoice. Returns an array of objects with id, date, value, bank_account_id, title, payment_service_id, is_client_account_redemption, is_cash_discount. Use bexio_invoice_payments_list to see what was paid.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
bexio_invoices_listList customer invoices.Read-onlyList Invoices
List customer invoices. Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_invoices_list to browse. Use bexio_invoices_search to filter by contact, status or date.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_invoices_searchSearch invoices by fields such as contact_id, kb_item_status_id, document_nr, title or is_valid_from.Read-onlySearch Invoices
Search invoices by fields such as contact_id, kb_item_status_id, document_nr, title or is_valid_from. Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_invoices_search to find open or overdue invoices.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator. Example: [{"field": "kb_item_status_id", "value": "8", "criteria": "="}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_item_getGet one item with prices, taxes and stock.Read-onlyGet Item
Get one item with prices, taxes and stock. Returns an object with id, user_id, article_type_id, contact_id, deliverer_code, deliverer_name, deliverer_description, intern_code, intern_name, intern_description, and more. Use bexio_item_get for one item.
Inputs
article_idintegerrequired- Item ID. Example: 3
bexio_items_listList items (products and services).Read-onlyList Items
List items (products and services). Returns an array of objects with id, user_id, article_type_id, contact_id, deliverer_code, deliverer_name, deliverer_description, intern_code. Use bexio_items_list to browse. Use bexio_items_search to find items by code or name.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, intern_name. Example: id_descone of
idintern_name
bexio_items_searchSearch items by fields such as intern_name, intern_code or contact_id.Read-onlySearch Items
Search items by fields such as intern_name, intern_code or contact_id. Returns an array of objects with id, user_id, article_type_id, contact_id, deliverer_code, deliverer_name, deliverer_description, intern_code. Use bexio_items_search to find an article_id for a document position.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator. Example: [{"field": "intern_name", "value": "Consulting", "criteria": "like"}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, intern_name. Example: id_descone of
idintern_name
bexio_notes_listList notes.Read-onlyList Notes
List notes. Returns an array of objects with id, user_id, event_start, subject, info, contact_id, project_id, pr_project_id. Use bexio_notes_list to read notes on contacts and projects.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
bexio_order_getGet one order with positions, totals and status.Read-onlyGet Order
Get one order with positions, totals and status. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_order_get for one order.
Inputs
order_idintegerrequired- Order ID. Example: 5
bexio_orders_listList sales orders.Read-onlyList Orders
List sales orders. Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_orders_list to browse. Use bexio_orders_search to filter.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_orders_searchSearch orders by fields such as contact_id, kb_item_status_id, document_nr or title.Read-onlySearch Orders
Search orders by fields such as contact_id, kb_item_status_id, document_nr or title. Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_orders_search to find an order ID.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator. Example: [{"field": "contact_id", "value": "4"}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_project_getGet one project.Read-onlyGet Project
Get one project. Returns an object with id, uuid, nr, document_nr, name, start_date, end_date, comment, pr_state_id, pr_project_type_id, and more. Use bexio_project_get for one project.
Inputs
project_idintegerrequired- Project ID. Example: 2
bexio_projects_listList projects.Read-onlyList Projects
List projects. Returns an array of objects with id, uuid, nr, document_nr, name, start_date, end_date, comment. Use bexio_projects_list to browse. Use bexio_projects_search to filter.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, name. Example: id_descone of
idname
bexio_projects_searchSearch projects by fields such as name, contact_id or pr_state_id.Read-onlySearch Projects
Search projects by fields such as name, contact_id or pr_state_id. Returns an array of objects with id, uuid, nr, document_nr, name, start_date, end_date, comment. Use bexio_projects_search to find a project ID.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator. Example: [{"field": "name", "value": "Website", "criteria": "like"}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, name. Example: id_descone of
idname
bexio_quote_getGet one quote with positions, totals and status.Read-onlyGet Quote
Get one quote with positions, totals and status. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_quote_get for one quote.
Inputs
quote_idintegerrequired- Quote ID, from bexio_quotes_list. Example: 7
bexio_quotes_listList quotes (offers).Read-onlyList Quotes
List quotes (offers). Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_quotes_list to browse. Use bexio_quotes_search to filter.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_quotes_searchSearch quotes by fields such as contact_id, kb_item_status_id, document_nr or title.Read-onlySearch Quotes
Search quotes by fields such as contact_id, kb_item_status_id, document_nr or title. Returns an array of objects with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id. Use bexio_quotes_search to find a quote ID.
Inputs
criteriaarrayrequired- Search criteria; each item has a field, a value and an optional criteria operator. Example: [{"field": "contact_id", "value": "4"}]
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, total, total_net, total_gross, updated_at. Example: id_descone of
idtotaltotal_nettotal_grossupdated_at
bexio_tasks_listList tasks.Read-onlyList Tasks
List tasks. Returns an array of objects with id, user_id, finish_date, subject, place, info, contact_id, sub_contact_id. Use bexio_tasks_list to see open to-dos.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, finish_date. Example: id_descone of
idfinish_date
bexio_taxes_listList VAT rates with their IDs.Read-onlyList Taxes
List VAT rates with their IDs. Returns an array of objects with id, uuid, name, code, digit, type, account_id, tax_settlement_type. Use bexio_taxes_list to find tax_id values for document positions.
Inputs
datestring- Displays all taxes which are active at the date given. Example: 2018-03-17
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
scopestring- Can be used to filter for active or inactive taxes. One of: active, inactive. Example: activeone of
activeinactive typesstring- Filter the types of the tax. One of: sales_tax, pre_tax. Example: sales_taxone of
sales_taxpre_tax
bexio_timesheets_listList time entries.Read-onlyList Timesheets
List time entries. Returns an array of objects with id, user_id, status_id, client_service_id, text, allowable_bill, charge, contact_id. Use bexio_timesheets_list to review tracked time.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
order_bystring- Sort field, optionally with _asc or _desc; combine several with commas. One of: id, date. Example: id_descone of
iddate
bexio_user_me_getGet the bexio user the token belongs to.Read-onlyGet Current User
Get the bexio user the token belongs to. Returns an object with id, salutation_type, firstname, lastname, email, is_superadmin, is_accountant. Use bexio_user_me_get to check the connection and find your user_id.
Inputs
This tool takes no inputs.
bexio_users_listList the users of the bexio company.Read-onlyList Users
List the users of the bexio company. Returns an array of objects with id, salutation_type, firstname, lastname, email, is_superadmin, is_accountant. Use bexio_users_list to find a user_id for documents, tasks and timesheets.
Inputs
limitinteger- Maximum number of results (up to 2000, default 500). Example: 100
offsetinteger- Number of results to skip. Example: 0
bexio_contact_createCreate a contact: a company (contact_type_id 1) or a person (contact_type_id 2).WriteCreate Contact
Create a contact: a company (contact_type_id 1) or a person (contact_type_id 2). Returns an object with id, nr, contact_type_id, name_1, name_2, salutation_id, salutation_form, title_id, titel_id, birthday, and more. Use bexio_contact_create for a new customer or supplier.
Inputs
contact_type_idintegerrequired- Contact type: 1 company, 2 person. Example: 1
name_1stringrequired- Company name, or last name for a person. Example: Muster AG
owner_idintegerrequired- User who owns the contact. Example: 1
user_idintegerrequired- User responsible for the contact. Example: 1
address_additionstring- Requires street_name if the value is not NULL. Example: Building C
birthdaystring- Birthday of a person contact, YYYY-MM-DD. Example: 1985-04-12
citystring- City. Example: Zürich
contact_branch_idsstring- References one ore multiple contact sector objects. Example: abc123
contact_group_idsstring- Contact group IDs, comma-separated. Example: 1,2
country_idinteger- Country ID. Example: 1
house_numberstring- Requires street_name if the value is not NULL. Example: 77
language_idinteger- References a language object. Example: 12345
mailstring- Main email address. Example: info@muster.ch
name_2string- Company addition, or first name for a person. Example: Hans
nrstring- If set to null, the number will be assigned automatically. Must be a number, can also be used as integer. Example: example
phone_fixedstring- Landline phone number. Example: +41 44 123 45 67
phone_mobilestring- Mobile phone number. Example: +41 79 123 45 67
postcodestring- Postal code. Example: 8000
remarksstring- Free-text remarks. Example: Prefers email
salutation_idinteger- References a salutation object. Example: 2
street_namestring- Is required if house_number or address_addition are not NULL. Example: Smith Street
title_idinteger- References a title object. Example: 12345
urlstring- Website. Example: https://www.muster.ch
bexio_contact_updateUpdate a contact; only the fields you send change.WriteUpdate Contact
Update a contact; only the fields you send change. Returns an object with id, nr, contact_type_id, name_1, name_2, salutation_id, salutation_form, title_id, titel_id, birthday, and more. Use bexio_contact_update to edit a contact.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from bexio_contacts_list or bexio_contacts_search. Example: 4
address_additionstring- Requires street_name if the value is not NULL. Example: Building C
birthdaystring- Birthday of a person contact, YYYY-MM-DD. Example: 1985-04-12
citystring- City. Example: Zürich
contact_branch_idsstring- References one ore multiple contact sector objects. Example: abc123
contact_group_idsstring- References one ore multiple contact group objects. Example: 1,2
contact_type_idinteger- Contact type: 1 company, 2 person. Example: 1
country_idinteger- References a country object. Example: 1
house_numberstring- Requires street_name if the value is not NULL. Example: 77
language_idinteger- References a language object. Example: 12345
mailstring- Main email address. Example: info@muster.ch
name_1string- Company name, or last name for a person. Example: Muster AG
name_2string- Company addition, or first name. Example: Hans
nrstring- If set to null, the number will be assigned automatically. Must be a number, can also be used as integer. Example: example
owner_idinteger- User who owns the contact. Example: 1
phone_fixedstring- Landline phone number. Example: +41 44 123 45 67
phone_mobilestring- Mobile phone number. Example: +41 79 123 45 67
postcodestring- Postal code. Example: 8000
remarksstring- Free-text remarks. Example: Prefers email
salutation_idinteger- References a salutation object. Example: 2
street_namestring- Is required if house_number or address_addition are not NULL. Example: Smith Street
title_idinteger- References a title object. Example: 12345
urlstring- Website. Example: https://www.muster.ch
user_idinteger- References a user object. Example: 1
bexio_invoice_createCreate a draft invoice for a contact with line items.WriteCreate Invoice
Create a draft invoice for a contact with line items. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_invoice_create for a new invoice, then bexio_invoice_issue and bexio_invoice_send.
Inputs
contact_idintegerrequired- Customer contact ID. Example: 4
user_idintegerrequired- ID of the bexio user responsible for the document, from bexio_users_list. Example: 1
api_referencestring- This field can only be read and edited by the api. It can be used to save references to other systems. Example: example
bank_account_idinteger- References a bank account object. Example: 1
contact_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
contact_sub_idinteger- References a contact object. Example: 12345
currency_idinteger- References a currency object. Example: 1
document_nrstring- Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784. Example: RE-00001
footerstring- Text below the positions on the document. Example: Payable within 30 days.
headerstring- Text above the positions on the document. Example: Thank you for your order.
is_valid_fromstring- Document date, YYYY-MM-DD. Example: 2026-11-16
is_valid_tostring- Due date, YYYY-MM-DD. Example: 2026-12-16
language_idinteger- References a language object. Example: 1
mwst_is_netboolean- 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. Example: True
mwst_typeinteger- VAT handling: 0 including taxes, 1 excluding taxes, 2 exempt. One of: 0, 1, 2. Example: 0one of
012 payment_type_idinteger- References a payment type object. Example: 1
positionsarray- Line items. A custom position is {"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}; an item position uses "type": "KbPositionArticle" with article_id. Example: [{"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}]
pr_project_idinteger- References a project object. Example: 12345
referencestring- Your reference shown on the invoice. Example: PO-4711
show_position_taxesboolean- If true, show the tax of each position on the document. Example: false
template_slugstring- References a document template slug. Example: 581a8010821e01426b8b456b
titlestring- Document title. Example: Website redesign
bexio_invoice_issueIssue a draft invoice so it becomes open and gets its number.WriteIssue Invoice
Issue a draft invoice so it becomes open and gets its number. Returns an object with success. Use bexio_invoice_issue before sending.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
bexio_invoice_payment_createRecord a payment against an issued invoice.WriteRecord Invoice Payment
Record a payment against an issued invoice. Returns an object with id, date, value, bank_account_id, title, payment_service_id, is_client_account_redemption, is_cash_discount, kb_invoice_id, kb_credit_voucher_id, and more. Use bexio_invoice_payment_create when a customer has paid.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
valuestringrequired- Amount paid as a decimal string. Example: 1200.00
bank_account_idinteger- Bank account that received the money. Example: 1
datestring- Payment date, YYYY-MM-DD. Example: 2026-11-16
payment_service_idinteger- | value | description | |-----|------| | 1 | PayPal | | 2 | Stripe | | 3 | SIX Payments |. One of: 0, 1, 2. Example: 0one of
012
bexio_invoice_sendEmail an issued invoice to the customer.WriteSend Invoice
Email an issued invoice to the customer. Returns an object with success. Use bexio_invoice_send to deliver an invoice. This emails the recipient.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
messagestringrequired- Email text; it must contain the placeholder [Network Link]. Example: Dear customer, please find your invoice here: [Network Link]
recipient_emailstringrequired- Recipient email address. Example: billing@muster.ch
subjectstringrequired- Email subject. Example: Invoice RE-00012
attach_pdfboolean- Attach PDF directly to the email. Example: True
mark_as_openboolean- If true, mark the document as open (issued) when sending. Example: true
bexio_invoice_updateUpdate a draft invoice.WriteUpdate Invoice
Update a draft invoice. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_invoice_update to change a draft before issuing it.
- Idempotent
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
api_referencestring- This field can only be read and edited by the api. It can be used to save references to other systems. Example: example
bank_account_idinteger- References a bank account object. Example: 1
contact_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
contact_idinteger- Customer contact ID. Example: 4
contact_sub_idinteger- References a contact object. Example: 12345
currency_idinteger- References a currency object. Example: 1
document_nrstring- Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784. Example: RE-00001
footerstring- Text below the positions on the document. Example: Payable within 30 days.
headerstring- Text above the positions on the document. Example: Thank you for your order.
is_valid_fromstring- Document date, YYYY-MM-DD. Example: 2026-11-16
is_valid_tostring- Due date, YYYY-MM-DD. Example: 2026-12-16
language_idinteger- References a language object. Example: 1
mwst_is_netboolean- 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. Example: True
mwst_typeinteger- VAT handling: 0 including taxes, 1 excluding taxes, 2 exempt. One of: 0, 1, 2. Example: 0one of
012 payment_type_idinteger- References a payment type object. Example: 1
pr_project_idinteger- References a project object. Example: 12345
referencestring- Your reference shown on the invoice. Example: PO-4711
show_position_taxesboolean- If true, show the tax of each position on the document. Example: false
template_slugstring- References a document template slug. Example: 581a8010821e01426b8b456b
titlestring- Document title. Example: Website redesign
user_idinteger- ID of the bexio user responsible for the document, from bexio_users_list. Example: 1
bexio_item_createCreate an item (product or service).WriteCreate Item
Create an item (product or service). Returns an object with id, user_id, article_type_id, contact_id, deliverer_code, deliverer_name, deliverer_description, intern_code, intern_name, intern_description, and more. Use bexio_item_create to add something you sell.
Inputs
intern_namestringrequired- Item name. Example: Consulting hour
user_idintegerrequired- User ID. Example: 1
account_idinteger- References an account object. Example: 12345
article_type_idinteger- Item type: 1 physical product, 2 service. Example: 2
contact_idinteger- References a contact object. Example: 14
currency_idinteger- References a currency object. Example: 12345
expense_account_idinteger- References an account object. Example: 12345
intern_codestring- Item code. Example: CONS-1
intern_descriptionstring- Item description shown on documents. Example: One hour of consulting
is_stockboolean- Requires stock_edit scope to work. Example: False
purchase_pricestring- Purchase price as a decimal string. Example: 80.00
remarksstring- Free-text remarks. Example: Prefers email
sale_pricestring- Sale price as a decimal string. Example: 150.00
stock_idinteger- References a stock location object. Example: 12345
stock_nrinteger- Please note that the stock number can only be set if no bookings for this product have been made. Example: 0
stock_place_idinteger- References a stock area object. Example: 12345
tax_expense_idinteger- References a tax object. Example: 12345
tax_income_idinteger- References a tax object. Example: 12345
unit_idinteger- References a unit object. Example: 12345
bexio_item_updateUpdate an item; only the fields you send change.WriteUpdate Item
Update an item; only the fields you send change. Returns an object with id, user_id, article_type_id, contact_id, deliverer_code, deliverer_name, deliverer_description, intern_code, intern_name, intern_description, and more. Use bexio_item_update to change an item price or name.
- Idempotent
Inputs
article_idintegerrequired- Item ID. Example: 3
account_idinteger- References an account object. Example: 12345
contact_idinteger- References a contact object. Example: 14
currency_idinteger- References a currency object. Example: 12345
expense_account_idinteger- References an account object. Example: 12345
intern_codestring- Item code. Example: CONS-1
intern_descriptionstring- Item description shown on documents. Example: One hour of consulting
intern_namestring- Item name. Example: Consulting hour
is_stockboolean- Requires stock_edit scope to work. Example: False
purchase_pricestring- Purchase price as a decimal string. Example: 80.00
remarksstring- Free-text remarks. Example: Prefers email
sale_pricestring- Sale price as a decimal string. Example: 160.00
stock_idinteger- References a stock location object. Example: 12345
stock_nrinteger- Please note that the stock number can only be set if no bookings for this product have been made. Example: 0
stock_place_idinteger- References a stock area object. Example: 12345
tax_expense_idinteger- References a tax object. Example: 12345
tax_income_idinteger- References a tax object. Example: 12345
unit_idinteger- References a unit object. Example: 12345
user_idinteger- References a user object (Currently, it has no impact, regardless of which user_id is sent.) Example: 1
bexio_note_createCreate a note, optionally linked to a contact or project.WriteCreate Note
Create a note, optionally linked to a contact or project. Returns an object with id, user_id, event_start, subject, info, contact_id, project_id, pr_project_id, entry_id, module_id. Use bexio_note_create to log a call or meeting.
Inputs
event_startstringrequired- Date and time of the event. Example: 2026-11-16 14:00:00
subjectstringrequired- Note subject. Example: Call with Muster AG
user_idintegerrequired- Author user ID. Example: 1
contact_idinteger- References a contact object. Example: 14
infostring- Note text. Example: Agreed on a renewal in December.
pr_project_idinteger- References a project object. Example: 12345
bexio_order_createCreate a sales order for a contact with line items.WriteCreate Order
Create a sales order for a contact with line items. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_order_create for a confirmed sale.
Inputs
contact_idintegerrequired- Customer contact ID. Example: 4
user_idintegerrequired- ID of the bexio user responsible for the document, from bexio_users_list. Example: 1
api_referencestring- This field can only be read and edited by the api. It can be used to save references to other systems. Example: example
bank_account_idinteger- References a bank account object. Example: 1
contact_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
contact_sub_idinteger- References a contact object. Example: 12345
currency_idinteger- References a currency object. Example: 1
delivery_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
delivery_address_typeinteger- | value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |. One of: 0, 1. Example: 0one of
01 document_nrstring- Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784. Example: AU-00001
footerstring- Text below the positions on the document. Example: Payable within 30 days.
headerstring- Text above the positions on the document. Example: Thank you for your order.
is_valid_fromstring- Document date, YYYY-MM-DD. Example: 2026-11-16
language_idinteger- References a language object. Example: 1
mwst_is_netboolean- 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. Example: True
mwst_typeinteger- VAT handling: 0 including taxes, 1 excluding taxes, 2 exempt. One of: 0, 1, 2. Example: 0one of
012 payment_type_idinteger- References a payment type object. Example: 1
positionsarray- Line items. A custom position is {"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}; an item position uses "type": "KbPositionArticle" with article_id. Example: [{"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}]
pr_project_idinteger- References a project object. Example: 12345
show_position_taxesboolean- If true, show the tax of each position on the document. Example: false
template_slugstring- References a document template slug. Example: 581a8010821e01426b8b456b
titlestring- Document title. Example: Website redesign
bexio_order_invoice_createCreate an invoice from an order.WriteCreate Invoice from Order
Create an invoice from an order. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_order_invoice_create to bill an order.
Inputs
order_idintegerrequired- Order ID. Example: 5
positionsarray- Please note that the positions array can be omitted to create a document with all positions from the source document. Example: [{"key": "value"}]
bexio_project_archiveArchive a project.WriteArchive Project
Archive a project. Returns an object with success. Use bexio_project_archive when a project is finished.
- Idempotent
Inputs
project_idintegerrequired- Project ID. Example: 2
bexio_project_createCreate a project for a contact.WriteCreate Project
Create a project for a contact. Returns an object with id, uuid, nr, document_nr, name, start_date, end_date, comment, pr_state_id, pr_project_type_id, and more. Use bexio_project_create to start tracking work for a customer.
Inputs
contact_idintegerrequired- Customer contact ID. Example: 4
namestringrequired- Project name. Example: Website relaunch
pr_project_type_idintegerrequired- Project type ID: 1 internal, 2 customer project. Example: 2
pr_state_idintegerrequired- Project status ID: 1 active, 2 open, 3 archived. Example: 2
user_idintegerrequired- Responsible user ID. Example: 1
commentstring- Project comment. Example: Fixed price project
contact_sub_idinteger- References a contact object. Example: 12345
document_nrstring- Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001721. Example: project name
end_datestring- Project end, YYYY-MM-DD HH:MM:SS. Example: 2027-03-31 00:00:00
pr_budget_type_amountstring- 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) Example: 200.00
pr_budget_type_idnumber- 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 |. Example: 1
pr_invoice_type_amountstring- 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) Example: 230.00
pr_invoice_type_idinteger- 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 |. Example: 3
start_datestring- Project start, YYYY-MM-DD HH:MM:SS. Example: 2026-11-16 00:00:00
bexio_quote_acceptMark a quote as accepted by the customer.WriteAccept Quote
Mark a quote as accepted by the customer. Returns an object with success. Use bexio_quote_accept when the customer agrees, then bexio_quote_invoice_create.
- Idempotent
Inputs
quote_idintegerrequired- Quote ID, from bexio_quotes_list. Example: 7
bexio_quote_createCreate a draft quote for a contact with line items.WriteCreate Quote
Create a draft quote for a contact with line items. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_quote_create for a new quote, then bexio_quote_issue and bexio_quote_send.
Inputs
contact_idintegerrequired- Customer contact ID. Example: 4
user_idintegerrequired- ID of the bexio user responsible for the document, from bexio_users_list. Example: 1
api_referencestring- This field can only be read and edited by the api. It can be used to save references to other systems. Example: example
bank_account_idinteger- References a bank account object. Example: 1
contact_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
contact_sub_idinteger- References a contact object. Example: 12345
currency_idinteger- References a currency object. Example: 1
delivery_address_manualstring- 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. Example: UTA Immobilien AG Stadtturmstrasse 15 5400 Baden
delivery_address_typeinteger- | value | description | |-------|-------------| | 0 | use invoice address | | 1 | use custom address |. One of: 0, 1. Example: 0one of
01 document_nrstring- Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated. https://help.bexio.com/s/article/000001784. Example: AN-00001
footerstring- Text below the positions on the document. Example: Payable within 30 days.
headerstring- Text above the positions on the document. Example: Thank you for your order.
is_valid_fromstring- Document date, YYYY-MM-DD. Example: 2026-11-16
is_valid_untilstring- Quote valid until, YYYY-MM-DD. Example: 2026-12-16
language_idinteger- References a language object. Example: 1
mwst_is_netboolean- 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. Example: True
mwst_typeinteger- VAT handling: 0 including taxes, 1 excluding taxes, 2 exempt. One of: 0, 1, 2. Example: 0one of
012 payment_type_idinteger- References a payment type object. Example: 1
positionsarray- Line items. A custom position is {"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}; an item position uses "type": "KbPositionArticle" with article_id. Example: [{"type": "KbPositionCustom", "amount": "1", "unit_price": "1200.00", "tax_id": 16, "text": "Design work"}]
pr_project_idinteger- References a project object. Example: 12345
show_position_taxesboolean- If true, show the tax of each position on the document. Example: false
template_slugstring- References a document template slug. Example: 581a8010821e01426b8b456b
titlestring- Document title. Example: Website redesign
bexio_quote_invoice_createCreate an invoice from an accepted quote.WriteCreate Invoice from Quote
Create an invoice from an accepted quote. Returns an object with id, document_nr, title, contact_id, contact_sub_id, user_id, project_id, pr_project_id, logopaper_id, language_id, and more. Use bexio_quote_invoice_create to bill a quote without retyping positions.
Inputs
quote_idintegerrequired- Quote ID, from bexio_quotes_list. Example: 7
positionsarray- Please note that the positions array can be omitted to create a document with all positions from the source document. Example: [{"key": "value"}]
bexio_quote_issueIssue a draft quote.WriteIssue Quote
Issue a draft quote. Returns an object with success. Use bexio_quote_issue before sending a quote.
Inputs
quote_idintegerrequired- Quote ID, from bexio_quotes_list. Example: 7
bexio_quote_sendEmail an issued quote to the customer.WriteSend Quote
Email an issued quote to the customer. Returns an object with success. Use bexio_quote_send to deliver a quote. This emails the recipient.
Inputs
messagestringrequired- Email text; it must contain the placeholder [Network Link]. Example: Please find our quote here: [Network Link]
quote_idintegerrequired- Quote ID, from bexio_quotes_list. Example: 7
recipient_emailstringrequired- Recipient email address. Example: info@muster.ch
subjectstringrequired- Email subject. Example: Quote AN-00007
attach_pdfboolean- Attach PDF directly to the email. Example: True
mark_as_openboolean- If true, mark the document as open (issued) when sending. Example: true
bexio_task_createCreate a task, optionally linked to a contact or project.WriteCreate Task
Create a task, optionally linked to a contact or project. Returns an object with id, user_id, finish_date, subject, place, info, contact_id, sub_contact_id, project_id, pr_project_id, and more. Use bexio_task_create to add a to-do.
Inputs
subjectstringrequired- Task subject. Example: Call Muster AG about renewal
user_idintegerrequired- Assigned user ID. Example: 1
contact_idinteger- References a contact object. Example: 1
finish_datestring- Due date and time. Example: 2026-11-20 10:00:00
infostring- Text of the task or note. Example: Discuss the renewal offer
pr_project_idinteger- References a project object. Example: 12345
remember_time_idinteger- Is required if have_remember is set to true. Example: 12345
remember_type_idinteger- Is required if have_remember is set to true. Example: 12345
sub_contact_idinteger- References a contact object. Example: 12345
todo_priority_idinteger- Task priority ID. Example: 2
todo_status_idinteger- Task status ID: 1 open, 2 done. Example: 1
bexio_task_updateUpdate a task, for example its status or due date.WriteUpdate Task
Update a task, for example its status or due date. Returns an object with id, user_id, finish_date, subject, place, info, contact_id, sub_contact_id, project_id, pr_project_id, and more. Use bexio_task_update to complete or reschedule a task.
- Idempotent
Inputs
task_idintegerrequired- Task ID. Example: 8
contact_idinteger- References a contact object. Example: 1
finish_datestring- Due date and time. Example: 2026-11-20 10:00:00
infostring- Text of the task or note. Example: Discuss the renewal offer
pr_project_idinteger- References a project object. Example: 12345
remember_time_idinteger- Is required if have_remember is set to true. Example: 12345
remember_type_idinteger- Is required if have_remember is set to true. Example: 12345
sub_contact_idinteger- References a contact object. Example: 12345
subjectstring- Subject. Example: Call Muster AG about renewal
todo_priority_idinteger- Task priority ID. Example: 2
todo_status_idinteger- Task status ID: 1 open, 2 done. Example: 2
user_idinteger- References a user object. Example: 1
bexio_timesheet_createRecord a time entry, optionally on a contact or project.WriteCreate Timesheet
Record a time entry, optionally on a contact or project. Returns an object with id, user_id, status_id, client_service_id, text, allowable_bill, charge, contact_id, sub_contact_id, pr_project_id, and more. Use bexio_timesheet_create to log work.
Inputs
allowable_billbooleanrequired- If true, the time is billable. Example: true
client_service_idintegerrequired- Work type (business activity) ID. Example: 1
trackingobjectrequired- Time tracking: {"type": "duration", "date": "YYYY-MM-DD", "duration": "HH:MM"} or {"type": "range", "start": "<datetime>", "end": "<datetime>"}. Example: {"type": "duration", "date": "2026-11-16", "duration": "01:30"}
user_idintegerrequired- User who worked. Example: 1
chargestring- Hourly charge override as a decimal string. Example: 150.00
contact_idinteger- References a contact object. Example: 2
pr_project_idinteger- Project ID. Example: 2
status_idinteger- References a timesheet status object. Example: 4
sub_contact_idinteger- References a contact object. Example: 12345
textstring- Description of the work. Example: Workshop with customer
bexio_timesheet_updateUpdate a time entry.WriteUpdate Timesheet
Update a time entry. Returns an object with id, user_id, status_id, client_service_id, text, allowable_bill, charge, contact_id, sub_contact_id, pr_project_id, and more. Use bexio_timesheet_update to correct logged time.
- Idempotent
Inputs
timesheet_idintegerrequired- Timesheet ID. Example: 10
allowable_billboolean- If true, the time is billable. Example: true
chargestring- Hourly charge override as a decimal string. Example: 150.00
client_service_idinteger- References a business activity object. Example: 1
contact_idinteger- References a contact object. Example: 2
pr_project_idinteger- References a project object. Example: 12345
status_idinteger- References a timesheet status object. Example: 4
sub_contact_idinteger- References a contact object. Example: 12345
textstring- Description of the work. Example: Workshop with customer
trackingobject- Time tracking object. Example: {"type": "duration", "date": "2026-11-16", "duration": "02:00"}
user_idinteger- References a user object. Example: 1
bexio_contact_deleteArchive a contact (bexio keeps it as archived).DestructiveDelete Contact
Archive a contact (bexio keeps it as archived). Returns an object with success. Use bexio_contact_delete to remove a contact from active lists.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from bexio_contacts_list or bexio_contacts_search. Example: 4
bexio_invoice_cancelCancel an issued invoice.DestructiveCancel Invoice
Cancel an issued invoice. Returns an object with success. Use bexio_invoice_cancel when an issued invoice should no longer be paid.
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
bexio_invoice_deletePermanently delete a draft invoice.DestructiveDelete Invoice
Permanently delete a draft invoice. Returns an object with success. Use bexio_invoice_delete for drafts. Use bexio_invoice_cancel for issued invoices.
- Idempotent
Inputs
invoice_idintegerrequired- Invoice ID, from bexio_invoices_list. Example: 12
bexio_timesheet_deleteDelete a time entry.DestructiveDelete Timesheet
Delete a time entry. Returns an object with success. Use bexio_timesheet_delete to remove a wrong entry.
- Idempotent
Inputs
timesheet_idintegerrequired- Timesheet ID. Example: 10
No tools match.