Call this server's tools from your browser. Nothing to install.
https://smallinvoice.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.
smallinvoice_create_contact
WRITE: creates a new company contact (customer) in smallinvoice, with its main address. Needs the "contact" scope. POST /contacts. Nothing is sent to anyone. Private persons are not supported here (smallinvoice needs more fields for them): create those in smallinvoice. Check smallinvoice_list_contacts first so you do not create a duplicate.
Main address: city.
Company name, as printed on documents.
Main address: street and number.
Main address: ISO country code, e.g. CH.
Main address: postcode.
E-mail address.
ISO currency, e.g. CHF or EUR.
Relation codes (default ['CL'] = client, as in the vendor's example). See the vendor docs for the others.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tools (27)
smallinvoice_create_contact
WRITE: creates a new company contact (customer) in smallinvoice, with its main address. Needs the "contact" scope. POST /contacts. Nothing is sent to anyone. Private persons are not supported here (smallinvoice needs more fields for them): create those in smallinvoice. Check smallinvoice_list_contacts first so you do not create a duplicate.
Argument
Type
Description
city*
string
Main address: city.
name*
string
Company name, as printed on documents.
email
string
E-mail address.
street*
string
Main address: street and number.
country*
string
Main address: ISO country code, e.g. CH.
currency
string
ISO currency, e.g. CHF or EUR.
postcode*
string
Main address: postcode.
relation
array
Relation codes (default ['CL'] = client, as in the vendor's example). See the vendor docs for the others.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"street",
"postcode",
"city",
"country"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Main address: city."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company name, as printed on documents."
},
"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": 200,
"description": "E-mail address."
},
"street": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Main address: street and number."
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Main address: ISO country code, e.g. CH."
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "ISO currency, e.g. CHF or EUR."
},
"postcode": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Main address: postcode."
},
"relation": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"maxItems": 5,
"description": "Relation codes (default ['CL'] = client, as in the vendor's example). See the vendor docs for the others."
}
}
}
smallinvoice_create_invoice
WRITE: creates a new invoice for a contact. Needs the "invoice" scope. POST /receivables/invoices. It is only created: it is NOT sent by e-mail or post and its status is not changed; the user reviews it in smallinvoice. Not idempotent: calling it twice creates two invoices. Use smallinvoice_list_contacts / smallinvoice_list_units first for the ids.
Argument
Type
Description
due*
string
Due date, yyyy-mm-dd.
date*
string
Invoice date, yyyy-mm-dd.
currency*
string
ISO currency, e.g. CHF.
language*
string
Document language: de, en, fr or it.
positions*
array
The invoice positions.
contact_id*
integer
The contact (customer) id.
contact_address_id*
integer
The id of the contact's address to print (smallinvoice_list_contact_addresses, or main_address_id on the contact).
Input schema (JSON)
smallinvoice_get_contact
One contact by id, with its fields. Add with=main_address for the main address. Needs the "contact" scope. GET /contacts/{id}.
read-only
Argument
Type
Description
id*
integer
The contact id (from smallinvoice_list_contacts).
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The contact id (from smallinvoice_list_contacts).",
"exclusiveMinimum": 0
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
}
}
}
smallinvoice_get_delivery_note
One delivery note by id. Needs the "delivery_note" scope. GET /receivables/delivery-notes/{id}.
read-only
Argument
Type
Description
id*
integer
The delivery note id.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
One project by id. Needs the "project" scope. GET /reporting/projects/{id}.
read-only
Argument
Type
Description
id*
integer
The project id (from smallinvoice_list_projects).
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The project id (from smallinvoice_list_projects).",
"exclusiveMinimum": 0
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
}
}
}
smallinvoice_list_activities
List activities (the kinds of work that hours are booked on). Needs the "activity" scope. GET /reporting/activities. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_bank_accounts
List the account's bank accounts (as printed on documents). Needs the "configuration" scope. GET /configuration/bank-accounts. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_contact_addresses
All addresses of one contact. Needs the "contact" scope. GET /contacts/{contactId}/addresses.
read-only
Argument
Type
Description
limit
integer
Items per page (default 100, max 200).
offset
integer
Items to skip (paging: the previous reply's next_offset).
List the contact groups. Needs the "contact" scope. GET /contacts/configuration/groups. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_contact_people
The contact persons of one company contact. Needs the "contact" scope. GET /contacts/{contactId}/people.
read-only
Argument
Type
Description
limit
integer
Items per page (default 100, max 200).
offset
integer
Items to skip (paging: the previous reply's next_offset).
List contacts (customers and suppliers): name, type (company or person), relation, e-mail, currency. Add with=main_address for the address. Needs the "contact" scope. GET /contacts. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_cost_units
List cost units. Needs the "cost_unit" scope. GET /reporting/cost-units. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_delivery_notes
List delivery notes. Filter by contact_id or a JSON filter. Needs the "delivery_note" scope. GET /receivables/delivery-notes. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
contact_id
integer
Only documents of this contact (customer) id.
Input schema (JSON)
smallinvoice_list_efforts
List efforts (expenses and services recorded against projects). Needs the "effort" scope. GET /reporting/efforts. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_invoice_payments
The payments recorded on one invoice. Needs the "invoice" scope. GET /receivables/invoices/{invoiceId}/payments.
read-only
Argument
Type
Description
limit
integer
Items per page (default 100, max 200).
offset
integer
Items to skip (paging: the previous reply's next_offset).
List invoices: number, contact, dates, total, currency, status. Filter by contact_id or a JSON filter. Needs the "invoice" scope. GET /receivables/invoices. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
contact_id
integer
Only documents of this contact (customer) id.
Input schema (JSON)
smallinvoice_list_offers
List offers (quotes). Filter by contact_id or a JSON filter. Needs the "offer" scope. GET /receivables/offers. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
contact_id
integer
Only documents of this contact (customer) id.
Input schema (JSON)
smallinvoice_list_order_confirmations
List order confirmations. Filter by contact_id or a JSON filter. Needs the "order_confirmation" scope. GET /receivables/order-confirmations. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
contact_id
integer
Only documents of this contact (customer) id.
Input schema (JSON)
smallinvoice_list_products
List the catalog's products (articles). Needs the "catalog" scope. GET /catalog/products. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_projects
List projects. Needs the "project" scope. GET /reporting/projects. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_services
List the catalog's services. Needs the "catalog" scope. GET /catalog/services. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_units
List the units (piece, hour, ...) with their ids, which an invoice position's unit_id refers to. Needs the "configuration" scope. GET /catalog/configuration/units. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
smallinvoice_list_working_hours
List recorded working hours (time tracking entries). Needs the "working_hours" scope. GET /reporting/working-hours. Returns count, total, next_offset (pass it as offset for the next page) and the items.
read-only
Argument
Type
Description
q
string
Optional free-text search over several fields.
sort
string
Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several.
with
string
Optional extra fields to include, comma separated (e.g. 'main_address' on contacts).
limit
integer
Items per page (default 100, max 200).
filter
string
Optional filter as a JSON object string, e.g. {"currency":"CHF"}; combine with {"and":[...]} / {"or":[...]}. Comparators go before the value: "<", "<=", ">", ">=", "!" (not), "~" (contains), e.g. {"name":"~ACME"}. Unknown field names are answered with HTTP 400.
offset
integer
Items to skip (paging: the previous reply's next_offset).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id",
"contact_address_id",
"date",
"due",
"currency",
"language",
"positions"
],
"properties": {
"due": {
"type": "string",
"description": "Due date, yyyy-mm-dd."
},
"date": {
"type": "string",
"description": "Invoice date, yyyy-mm-dd."
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "ISO currency, e.g. CHF."
},
"language": {
"type": "string",
"pattern": "^[a-z]{2}$",
"description": "Document language: de, en, fr or it."
},
"positions": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"price",
"amount",
"unit_id",
"vat"
],
"properties": {
"vat": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "VAT percentage, e.g. 8.1."
},
"name": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Position name."
},
"type": {
"type": "string",
"pattern": "^[A-Z]$",
"description": "Position type (default 'N' = normal, as in the vendor's example)."
},
"price": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Unit price (net, in the invoice currency)."
},
"amount": {
"type": "number",
"maximum": 1000000000,
"description": "Quantity.",
"exclusiveMinimum": 0
},
"unit_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Unit id (smallinvoice_list_units).",
"exclusiveMinimum": 0
},
"description": {
"type": "string",
"maxLength": 2000,
"description": "Position description."
},
"catalog_type": {
"type": "string",
"pattern": "^[A-Z]$",
"description": "Catalog type (default 'P', as in the vendor's example)."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "The invoice positions."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The contact (customer) id.",
"exclusiveMinimum": 0
},
"contact_address_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The id of the contact's address to print (smallinvoice_list_contact_addresses, or main_address_id on the contact).",
"exclusiveMinimum": 0
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this contact (customer) id.",
"exclusiveMinimum": 0
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this contact (customer) id.",
"exclusiveMinimum": 0
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this contact (customer) id.",
"exclusiveMinimum": 0
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Optional free-text search over several fields."
},
"sort": {
"type": "string",
"pattern": "^-?[A-Za-z0-9_.]+(,-?[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional sort: 'name' ascending, '-name' descending, '-surname,name' for several."
},
"with": {
"type": "string",
"pattern": "^[A-Za-z0-9_.]+(,[A-Za-z0-9_.]+)*$",
"maxLength": 200,
"description": "Optional extra fields to include, comma separated (e.g. 'main_address' on contacts)."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Items per page (default 100, max 200)."
},
"filter": {
"type": "string",
"maxLength": 2000,
"description": "Optional filter as a JSON object string, e.g. {\"currency\":\"CHF\"}; combine with {\"and\":[...]} / {\"or\":[...]}. Comparators go before the value: \"<\", \"<=\", \">\", \">=\", \"!\" (not), \"~\" (contains), e.g. {\"name\":\"~ACME\"}. Unknown field names are answered with HTTP 400."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Items to skip (paging: the previous reply's next_offset)."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this contact (customer) id.",
"exclusiveMinimum": 0
}
}
}
