Servers Playground How we check Add a server Log in

Billomat MCP by usefulapi

Working · 2.2 s

io.usefulapi/billomatv1.8.0 Domain verified

Read Billomat clients, invoices, offers, credit notes, reminders; create clients and draft invoices.

Finance & Payments

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://billomat.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

billomat_add_invoice_item Destructive

WRITE: add one line item to an invoice that is still a DRAFT (Billomat refuses it for any other status). Does not complete or send the invoice.

invoice_idstring, required

The draft invoice id.

typestring

PRODUCT or SERVICE.

unitstring

Unit, e.g. Stunde, Stueck, hour.

titlestring

Item title (required unless article_id is given).

optionalboolean

Offers only: mark the item as optional (its price is left out of the total).

quantitynumber

Quantity (required unless article_id is given).

tax_namestring

Tax name; with tax_rate overrides the standard tax of the account.

tax_ratenumber

Tax rate in percent; the account's standard rate when omitted.

reductionstring

Discount: absolute (10) or percent (10%).

article_idstring

An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article.

unit_pricenumber

Unit price, net or gross as net_gross of the document (required unless article_id is given).

descriptionstring

Item description.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Billomat MCP by usefulapi MCP server | mcptry

Billomat MCP by usefulapi

Working · 2.2 s

io.usefulapi/billomatv1.8.0 Domain verified

Read Billomat clients, invoices, offers, credit notes, reminders; create clients and draft invoices.

Finance & Payments

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://billomat.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

billomat_add_invoice_item Destructive

WRITE: add one line item to an invoice that is still a DRAFT (Billomat refuses it for any other status). Does not complete or send the invoice.

invoice_idstring, required

The draft invoice id.

typestring

PRODUCT or SERVICE.

unitstring

Unit, e.g. Stunde, Stueck, hour.

titlestring

Item title (required unless article_id is given).

optionalboolean

Offers only: mark the item as optional (its price is left out of the total).

quantitynumber

Quantity (required unless article_id is given).

tax_namestring

Tax name; with tax_rate overrides the standard tax of the account.

tax_ratenumber

Tax rate in percent; the account's standard rate when omitted.

reductionstring

Discount: absolute (10) or percent (10%).

article_idstring

An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article.

unit_pricenumber

Unit price, net or gross as net_gross of the document (required unless article_id is given).

descriptionstring

Item description.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (34)

billomat_add_invoice_item

WRITE: add one line item to an invoice that is still a DRAFT (Billomat refuses it for any other status). Does not complete or send the invoice.

destructive

Argument	Type	Description
type	string	PRODUCT or SERVICE.
unit	string	Unit, e.g. Stunde, Stueck, hour.
title	string	Item title (required unless article_id is given).
optional	boolean	Offers only: mark the item as optional (its price is left out of the total).
quantity	number	Quantity (required unless article_id is given).
tax_name	string	Tax name; with tax_rate overrides the standard tax of the account.
tax_rate	number	Tax rate in percent; the account's standard rate when omitted.
reduction	string	Discount: absolute (10) or percent (10%).
article_id	any	An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article.
invoice_id*	any	The draft invoice id.
unit_price	number	Unit price, net or gross as net_gross of the document (required unless article_id is given).
description	string	Item description.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "type": {
      "enum": [
        "PRODUCT",
        "SERVICE"
      ],
      "type": "string",
      "description": "PRODUCT or SERVICE."
    },
    "unit": {
      "type": "string",
      "maxLength": 100,
      "description": "Unit, e.g. Stunde, Stueck, hour."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Item title (required unless article_id is given)."
    },
    "optional": {
      "type": "boolean",
      "description": "Offers only: mark the item as optional (its price is left out of the total)."
    },
    "quantity": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": -1000000000,
      "description": "Quantity (required unless article_id is given)."
    },
    "tax_name": {
      "type": "string",
      "maxLength": 100,
      "description": "Tax name; with tax_rate overrides the standard tax of the account."
    },
    "tax_rate": {
      "type": "number",
      "maximum": 100,
      "minimum": 0,
      "description": "Tax rate in percent; the account's standard rate when omitted."
    },
    "reduction": {
      "type": "string",
      "pattern": "^\\d+(\\.\\d+)?%?$",
      "description": "Discount: absolute (10) or percent (10%)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article."
    },
    "invoice_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The draft invoice id."
    },
    "unit_price": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": -1000000000000,
      "description": "Unit price, net or gross as net_gross of the document (required unless article_id is given)."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Item description."
    }
  }
}

