bexio MCP by usefulapi is an MCP server published by io.usefulapi, hosted at bexio.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 28 tools, including bexio_get_company_profile, bexio_get_current_user, bexio_list_users, bexio_list_contacts, bexio_get_contact.
Read bexio contacts, invoices, quotes, bills, projects and journal; log time, draft invoices.
4,277 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
The bexio company's profile: name, address, legal form, VAT (MWST) and UID numbers, contact details. Each bexio account has one profile.
No parameters.
{
"name": "bexio_get_company_profile",
"title": "Get company profile",
"description": "The bexio company's profile: name, address, legal form, VAT (MWST) and UID numbers, contact details. Each bexio account has one profile.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get company profile",
"readOnlyHint": true,
"openWorldHint": true
}
}The signed-in bexio user (id, name, email, superadmin/accountant flags). Its id is the default user_id of new records.
No parameters.
{
"name": "bexio_get_current_user",
"title": "Get current user",
"description": "The signed-in bexio user (id, name, email, superadmin/accountant flags). Its id is the default user_id of new records.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get current user",
"readOnlyHint": true,
"openWorldHint": true
}
}The company's bexio users (id, name, email). Use an id as user_id or owner of contacts, documents and timesheets.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
{
"name": "bexio_list_users",
"title": "List users",
"description": "The company's bexio users (id, name, email). Use an id as user_id or owner of contacts, documents and timesheets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
}
}
},
"annotations": {
"title": "List users",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search contacts (customers, suppliers, persons, companies). Without filters it pages through all contacts; with filters it uses bexio's contact search (all filters must match). name_1 is the company name or a person's last name, name_2 a person's first name.
| Parameter | Type | Description |
|---|---|---|
| nr | string | Contact number equals this. |
| city | string | City contains this text. |
| name | string | name_1 (company name or last name) contains this text. |
| string | Main email contains this text. | |
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| archived | boolean | true = archived contacts only (default: active contacts). |
| order_by | string | Sort field (default id). |
| postcode | string | Postcode equals this. |
| descending | boolean | Sort descending (default ascending). |
One contact with its address, emails, phones, language, groups and remarks.
| Parameter | Type | Description |
|---|---|---|
| archived | boolean | true when the contact is archived. |
| contact_id * | integer | The contact id (from bexio_list_contacts). |
{
"name": "bexio_get_contact",
"title": "Get contact",
"description": "One contact with its address, emails, phones, language, groups and remarks.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"archived": {
"type": "boolean",
"description": "true when the contact is archived."
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The contact id (from bexio_list_contacts).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get contact",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search sales invoices (number, contact, totals, open amount, dates, status). Statuses: draft, pending (issued, open), paid, partial (partially paid), canceled, unpaid (overdue reminder state). Without filters it pages through all invoices; with filters all must match.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| title | string | Title contains this text. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| status | array | Only invoices with one of these statuses. |
| user_id | integer | Only documents owned by this bexio user (from bexio_list_users). |
| order_by | string | Sort field (default id). |
| contact_id | integer | Only documents for this contact (from bexio_list_contacts). |
| descending | boolean | Sort descending (default ascending). |
| document_nr | string | Document number contains this text (e.g. RE-00012). |
| updated_since | string |
One invoice with its positions (line items), taxes, totals, received payments and remaining amount.
| Parameter | Type | Description |
|---|---|---|
| invoice_id * | integer | The invoice id (from bexio_list_invoices). |
{
"name": "bexio_get_invoice",
"title": "Get invoice",
"description": "One invoice with its positions (line items), taxes, totals, received payments and remaining amount.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"invoice_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The invoice id (from bexio_list_invoices).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get invoice",
"readOnlyHint": true,
"openWorldHint": true
}
}The payments recorded on one invoice (date, amount, bank account, cash discount).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| invoice_id * | integer | The invoice id (from bexio_list_invoices). |
{
"name": "bexio_list_invoice_payments",
"title": "List invoice payments",
"description": "The payments recorded on one invoice (date, amount, bank account, cash discount).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"invoice_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The invoice id (from bexio_list_invoices).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List invoice payments",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search quotes (Offerten): number, contact, totals, validity, status (draft, pending, confirmed, declined). With filters all must match.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| title | string | Title contains this text. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| status | array | Only quotes with one of these statuses. |
| user_id | integer | Only documents owned by this bexio user (from bexio_list_users). |
| order_by | string | Sort field (default id). |
| contact_id | integer | Only documents for this contact (from bexio_list_contacts). |
| descending | boolean | Sort descending (default ascending). |
| document_nr | string | Document number contains this text (e.g. RE-00012). |
| updated_since | string | Changed on or after this date, yyyy-mm-dd. |
One quote with its positions, taxes and totals.
| Parameter | Type | Description |
|---|---|---|
| quote_id * | integer | The quote id (from bexio_list_quotes). |
{
"name": "bexio_get_quote",
"title": "Get quote",
"description": "One quote with its positions, taxes and totals.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The quote id (from bexio_list_quotes).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get quote",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search sales orders (Aufträge): number, contact, totals, recurring flag, status (pending, done, partial, canceled). With filters all must match.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| title | string | Title contains this text. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| status | array | Only orders with one of these statuses. |
| user_id | integer | Only documents owned by this bexio user (from bexio_list_users). |
| order_by | string | Sort field (default id). |
| contact_id | integer | Only documents for this contact (from bexio_list_contacts). |
| descending | boolean | Sort descending (default ascending). |
| document_nr | string | Document number contains this text (e.g. RE-00012). |
| updated_since | string | Changed on or after this date, yyyy-mm-dd. |
One sales order with its positions, taxes and totals.
| Parameter | Type | Description |
|---|---|---|
| order_id * | integer | The order id (from bexio_list_orders). |
{
"name": "bexio_get_order",
"title": "Get order",
"description": "One sales order with its positions, taxes and totals.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The order id (from bexio_list_orders).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get order",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search items / products (Artikel): code, name, sale and purchase price, tax, unit, stock levels. Use an id as article_id in a draft invoice.
| Parameter | Type | Description |
|---|---|---|
| code | string | Item code (intern_code) contains this text. |
| name | string | Item name (intern_name) contains this text. |
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| order_by | string | Sort field (default id). |
| descending | boolean | Sort descending (default ascending). |
{
"name": "bexio_list_articles",
"title": "List items",
"description": "List or search items / products (Artikel): code, name, sale and purchase price, tax, unit, stock levels. Use an id as article_id in a draft invoice.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"code": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Item code (intern_code) contains this text."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Item name (intern_name) contains this text."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"order_by": {
"enum": [
"id",
"intern_name"
],
"type": "string",
"description": "Sort field (default id)."
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
}
}
},
"annotations": {
"title": "List items",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search projects: number, name, contact, state, type, dates, budget. With filters all must match.
| Parameter | Type | Description |
|---|---|---|
| name | string | Project name contains this text. |
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| order_by | string | Sort field (default id). |
| state_id | integer | Only projects in this state (pr_state_id as returned on a project). |
| contact_id | integer | Only projects of this contact. |
| descending | boolean | Sort descending (default ascending). |
{
"name": "bexio_list_projects",
"title": "List projects",
"description": "List or search projects: number, name, contact, state, type, dates, budget. With filters all must match.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project name contains this text."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"order_by": {
"enum": [
"id",
"name"
],
"type": "string",
"description": "Sort field (default id)."
},
"state_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only projects in this state (pr_state_id as returned on a project).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only projects of this contact.",
"exclusiveMinimum": 0
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
}
}
},
"annotations": {
"title": "List projects",
"readOnlyHint": true,
"openWorldHint": true
}
}One project with its contact, state, type, dates, invoicing and budget settings.
| Parameter | Type | Description |
|---|---|---|
| project_id * | integer | The project id (from bexio_list_projects). |
{
"name": "bexio_get_project",
"title": "Get project",
"description": "One project with its contact, state, type, dates, invoicing and budget settings.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The project id (from bexio_list_projects).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get project",
"readOnlyHint": true,
"openWorldHint": true
}
}List or search time tracking entries: date, duration, text, user, contact, project, business activity, billable flag. With filters all must match.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| user_id | integer | Only entries of this bexio user. |
| order_by | string | Sort field (default id). |
| status_id | integer | Only entries with this timesheet status id. |
| contact_id | integer | Only entries for this contact. |
| descending | boolean | Sort descending (default ascending). |
| project_id | integer | Only entries on this project. |
| business_activity_id | integer | Only entries of this business activity (client_service_id, from bexio_list_business_activities). |
Business activities (Tätigkeiten) for time tracking: id, name, billable default, hourly rate. A timesheet needs one.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| order_by | string | Sort field (default id). |
| descending | boolean | Sort descending (default ascending). |
{
"name": "bexio_list_business_activities",
"title": "List business activities",
"description": "Business activities (Tätigkeiten) for time tracking: id, name, billable default, hourly rate. A timesheet needs one.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"order_by": {
"enum": [
"id",
"name"
],
"type": "string",
"description": "Sort field (default id)."
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
}
}
},
"annotations": {
"title": "List business activities",
"readOnlyHint": true,
"openWorldHint": true
}
}The chart of accounts: account number, name, type (1 earning, 2 expenditure, 3 active/asset, 4 passive/liability, 5 complete/closing), default tax, active/locked flags.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
{
"name": "bexio_list_accounts",
"title": "List accounts",
"description": "The chart of accounts: account number, name, type (1 earning, 2 expenditure, 3 active/asset, 4 passive/liability, 5 complete/closing), default tax, active/locked flags.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
}
}
},
"annotations": {
"title": "List accounts",
"readOnlyHint": true,
"openWorldHint": true
}
}Accounting journal bookings: date, debit and credit account ids, description, amount, currency, base-currency amount, and the source document (ref_class, ref_id).
| Parameter | Type | Description |
|---|---|---|
| to | string | Bookings up to this date, yyyy-mm-dd. |
| from | string | Bookings on or after this date, yyyy-mm-dd. |
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| account_uuid | string | Only bookings on this account (its uuid from bexio_list_accounts). |
{
"name": "bexio_list_journal",
"title": "List journal entries",
"description": "Accounting journal bookings: date, debit and credit account ids, description, amount, currency, base-currency amount, and the source document (ref_class, ref_id).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": "string",
"description": "Bookings up to this date, yyyy-mm-dd."
},
"from": {
"type": "string",
"description": "Bookings on or after this date, yyyy-mm-dd."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"account_uuid": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only bookings on this account (its uuid from bexio_list_accounts)."
}
}
},
"annotations": {
"title": "List journal entries",
"readOnlyHint": true,
"openWorldHint": true
}
}VAT (MWST) tax codes: id, code, rate, type (sales_tax, pre_tax, ...), validity. For a draft invoice use an active sales tax (types sales_tax, scope active).
| Parameter | Type | Description |
|---|---|---|
| date | string | Only taxes active on this date, yyyy-mm-dd. |
| limit | integer | Results per page, 1-2000 (default 50). |
| scope | string | Only active or inactive taxes. |
| types | string | Only sales taxes or input (pre) taxes. |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
{
"name": "bexio_list_taxes",
"title": "List taxes",
"description": "VAT (MWST) tax codes: id, code, rate, type (sales_tax, pre_tax, ...), validity. For a draft invoice use an active sales tax (types sales_tax, scope active).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"description": "Only taxes active on this date, yyyy-mm-dd."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"scope": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Only active or inactive taxes."
},
"types": {
"enum": [
"sales_tax",
"pre_tax"
],
"type": "string",
"description": "Only sales taxes or input (pre) taxes."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
}
}
},
"annotations": {
"title": "List taxes",
"readOnlyHint": true,
"openWorldHint": true
}
}The company's bank accounts shown in bexio banking: name, bank, IBAN / QR-IBAN, currency, linked ledger account, QR-invoice mode.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
{
"name": "bexio_list_bank_accounts",
"title": "List bank accounts",
"description": "The company's bank accounts shown in bexio banking: name, bank, IBAN / QR-IBAN, currency, linked ledger account, QR-invoice mode.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
}
}
},
"annotations": {
"title": "List bank accounts",
"readOnlyHint": true,
"openWorldHint": true
}
}Currencies set up in bexio (id, code such as CHF or EUR, rounding), optionally with the exchange rate valid on a date. Use an id as currency_id.
| Parameter | Type | Description |
|---|---|---|
| date | string | Validity date of the embedded exchange rate, yyyy-mm-dd. |
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
| with_exchange_rate | boolean | Embed each currency's exchange rate. |
{
"name": "bexio_list_currencies",
"title": "List currencies",
"description": "Currencies set up in bexio (id, code such as CHF or EUR, rounding), optionally with the exchange rate valid on a date. Use an id as currency_id.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"description": "Validity date of the embedded exchange rate, yyyy-mm-dd."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"with_exchange_rate": {
"type": "boolean",
"description": "Embed each currency's exchange rate."
}
}
},
"annotations": {
"title": "List currencies",
"readOnlyHint": true,
"openWorldHint": true
}
}Accounting business (fiscal) years: start, end, status (open, locked, closed).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-2000 (default 50). |
| offset | integer | Records to skip (default 0). Use next_offset from the previous reply. |
{
"name": "bexio_list_business_years",
"title": "List business years",
"description": "Accounting business (fiscal) years: start, end, status (open, locked, closed).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
}
}
},
"annotations": {
"title": "List business years",
"readOnlyHint": true,
"openWorldHint": true
}
}Supplier bills (Kreditoren / purchase bills): document number, vendor, title, status, gross/net, pending amount, bill and due date, overdue flag. status: DRAFTS, TODO (booked, not fully paid), PAID, OVERDUE.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, 1-based (default 1). |
| sort | string | Sort field. |
| limit | integer | Bills per page, 1-500 (default 50). |
| search | string | Free-text search over vendor, vendor reference, currency, document number and title (3-255 characters). |
| status | string | Bill status filter. |
| vendor | string | Vendor name contains this text. |
| descending | boolean | Sort descending (default ascending). |
| due_date_to | string | Due date on or before, yyyy-mm-dd. |
| supplier_id | integer | Only bills of this supplier contact. |
| bill_date_to | string | Bill date on or before, yyyy-mm-dd. |
| due_date_from |
WRITE: create a new contact (company or person) in bexio. Nothing existing is changed. For a person, name is the last name and first_name the first name. Owner and responsible user default to the signed-in user.
| Parameter | Type | Description |
|---|---|---|
| city | string | City. |
| name * | string | Company name, or a person's last name (name_1). |
| string | Main email. | |
| phone | string | Landline phone. |
| mobile | string | Mobile phone. |
| remarks | string | Internal remarks. |
| user_id | integer | Responsible bexio user (default: the signed-in user). |
| website | string | Website URL. |
| owner_id | integer | Owner bexio user (default: the responsible user). |
| postcode | string | Postcode. |
| country_id | integer |
WRITE: add a note (call log, meeting minutes, follow-up) to a contact and/or project in bexio. Nothing existing is changed.
| Parameter | Type | Description |
|---|---|---|
| info | string | Note text. |
| subject * | string | Note subject. |
| user_id | integer | Author bexio user (default: the signed-in user). |
| contact_id | integer | Attach to this contact. |
| project_id | integer | Attach to this project. |
| event_start | string | When it happened, local time yyyy-mm-dd HH:MM[:SS] (default: now, UTC). |
{
"name": "bexio_create_note",
"title": "Create note",
"description": "WRITE: add a note (call log, meeting minutes, follow-up) to a contact and/or project in bexio. Nothing existing is changed.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subject"
],
"properties": {
"info": {
"type": "string",
"maxLength": 20000,
"description": "Note text."
},
"subject": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Note subject."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Author bexio user (default: the signed-in user).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Attach to this contact.",
"exclusiveMinimum": 0
},
"project_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Attach to this project.",
"exclusiveMinimum": 0
},
"event_start": {
"type": "string",
"description": "When it happened, local time yyyy-mm-dd HH:MM[:SS] (default: now, UTC)."
}
}
},
"annotations": {
"title": "Create note",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: log time in bexio: either date + duration (HH:MM), or start + end. Needs a business activity (bexio_list_business_activities). Nothing existing is changed.
| Parameter | Type | Description |
|---|---|---|
| end | string | End, local time yyyy-mm-dd HH:MM[:SS] (with start). |
| date | string | Work date, yyyy-mm-dd (with duration). |
| text | string | What was done. |
| start | string | Start, local time yyyy-mm-dd HH:MM[:SS] (with end). |
| user_id | integer | Whose time (default: the signed-in user). |
| billable | boolean | Billable to the client (default true). |
| duration | string | Time worked as HH:MM, e.g. 01:30 (with date). |
| status_id | integer | Timesheet status id (bexio's default when omitted). |
| contact_id | integer | The client contact. |
| project_id | integer | The project. |
| business_activity_id |
WRITE: create a DRAFT invoice in bexio for a contact, with custom, item (article) and text lines. It is never issued, sent or booked: the user reviews and issues it in bexio. Taxes must be active sales taxes (bexio_list_taxes with types sales_tax, scope active).
| Parameter | Type | Description |
|---|---|---|
| title | string | Invoice title. |
| footer | string | Text below the lines. |
| header | string | Text above the lines. |
| user_id | integer | Responsible bexio user (default: the signed-in user). |
| tax_mode | string | net = unit prices are net and VAT is added (default); gross = unit prices include VAT; exempt = the invoice is exempt from VAT. |
| valid_to | string | Due date, yyyy-mm-dd (default from the payment terms). |
| positions * | array | 1-150 invoice lines. |
| reference | string | Customer reference shown on the invoice. |
| contact_id * | integer | The customer contact (from bexio_list_contacts). |
Tools for bexio, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which sales invoices are still open, and which of them are overdue?"; "Which supplier bills are due this month, and how much is still to pay?"; "Show last month's journal bookings on the bank account.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes bexio data. Free plan: 50 tool calls per month. Run bexio_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run bexio_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run bexio_upgrade without a plan: it returns both plans, each with a payment link for the user to open. bexio_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| first_name |
| string |
| name_2 (a person's first name or a company's name addition) contains this text. |
| contact_type | string | Only companies or only persons. |
| updated_since | string | Changed on or after this date, yyyy-mm-dd. |
{
"name": "bexio_list_contacts",
"title": "List contacts",
"description": "List or search contacts (customers, suppliers, persons, companies). Without filters it pages through all contacts; with filters it uses bexio's contact search (all filters must match). name_1 is the company name or a person's last name, name_2 a person's first name.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"nr": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Contact number equals this."
},
"city": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "City contains this text."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "name_1 (company name or last name) contains this text."
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Main email contains this text."
},
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"archived": {
"type": "boolean",
"description": "true = archived contacts only (default: active contacts)."
},
"order_by": {
"enum": [
"id",
"nr",
"name_1",
"updated_at"
],
"type": "string",
"description": "Sort field (default id)."
},
"postcode": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Postcode equals this."
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"first_name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "name_2 (a person's first name or a company's name addition) contains this text."
},
"contact_type": {
"enum": [
"company",
"person"
],
"type": "string",
"description": "Only companies or only persons."
},
"updated_since": {
"type": "string",
"description": "Changed on or after this date, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List contacts",
"readOnlyHint": true,
"openWorldHint": true
}
}| Changed on or after this date, yyyy-mm-dd. |
| valid_from_after | string | Document date (is_valid_from) on or after this date, yyyy-mm-dd. |
| valid_from_before | string | Document date (is_valid_from) on or before this date, yyyy-mm-dd. |
{
"name": "bexio_list_invoices",
"title": "List invoices",
"description": "List or search sales invoices (number, contact, totals, open amount, dates, status). Statuses: draft, pending (issued, open), paid, partial (partially paid), canceled, unpaid (overdue reminder state). Without filters it pages through all invoices; with filters all must match.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Title contains this text."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"status": {
"type": "array",
"items": {
"enum": [
"draft",
"pending",
"paid",
"partial",
"canceled",
"unpaid"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Only invoices with one of these statuses."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents owned by this bexio user (from bexio_list_users).",
"exclusiveMinimum": 0
},
"order_by": {
"enum": [
"id",
"total",
"total_net",
"total_gross",
"updated_at"
],
"type": "string",
"description": "Sort field (default id)."
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents for this contact (from bexio_list_contacts).",
"exclusiveMinimum": 0
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"document_nr": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Document number contains this text (e.g. RE-00012)."
},
"updated_since": {
"type": "string",
"description": "Changed on or after this date, yyyy-mm-dd."
},
"valid_from_after": {
"type": "string",
"description": "Document date (is_valid_from) on or after this date, yyyy-mm-dd."
},
"valid_from_before": {
"type": "string",
"description": "Document date (is_valid_from) on or before this date, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List invoices",
"readOnlyHint": true,
"openWorldHint": true
}
}| valid_from_after |
| string |
| Document date (is_valid_from) on or after this date, yyyy-mm-dd. |
| valid_from_before | string | Document date (is_valid_from) on or before this date, yyyy-mm-dd. |
{
"name": "bexio_list_quotes",
"title": "List quotes",
"description": "List or search quotes (Offerten): number, contact, totals, validity, status (draft, pending, confirmed, declined). With filters all must match.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Title contains this text."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"status": {
"type": "array",
"items": {
"enum": [
"draft",
"pending",
"confirmed",
"declined"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Only quotes with one of these statuses."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents owned by this bexio user (from bexio_list_users).",
"exclusiveMinimum": 0
},
"order_by": {
"enum": [
"id",
"total",
"total_net",
"total_gross",
"updated_at"
],
"type": "string",
"description": "Sort field (default id)."
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents for this contact (from bexio_list_contacts).",
"exclusiveMinimum": 0
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"document_nr": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Document number contains this text (e.g. RE-00012)."
},
"updated_since": {
"type": "string",
"description": "Changed on or after this date, yyyy-mm-dd."
},
"valid_from_after": {
"type": "string",
"description": "Document date (is_valid_from) on or after this date, yyyy-mm-dd."
},
"valid_from_before": {
"type": "string",
"description": "Document date (is_valid_from) on or before this date, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List quotes",
"readOnlyHint": true,
"openWorldHint": true
}
}| valid_from_after |
| string |
| Document date (is_valid_from) on or after this date, yyyy-mm-dd. |
| valid_from_before | string | Document date (is_valid_from) on or before this date, yyyy-mm-dd. |
{
"name": "bexio_list_orders",
"title": "List orders",
"description": "List or search sales orders (Aufträge): number, contact, totals, recurring flag, status (pending, done, partial, canceled). With filters all must match.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Title contains this text."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"status": {
"type": "array",
"items": {
"enum": [
"pending",
"done",
"partial",
"canceled"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Only orders with one of these statuses."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents owned by this bexio user (from bexio_list_users).",
"exclusiveMinimum": 0
},
"order_by": {
"enum": [
"id",
"total",
"total_net",
"total_gross",
"updated_at"
],
"type": "string",
"description": "Sort field (default id)."
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only documents for this contact (from bexio_list_contacts).",
"exclusiveMinimum": 0
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"document_nr": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Document number contains this text (e.g. RE-00012)."
},
"updated_since": {
"type": "string",
"description": "Changed on or after this date, yyyy-mm-dd."
},
"valid_from_after": {
"type": "string",
"description": "Document date (is_valid_from) on or after this date, yyyy-mm-dd."
},
"valid_from_before": {
"type": "string",
"description": "Document date (is_valid_from) on or before this date, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List orders",
"readOnlyHint": true,
"openWorldHint": true
}
}{
"name": "bexio_list_timesheets",
"title": "List timesheets",
"description": "List or search time tracking entries: date, duration, text, user, contact, project, business activity, billable flag. With filters all must match.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Results per page, 1-2000 (default 50)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Use next_offset from the previous reply."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only entries of this bexio user.",
"exclusiveMinimum": 0
},
"order_by": {
"enum": [
"id",
"date"
],
"type": "string",
"description": "Sort field (default id)."
},
"status_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only entries with this timesheet status id.",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only entries for this contact.",
"exclusiveMinimum": 0
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"project_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only entries on this project.",
"exclusiveMinimum": 0
},
"business_activity_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only entries of this business activity (client_service_id, from bexio_list_business_activities).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List timesheets",
"readOnlyHint": true,
"openWorldHint": true
}
}| string |
| Due date on or after, yyyy-mm-dd. |
| bill_date_from | string | Bill date on or after, yyyy-mm-dd. |
{
"name": "bexio_list_bills",
"title": "List supplier bills",
"description": "Supplier bills (Kreditoren / purchase bills): document number, vendor, title, status, gross/net, pending amount, bill and due date, overdue flag. status: DRAFTS, TODO (booked, not fully paid), PAID, OVERDUE.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, 1-based (default 1)."
},
"sort": {
"enum": [
"document_no",
"bill_date",
"due_date",
"vendor",
"gross",
"pending_amount",
"created_at"
],
"type": "string",
"description": "Sort field."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Bills per page, 1-500 (default 50)."
},
"search": {
"type": "string",
"maxLength": 255,
"minLength": 3,
"description": "Free-text search over vendor, vendor reference, currency, document number and title (3-255 characters)."
},
"status": {
"enum": [
"DRAFTS",
"TODO",
"PAID",
"OVERDUE"
],
"type": "string",
"description": "Bill status filter."
},
"vendor": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Vendor name contains this text."
},
"descending": {
"type": "boolean",
"description": "Sort descending (default ascending)."
},
"due_date_to": {
"type": "string",
"description": "Due date on or before, yyyy-mm-dd."
},
"supplier_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Only bills of this supplier contact.",
"exclusiveMinimum": 0
},
"bill_date_to": {
"type": "string",
"description": "Bill date on or before, yyyy-mm-dd."
},
"due_date_from": {
"type": "string",
"description": "Due date on or after, yyyy-mm-dd."
},
"bill_date_from": {
"type": "string",
"description": "Bill date on or after, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List supplier bills",
"readOnlyHint": true,
"openWorldHint": true
}
}| bexio country id (1 = Switzerland in a default bexio setup). |
| first_name | string | A person's first name, or a company's name addition (name_2). |
| language_id | integer | bexio language id of the contact's correspondence language. |
| street_name | string | Street name. |
| contact_type * | string | company or person. |
| house_number | string | House number. |
| address_addition | string | Address addition (c/o, P.O. box). |
| contact_group_ids | array | Contact group ids. |
{
"name": "bexio_create_contact",
"title": "Create contact",
"description": "WRITE: create a new contact (company or person) in bexio. Nothing existing is changed. For a person, name is the last name and first_name the first name. Owner and responsible user default to the signed-in user.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_type",
"name"
],
"properties": {
"city": {
"type": "string",
"maxLength": 255,
"description": "City."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Company name, or a person's last name (name_1)."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 255,
"description": "Main email."
},
"phone": {
"type": "string",
"maxLength": 50,
"description": "Landline phone."
},
"mobile": {
"type": "string",
"maxLength": 50,
"description": "Mobile phone."
},
"remarks": {
"type": "string",
"maxLength": 10000,
"description": "Internal remarks."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Responsible bexio user (default: the signed-in user).",
"exclusiveMinimum": 0
},
"website": {
"type": "string",
"maxLength": 255,
"description": "Website URL."
},
"owner_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Owner bexio user (default: the responsible user).",
"exclusiveMinimum": 0
},
"postcode": {
"type": "string",
"maxLength": 20,
"description": "Postcode."
},
"country_id": {
"type": "integer",
"maximum": 2147483647,
"description": "bexio country id (1 = Switzerland in a default bexio setup).",
"exclusiveMinimum": 0
},
"first_name": {
"type": "string",
"maxLength": 255,
"description": "A person's first name, or a company's name addition (name_2)."
},
"language_id": {
"type": "integer",
"maximum": 2147483647,
"description": "bexio language id of the contact's correspondence language.",
"exclusiveMinimum": 0
},
"street_name": {
"type": "string",
"maxLength": 255,
"description": "Street name."
},
"contact_type": {
"enum": [
"company",
"person"
],
"type": "string",
"description": "company or person."
},
"house_number": {
"type": "string",
"maxLength": 50,
"description": "House number."
},
"address_addition": {
"type": "string",
"maxLength": 255,
"description": "Address addition (c/o, P.O. box)."
},
"contact_group_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2147483647,
"description": "A contact group id.",
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Contact group ids."
}
}
},
"annotations": {
"title": "Create contact",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}| integer |
| The business activity (client_service_id) from bexio_list_business_activities. |
{
"name": "bexio_create_timesheet",
"title": "Create timesheet entry",
"description": "WRITE: log time in bexio: either date + duration (HH:MM), or start + end. Needs a business activity (bexio_list_business_activities). Nothing existing is changed.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_activity_id"
],
"properties": {
"end": {
"type": "string",
"description": "End, local time yyyy-mm-dd HH:MM[:SS] (with start)."
},
"date": {
"type": "string",
"description": "Work date, yyyy-mm-dd (with duration)."
},
"text": {
"type": "string",
"maxLength": 10000,
"description": "What was done."
},
"start": {
"type": "string",
"description": "Start, local time yyyy-mm-dd HH:MM[:SS] (with end)."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Whose time (default: the signed-in user).",
"exclusiveMinimum": 0
},
"billable": {
"type": "boolean",
"description": "Billable to the client (default true)."
},
"duration": {
"type": "string",
"pattern": "^\\d{1,3}:[0-5]\\d$",
"description": "Time worked as HH:MM, e.g. 01:30 (with date)."
},
"status_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Timesheet status id (bexio's default when omitted).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The client contact.",
"exclusiveMinimum": 0
},
"project_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The project.",
"exclusiveMinimum": 0
},
"business_activity_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The business activity (client_service_id) from bexio_list_business_activities.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Create timesheet entry",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}| project_id |
| integer |
| Link to this project. |
| valid_from | string | Invoice date, yyyy-mm-dd (default today). |
| currency_id | integer | Currency (from bexio_list_currencies); company default when omitted. |
| document_nr | string | Invoice number. Only when automatic numbering is OFF in bexio's settings (then it is required); leave empty with automatic numbering. |
| language_id | integer | Document language id; the contact's language when omitted. |
| api_reference | string | Your own external reference (only visible through the API). |
| contact_sub_id | integer | A contact person of the customer. |
| bank_account_id | integer | Bank account for the payment slip (from bexio_list_bank_accounts); default when omitted. |
| payment_type_id | integer | Payment type id; default when omitted. |
{
"name": "bexio_create_draft_invoice",
"title": "Create draft invoice",
"description": "WRITE: create a DRAFT invoice in bexio for a contact, with custom, item (article) and text lines. It is never issued, sent or booked: the user reviews and issues it in bexio. Taxes must be active sales taxes (bexio_list_taxes with types sales_tax, scope active).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id",
"positions"
],
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"description": "Invoice title."
},
"footer": {
"type": "string",
"maxLength": 10000,
"description": "Text below the lines."
},
"header": {
"type": "string",
"maxLength": 10000,
"description": "Text above the lines."
},
"user_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Responsible bexio user (default: the signed-in user).",
"exclusiveMinimum": 0
},
"tax_mode": {
"enum": [
"net",
"gross",
"exempt"
],
"type": "string",
"description": "net = unit prices are net and VAT is added (default); gross = unit prices include VAT; exempt = the invoice is exempt from VAT."
},
"valid_to": {
"type": "string",
"description": "Due date, yyyy-mm-dd (default from the payment terms)."
},
"positions": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string",
"maxLength": 10000,
"description": "Line text (required for custom and text lines; for article lines the item's text is used when omitted)."
},
"type": {
"enum": [
"custom",
"article",
"text"
],
"type": "string",
"description": "custom = a free line (text, amount, unit_price, tax_id); article = an existing item (article_id, amount, tax_id); text = a text-only line."
},
"amount": {
"type": "number",
"maximum": 1000000000,
"description": "Quantity (max. 6 decimals). Required for custom and article lines.",
"exclusiveMinimum": 0
},
"tax_id": {
"type": "integer",
"maximum": 2147483647,
"description": "An ACTIVE sales tax (bexio_list_taxes with types sales_tax, scope active). Required for custom and article lines.",
"exclusiveMinimum": 0
},
"unit_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Unit id (bexio's units, e.g. hours); none when omitted.",
"exclusiveMinimum": 0
},
"account_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Revenue account (from bexio_list_accounts); bexio's default when omitted.",
"exclusiveMinimum": 0
},
"article_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The item (from bexio_list_articles). Required for article lines only.",
"exclusiveMinimum": 0
},
"unit_price": {
"type": "number",
"maximum": 1000000000,
"minimum": -1000000000,
"description": "Price per unit (max. 6 decimals). Required for custom lines; article lines default to the item's price."
},
"discount_in_percent": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Line discount in percent."
}
}
},
"maxItems": 150,
"minItems": 1,
"description": "1-150 invoice lines."
},
"reference": {
"type": "string",
"maxLength": 255,
"description": "Customer reference shown on the invoice."
},
"contact_id": {
"type": "integer",
"maximum": 2147483647,
"description": "The customer contact (from bexio_list_contacts).",
"exclusiveMinimum": 0
},
"project_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Link to this project.",
"exclusiveMinimum": 0
},
"valid_from": {
"type": "string",
"description": "Invoice date, yyyy-mm-dd (default today)."
},
"currency_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Currency (from bexio_list_currencies); company default when omitted.",
"exclusiveMinimum": 0
},
"document_nr": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Invoice number. Only when automatic numbering is OFF in bexio's settings (then it is required); leave empty with automatic numbering."
},
"language_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Document language id; the contact's language when omitted.",
"exclusiveMinimum": 0
},
"api_reference": {
"type": "string",
"maxLength": 255,
"description": "Your own external reference (only visible through the API)."
},
"contact_sub_id": {
"type": "integer",
"maximum": 2147483647,
"description": "A contact person of the customer.",
"exclusiveMinimum": 0
},
"bank_account_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Bank account for the payment slip (from bexio_list_bank_accounts); default when omitted.",
"exclusiveMinimum": 0
},
"payment_type_id": {
"type": "integer",
"maximum": 2147483647,
"description": "Payment type id; default when omitted.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Create draft invoice",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}