billomat_create_article

WRITE: create a new article (product or service) with a price. Billomat assigns the article number.

destructive

Argument	Type	Description
type	string	PRODUCT or SERVICE.
title*	string	Article title.
tax_id	any	Tax rate id (from billomat_list_taxes).
unit_id	any	Unit id (from billomat_list_units).
description	string	Description.
sales_price	number	Sales price (net or gross as the account is set up).
currency_code	string	ISO currency code, e.g. EUR (account default when omitted).
purchase_price	number	Purchase price.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "type": {
      "enum": [
        "PRODUCT",
        "SERVICE"
      ],
      "type": "string",
      "description": "PRODUCT or SERVICE."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Article title."
    },
    "tax_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Tax rate id (from billomat_list_taxes)."
    },
    "unit_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Unit id (from billomat_list_units)."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description."
    },
    "sales_price": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0,
      "description": "Sales price (net or gross as the account is set up)."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    },
    "purchase_price": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0,
      "description": "Purchase price."
    }
  }
}

billomat_create_client

WRITE: create a new client (customer) in Billomat. Billomat assigns the client number. Nothing is sent to the client. Check billomat_list_clients first to avoid duplicates.

destructive

Argument	Type	Description
www	string	Website (without http).
zip	string	ZIP code.
city	string	City.
name	string	Company name.
note	string	Internal note.
email	string	Email address.
phone	string	Phone.
state	string	State / region.
locale	string	Locale of the documents, e.g. de-DE.
mobile	string	Mobile phone.
street

billomat_create_draft_invoice

WRITE: create an invoice as a DRAFT (Entwurf) for a client, with optional line items. The invoice is NOT completed, has no number yet and is NOT sent; review and complete it in Billomat. Nothing is charged.

destructive

Argument	Type	Description
date	string	Document date (yyyy-mm-dd; today when omitted).
note	string	Closing note.
intro	string	Introduction text.
items	array	Line items (up to 200). More can be added to the draft later.
label	string	Label / subject.
title	string	Document title.
due_days	integer	Days until payment is due.
client_id*	any	The client id (from billomat_list_clients).
net_gross	string	Whether prices are net or gross.

billomat_create_draft_offer

WRITE: create an offer (Angebot) as a DRAFT for a client, with optional line items. The offer is NOT completed, has no number yet and is NOT sent; review and complete it in Billomat.

destructive

Argument	Type	Description
date	string	Document date (yyyy-mm-dd; today when omitted).
note	string	Closing note.
intro	string	Introduction text.
items	array	Line items (up to 200). More can be added to the draft later.
label	string	Label / subject.
title	string	Document title.
client_id*	any	The client id (from billomat_list_clients).
net_gross	string	Whether prices are net or gross.
contact_id	any	A contact of that client.
currency_code

billomat_get_article

Get one article with its prices, unit, tax and supplier.

read-only

Argument	Type	Description
id*	any	The article id (from billomat_list_articles).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The article id (from billomat_list_articles)."
    }
  }
}

billomat_get_client

Get one client with address, contact person, bank details, payment terms and revenue.

read-only

Argument	Type	Description
id*	any	The client id (from billomat_list_clients).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The client id (from billomat_list_clients)."
    }
  }
}

billomat_get_company

Show the own company data of the Billomat account (name, address, bank details, tax numbers, currency).

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

billomat_get_confirmation

Get one order confirmation.

read-only

Argument	Type	Description
id*	any	The confirmation id (from billomat_list_confirmations).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The confirmation id (from billomat_list_confirmations)."
    }
  }
}

billomat_get_credit_note

Get one credit note.

read-only

Argument	Type	Description
id*	any	The credit note id (from billomat_list_credit_notes).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The credit note id (from billomat_list_credit_notes)."
    }
  }
}

billomat_get_current_user

Show the Billomat user the API key belongs to (name, email, role and rights). Use it to check which rights the key has.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

billomat_get_delivery_note

Get one delivery note.

read-only

Argument	Type	Description
id*	any	The delivery note id (from billomat_list_delivery_notes).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The delivery note id (from billomat_list_delivery_notes)."
    }
  }
}

billomat_get_incoming_invoice

Get one incoming invoice with amounts and open amount.

read-only

Argument	Type	Description
id*	any	The incoming invoice id (from billomat_list_incoming_invoices).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The incoming invoice id (from billomat_list_incoming_invoices)."
    }
  }
}

billomat_get_invoice

Get one invoice (status, totals, dates, client, payment terms). Its line items come from billomat_list_invoice_items.

read-only

Argument	Type	Description
id*	any	The invoice id (from billomat_list_invoices).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The invoice id (from billomat_list_invoices)."
    }
  }
}

billomat_get_offer

Get one offer (status, totals, validity, client).

read-only

Argument	Type	Description
id*	any	The offer id (from billomat_list_offers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The offer id (from billomat_list_offers)."
    }
  }
}

billomat_get_reminder

Get one payment reminder.

read-only

Argument	Type	Description
id*	any	The reminder id (from billomat_list_reminders).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The reminder id (from billomat_list_reminders)."
    }
  }
}

billomat_get_supplier

Get one supplier with address and bank details.

read-only

Argument	Type	Description
id*	any	The supplier id (from billomat_list_suppliers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The supplier id (from billomat_list_suppliers)."
    }
  }
}

billomat_invoice_totals

Invoice totals grouped by client, status, day, week, month or year (for example group_by=client,year). Takes the same filters as billomat_list_invoices. Read-only.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas.
group_by*	string	Grouping: client, status, day, week, month, year; several separated by commas (the order sets the aggregation).
client_id	any

billomat_list_articles

List the articles (products and services) with prices, units and tax. Paged.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
title	string	Title (case-insensitive).
unit_id	any	Only articles with this unit (from billomat_list_units).
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).
description	string	Search in the description.
supplier_id	any	Only articles of this supplier.
currency_code	string	ISO currency code, e.g. EUR (account default when omitted).

billomat_list_clients

List the clients (customers) of the account, filtered by name, number, email, contact person, country, note or tags. Paged.

read-only

Argument	Type	Description
name	string	Company / name (case-insensitive).
note	string	Search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
email	string	Email address.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).
last_name	string	Last name of the contact person.
first_name	string	First name of the contact person.

billomat_list_confirmations

List order confirmations (Auftragsbestaetigungen), filtered by client, status (DRAFT, COMPLETED, CANCELED, CLEARED), number, date range or text. Paged.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, COMPLETED, CANCELED, CLEARED; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).

billomat_list_credit_notes

List credit notes (Gutschriften), filtered by client, status (DRAFT, OPEN, PAID), date range or text. Paged.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, OPEN, PAID; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).

billomat_list_delivery_notes

List delivery notes (Lieferscheine), filtered by client, status (DRAFT, CREATED), number, date range or text. Paged.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, CREATED; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).

billomat_list_incoming_invoices

List incoming invoices (Eingangsrechnungen, from suppliers), filtered by supplier, status (OPEN, PAID, OVERDUE), number, date range, note or tags. Paged.

read-only

Argument	Type	Description
to	string	Dated on or before this day (yyyy-mm-dd).
from	string	Dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
status	string	Status filter: OPEN, PAID, OVERDUE; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).
supplier_id	any

billomat_list_invoice_items

List the line items (positions) of one invoice.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
per_page	integer	Results per page, 1-1000 (default 100).
invoice_id*	any	The invoice id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "invoice_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The invoice id."
    }
  }
}

billomat_list_invoice_payments

List the payments that were recorded on invoices (read-only), optionally for one invoice, a date range or payment types.

read-only

Argument	Type	Description
to	string	Payments on or before this day (yyyy-mm-dd).
from	string	Payments on or after this day (yyyy-mm-dd).
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
type	string	Payment type(s), e.g. CASH, BANK_TRANSFER, PAYPAL; several separated by commas.
user_id	any	Only payments recorded by this user.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).
invoice_id	any	Only payments of this invoice.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Payments on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Payments on or after this day (yyyy-mm-dd)."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "type": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Payment type(s), e.g. CASH, BANK_TRANSFER, PAYPAL; several separated by commas."
    },
    "user_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only payments recorded by this user."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "invoice_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only payments of this invoice."
    }
  }
}

billomat_list_invoices

List invoices (Rechnungen), filtered by client, status (DRAFT, OPEN, PAID, OVERDUE, CANCELED), number, date range, text or tags. Paged; each invoice carries totals and the open amount.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).

billomat_list_offers

List offers (Angebote), filtered by client, status (DRAFT, OPEN, WON, LOST, CANCELED, CLEARED), number, date range or text. Paged.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, OPEN, WON, LOST, CANCELED, CLEARED; several separated by commas.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).

billomat_list_recurring_invoices

List recurring invoices (Abo-Rechnungen): name, cycle (DAILY, WEEKLY, MONTHLY, YEARLY), client and next run. Paged.

read-only

Argument	Type	Description
name	string	Name of the recurring invoice.
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
cycle	string	Interval.
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).

billomat_list_reminders

List payment reminders (Mahnungen), filtered by client, status (DRAFT, OPEN, OVERDUE, PAID, CANCELED), invoice number, date range or text. Paged.

read-only

Argument	Type	Description
to	string	Documents dated on or before this day (yyyy-mm-dd).
from	string	Documents dated on or after this day (yyyy-mm-dd).
note	string	Free-text search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
intro	string	Free-text search in the introduction text.
label	string	Free-text search in the label.
status	string	Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas.
subject	string	Free-text search in the subject.

billomat_list_suppliers

List the suppliers of the account, filtered by name, email, contact person, country, note or tags. Paged.

read-only

Argument	Type	Description
name	string	Company / name.
note	string	Search in the note.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
tags	string	Comma-separated tags (Schlagworte).
email	string	Email address.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).
last_name	string	Last name of the contact person.
first_name	string	First name of the contact person.
country_code

billomat_list_taxes

List the tax rates (Steuersaetze) of the account, with the default one.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).

Input schema (JSON)

{
  "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). Use next_page from the previous reply."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    }
  }
}

billomat_list_units

List the units (Einheiten) used for article and item quantities, optionally filtered by name.

read-only

Argument	Type	Description
name	string	Unit name (substring, case-insensitive).
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
order_by	string	Sort order: field name plus ASC or DESC, several separated by commas, e.g. "date DESC" (default ascending).
per_page	integer	Results per page, 1-1000 (default 100).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 500,
      "description": "Unit name (substring, case-insensitive)."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    }
  }
}

billomat_update_client

WRITE: change fields of an existing client (only the fields you pass are changed; everything else stays). Read the client first with billomat_get_client. Nothing is sent to the client.

destructive

Argument	Type	Description
id*	any	The client id.
www	string	Website (without http).
zip	string	ZIP code.
city	string	City.
name	string	Company name.
note	string	Internal note.
email	string	Email address.
phone	string	Phone.
state	string	State / region.
locale	string	Locale of the documents, e.g. de-DE.
mobile

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "www": {
      "type": "string",
      "maxLength": 255,
      "description": "Website (without http)."
    },
    "zip": {
      "type": "string",
      "maxLength": 20,
      "description": "ZIP code."
    },
    "city": {
      "type": "string",
      "maxLength": 255,
      "description": "City."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Company name."
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "Internal note."
    },
    "email": {
      "type": "string",
      "maxLength": 255,
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 100,
      "description": "Phone."
    },
    "state": {
      "type": "string",
      "maxLength": 255,
      "description": "State / region."
    },
    "locale": {
      "type": "string",
      "maxLength": 20,
      "description": "Locale of the documents, e.g. de-DE."
    },
    "mobile": {
      "type": "string",
      "maxLength": 100,
      "description": "Mobile phone."
    },
    "street": {
      "type": "string",
      "maxLength": 255,
      "description": "Street and number."
    },
    "last_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Last name of the contact person."
    },
    "first_name": {
      "type": "string",
      "maxLength": 255,
      "description": "First name of the contact person."
    },
    "salutation": {
      "type": "string",
      "maxLength": 255,
      "description": "Salutation, e.g. Herr, Frau."
    },
    "tax_number": {
      "type": "string",
      "maxLength": 100,
      "description": "Tax number."
    },
    "vat_number": {
      "type": "string",
      "maxLength": 100,
      "description": "VAT ID."
    },
    "country_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$",
      "description": "ISO 3166 alpha-2 country code, e.g. DE, AT, CH."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "Document date (yyyy-mm-dd; today when omitted)."
    },
    "note": {
      "type": "string",
      "maxLength": 5000,
      "description": "Closing note."
    },
    "intro": {
      "type": "string",
      "maxLength": 5000,
      "description": "Introduction text."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "PRODUCT",
              "SERVICE"
            ],
            "type": "string",
            "description": "PRODUCT or SERVICE."
          },
          "unit": {
            "type": "string",
            "maxLength": 100,
            "description": "Unit, e.g. Stunde, Stueck, hour."
          },
          "title": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "description": "Item title (required unless article_id is given)."
          },
          "optional": {
            "type": "boolean",
            "description": "Offers only: mark the item as optional (its price is left out of the total)."
          },
          "quantity": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": -1000000000,
            "description": "Quantity (required unless article_id is given)."
          },
          "tax_name": {
            "type": "string",
            "maxLength": 100,
            "description": "Tax name; with tax_rate overrides the standard tax of the account."
          },
          "tax_rate": {
            "type": "number",
            "maximum": 100,
            "minimum": 0,
            "description": "Tax rate in percent; the account's standard rate when omitted."
          },
          "reduction": {
            "type": "string",
            "pattern": "^\\d+(\\.\\d+)?%?$",
            "description": "Discount: absolute (10) or percent (10%)."
          },
          "article_id": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 9007199254740991,
                "exclusiveMinimum": 0
              },
              {
                "type": "string",
                "pattern": "^[1-9]\\d{0,15}$"
              }
            ],
            "description": "An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article."
          },
          "unit_price": {
            "type": "number",
            "maximum": 1000000000000,
            "minimum": -1000000000000,
            "description": "Unit price, net or gross as net_gross of the document (required unless article_id is given)."
          },
          "description": {
            "type": "string",
            "maxLength": 5000,
            "description": "Item description."
          }
        }
      },
      "maxItems": 200,
      "description": "Line items (up to 200). More can be added to the draft later."
    },
    "label": {
      "type": "string",
      "maxLength": 255,
      "description": "Label / subject."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "Document title."
    },
    "due_days": {
      "type": "integer",
      "maximum": 3650,
      "minimum": 0,
      "description": "Days until payment is due."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The client id (from billomat_list_clients)."
    },
    "net_gross": {
      "enum": [
        "NET",
        "GROSS"
      ],
      "type": "string",
      "description": "Whether prices are net or gross."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "A contact of that client."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "Document date (yyyy-mm-dd; today when omitted)."
    },
    "note": {
      "type": "string",
      "maxLength": 5000,
      "description": "Closing note."
    },
    "intro": {
      "type": "string",
      "maxLength": 5000,
      "description": "Introduction text."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "PRODUCT",
              "SERVICE"
            ],
            "type": "string",
            "description": "PRODUCT or SERVICE."
          },
          "unit": {
            "type": "string",
            "maxLength": 100,
            "description": "Unit, e.g. Stunde, Stueck, hour."
          },
          "title": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1,
            "description": "Item title (required unless article_id is given)."
          },
          "optional": {
            "type": "boolean",
            "description": "Offers only: mark the item as optional (its price is left out of the total)."
          },
          "quantity": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": -1000000000,
            "description": "Quantity (required unless article_id is given)."
          },
          "tax_name": {
            "type": "string",
            "maxLength": 100,
            "description": "Tax name; with tax_rate overrides the standard tax of the account."
          },
          "tax_rate": {
            "type": "number",
            "maximum": 100,
            "minimum": 0,
            "description": "Tax rate in percent; the account's standard rate when omitted."
          },
          "reduction": {
            "type": "string",
            "pattern": "^\\d+(\\.\\d+)?%?$",
            "description": "Discount: absolute (10) or percent (10%)."
          },
          "article_id": {
            "anyOf": [
              {
                "type": "integer",
                "maximum": 9007199254740991,
                "exclusiveMinimum": 0
              },
              {
                "type": "string",
                "pattern": "^[1-9]\\d{0,15}$"
              }
            ],
            "description": "An article id (from billomat_list_articles): title, unit, price and tax missing here are taken from the article."
          },
          "unit_price": {
            "type": "number",
            "maximum": 1000000000000,
            "minimum": -1000000000000,
            "description": "Unit price, net or gross as net_gross of the document (required unless article_id is given)."
          },
          "description": {
            "type": "string",
            "maxLength": 5000,
            "description": "Item description."
          }
        }
      },
      "maxItems": 200,
      "description": "Line items (up to 200). More can be added to the draft later."
    },
    "label": {
      "type": "string",
      "maxLength": 255,
      "description": "Label / subject."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "Document title."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The client id (from billomat_list_clients)."
    },
    "net_gross": {
      "enum": [
        "NET",
        "GROSS"
      ],
      "type": "string",
      "description": "Whether prices are net or gross."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "A contact of that client."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    },
    "validity_days": {
      "type": "integer",
      "maximum": 3650,
      "minimum": 0,
      "description": "Days the offer stays valid."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "group_by"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas."
    },
    "group_by": {
      "type": "string",
      "pattern": "^(client|status|day|week|month|year)(,(client|status|day|week|month|year))*$",
      "description": "Grouping: client, status, day, week, month, year; several separated by commas (the order sets the aggregation)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "payment_type": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Payment type(s), e.g. CASH, BANK_TRANSFER, PAYPAL; several separated by commas."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Invoice number (case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "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). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "title": {
      "type": "string",
      "maxLength": 500,
      "description": "Title (case-insensitive)."
    },
    "unit_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only articles with this unit (from billomat_list_units)."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "description": "Search in the description."
    },
    "supplier_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only articles of this supplier."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    },
    "article_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Article number."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, COMPLETED, CANCELED, CLEARED; several separated by commas."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "confirmation_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Confirmation number (partial, case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, OPEN, PAID; several separated by commas."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "credit_note_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Credit note number (case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, CREATED; several separated by commas."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "delivery_note_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Delivery note number (case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "payment_type": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Payment type(s), e.g. CASH, BANK_TRANSFER, PAYPAL; several separated by commas."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Invoice number (case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, OPEN, WON, LOST, CANCELED, CLEARED; several separated by commas."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "offer_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Offer number (partial, case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 500,
      "description": "Name of the recurring invoice."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "cycle": {
      "enum": [
        "DAILY",
        "WEEKLY",
        "MONTHLY",
        "YEARLY"
      ],
      "type": "string",
      "description": "Interval."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "payment_type": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Payment type(s), e.g. CASH, BANK_TRANSFER, PAYPAL; several separated by commas."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "to": {
      "type": "string",
      "description": "Documents dated on or before this day (yyyy-mm-dd)."
    },
    "from": {
      "type": "string",
      "description": "Documents dated on or after this day (yyyy-mm-dd)."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the note."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "tags": {
      "type": "string",
      "maxLength": 500,
      "description": "Comma-separated tags (Schlagworte)."
    },
    "intro": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the introduction text."
    },
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the label."
    },
    "status": {
      "type": "string",
      "pattern": "^[A-Z_]+(,[A-Z_]+)*$",
      "description": "Status filter: DRAFT, OPEN, PAID, OVERDUE, CANCELED; several separated by commas."
    },
    "subject": {
      "type": "string",
      "maxLength": 500,
      "description": "Free-text search in the subject."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z_]+( (ASC|DESC))?(,[a-z_]+( (ASC|DESC))?)*$",
      "description": "Sort order: field name plus ASC or DESC, several separated by commas, e.g. \"date DESC\" (default ascending)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Results per page, 1-1000 (default 100)."
    },
    "client_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client (from billomat_list_clients)."
    },
    "article_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents containing this article."
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "Only documents of this client contact."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 500,
      "description": "Number of the reminded invoice (case-insensitive)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9007199254740991,
          "exclusiveMinimum": 0
        },
        {
          "type": "string",
          "pattern": "^[1-9]\\d{0,15}$"
        }
      ],
      "description": "The client id."
    },
    "www": {
      "type": "string",
      "maxLength": 255,
      "description": "Website (without http)."
    },
    "zip": {
      "type": "string",
      "maxLength": 20,
      "description": "ZIP code."
    },
    "city": {
      "type": "string",
      "maxLength": 255,
      "description": "City."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Company name."
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "Internal note."
    },
    "email": {
      "type": "string",
      "maxLength": 255,
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 100,
      "description": "Phone."
    },
    "state": {
      "type": "string",
      "maxLength": 255,
      "description": "State / region."
    },
    "locale": {
      "type": "string",
      "maxLength": 20,
      "description": "Locale of the documents, e.g. de-DE."
    },
    "mobile": {
      "type": "string",
      "maxLength": 100,
      "description": "Mobile phone."
    },
    "street": {
      "type": "string",
      "maxLength": 255,
      "description": "Street and number."
    },
    "last_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Last name of the contact person."
    },
    "first_name": {
      "type": "string",
      "maxLength": 255,
      "description": "First name of the contact person."
    },
    "salutation": {
      "type": "string",
      "maxLength": 255,
      "description": "Salutation, e.g. Herr, Frau."
    },
    "tax_number": {
      "type": "string",
      "maxLength": 100,
      "description": "Tax number."
    },
    "vat_number": {
      "type": "string",
      "maxLength": 100,
      "description": "VAT ID."
    },
    "country_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$",
      "description": "ISO 3166 alpha-2 country code, e.g. DE, AT, CH."
    },
    "currency_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO currency code, e.g. EUR (account default when omitted)."
    }
  }
}