Servers Playground How we check Add a server Log in

SuperFaktura MCP by usefulapi

Working · 489 ms

io.usefulapi/superfakturav1.8.0 Domain verified

Read SuperFaktura invoices, clients, expenses, bank and stock; create clients, expenses and drafts.

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://superfaktura.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.

superfaktura_add_contact_person Destructive

WRITE: adds a contact person (name and e-mail, optional phone) to an existing client. Nothing is sent to that person. Not idempotent. POST /contact_people/add/api:1.

namestring, required

Contact person's name.

emailstring, required

Contact person's e-mail (stored only).

client_idinteger, required

Existing client id.

phonestring

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

SuperFaktura MCP by usefulapi MCP server | mcptry

Tools (25)

superfaktura_add_contact_person

WRITE: adds a contact person (name and e-mail, optional phone) to an existing client. Nothing is sent to that person. Not idempotent. POST /contact_people/add/api:1.

destructive

Argument	Type	Description
name*	string	Contact person's name.
email*	string	Contact person's e-mail (stored only).
phone	string
client_id*	integer	Existing client id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id",
    "name",
    "email"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Contact person's name."
    },
    "email": {
      "type": "string",
      "pattern": "^[^\\s@]+@[^\\s@]+$",
      "maxLength": 254,
      "description": "Contact person's e-mail (stored only)."
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing client id.",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_create_client

WRITE: adds a new client to the SuperFaktura address book (only the name is required). Nothing is sent to the client. Not idempotent: calling twice creates two clients, so check superfaktura_list_clients first. POST /clients/create.

destructive

Argument	Type	Description
dic	string	Tax id (DIČ, Slovak).
ico	string	Company id (IČO).
zip	string
city	string
iban	string
name*	string	Client name (company or person).
email	string	Client e-mail (stored only; nothing is sent to it).
phone	string
swift	string
ic_dph	string	VAT id (IČ DPH in Slovakia, DIČ in the Czech Republic).

superfaktura_create_expense

WRITE: records a received document (expense) with ONE total amount and VAT rate, e.g. a supplier invoice or a bill. It is created unpaid: no payment is recorded and nothing is sent. No attachments. Not idempotent: calling twice records two expenses. POST /expenses/add.

destructive

Argument	Type	Description
due	string	Due date (default today).
vat	number	VAT rate in percent (default 0).
name*	string	Expense name / what it is for.
type	string	Expense type (default invoice = received invoice).
amount*	number	Amount WITHOUT VAT.
comment	string	Comment.
created	string	Issue date (default today).
currency	string	3-letter currency code, e.g. EUR, CZK.
delivery	string	Delivery date (default today).

superfaktura_create_invoice

WRITE: creates ONE document in SuperFaktura for the user to review: type draft (concept, default), estimate (quote), order or proforma. A final regular invoice cannot be created here. It is NOT sent (no e-mail, no post), NOT marked paid or sent, and has no payment link or discount. Give an existing client_id (its name is read first with one extra GET /clients/view/{id}, so the call uses 2 requests of the daily quota) OR a new client's name (+ optional ico/dic/ic_dph/address...). Items: name, unit price without VAT, VAT rate, quantity. Not idempotent: pass a checksum (max 32 chars) so a timed-out call can be recovered with superfaktura_get_response_by_checksum instead of retried. POST /invoices/create.

destructive

Argument	Type	Description
due	string	Due date.
name	string	Document title (default generated from the number).
type	string	Document type: draft (default), estimate, order or proforma.
items*	array	1-100 items.
comment	string	Comment on the document.
created	string	Issue date (default today).
checksum	string	Your own unique token (max 32 chars) to recover the reply if the call times out.

superfaktura_create_tag

WRITE: adds a new tag name (usable on invoices, expenses and clients in the SuperFaktura app). A duplicate name is refused by SuperFaktura. POST /tags/add.

destructive

Argument	Type	Description
name*	string	Tag name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Tag name."
    }
  }
}

superfaktura_get_cash_register

One cash register with currency, number of entries and current balance (read only). GET /cash_registers/view/{id}.

read-only

Argument	Type	Description
cash_register_id*	integer	Cash register id (from superfaktura_list_cash_registers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "cash_register_id"
  ],
  "properties": {
    "cash_register_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Cash register id (from superfaktura_list_cash_registers).",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_get_client

One client with address, tax ids, bank data, default currency/due days/discount and statistics. GET /clients/view/{id}.

read-only

Argument	Type	Description
client_id*	integer	Client id (from superfaktura_list_clients).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id"
  ],
  "properties": {
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Client id (from superfaktura_list_clients).",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_get_company

The company the API key is working in (name, IČO, DIČ, IČ DPH, address, VAT-payer flag, bank accounts) and the remaining API quota (SuperFaktura's fair-use policy is 1000 requests per day and 31000 per month; every tool call here uses one request). Good first call. With all_companies=true also the other companies the user can access (their ids are the company_id of the login). GET /users/getUserCompaniesData.

read-only

Argument	Type	Description
all_companies	boolean	true = every company the user has access to, not only the current one.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "all_companies": {
      "type": "boolean",
      "description": "true = every company the user has access to, not only the current one."
    }
  }
}

superfaktura_get_expense

One expense with its items, VAT rates, payments and supplier. Attachments are not returned. GET /expenses/view/{id}.json.

read-only

Argument	Type	Description
expense_id*	integer	Expense id (from superfaktura_list_expenses).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "expense_id"
  ],
  "properties": {
    "expense_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Expense id (from superfaktura_list_expenses).",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_get_invoice

One document (invoice, proforma, quote ...) with its header (number, dates, status, amounts, currency, symbols, comments), client, items, VAT summary, payments and related documents. The public access token and payment links of the document are not returned. GET /invoices/view/{id}.json.

read-only

Argument	Type	Description
invoice_id*	integer	Invoice id (the id of a superfaktura_list_invoices row).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoice id (the id of a superfaktura_list_invoices row).",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_get_response_by_checksum

If a superfaktura_create_invoice call timed out, fetch the reply of the ORIGINAL request by the checksum it was sent with (kept 3 months), so the document is not created twice. GET /api_logs/getResponseByChecksum/{checksum}.

read-only

Argument	Type	Description
checksum*	string	The checksum given to superfaktura_create_invoice.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "checksum"
  ],
  "properties": {
    "checksum": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._-]{1,32}$",
      "description": "The checksum given to superfaktura_create_invoice."
    }
  }
}

superfaktura_get_stock_item

One warehouse item with SKU, price, VAT, purchase price and quantity in stock. GET /stock_items/view/{id}.

read-only

Argument	Type	Description
stock_item_id*	integer	Stock item id (from superfaktura_list_stock_items).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "stock_item_id"
  ],
  "properties": {
    "stock_item_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Stock item id (from superfaktura_list_stock_items).",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_list_bank_accounts

The company's bank accounts as stored in SuperFaktura (bank name, IBAN, SWIFT, default flag). GET /bank_accounts/index.

read-only

No arguments.

Input schema (JSON)

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

superfaktura_list_bank_moves

Bank transactions imported into SuperFaktura (date, amount, currency, variable symbol, counter account, matching state), newest first by default. Filter by date range, credit/debit or amount. Paged: pass next_page as page. GET /accounts/index.json.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
search	string	Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records).
date_to	string	Transactions on or before (yyyy-mm-dd).
per_page	integer	Results per page, 1-100 (the account's profile default when omitted).
amount_to	number
direction	string	Sort direction.
move_type	string	credit = incoming, debit = outgoing.
date_since	string	Transactions on or after (yyyy-mm-dd).
amount_from

superfaktura_list_cash_registers

The company's cash registers with currency, number of entries and current balance (read only). GET /cash_registers/getDetails.

read-only

No arguments.

Input schema (JSON)

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

superfaktura_list_clients

List the address book (clients and suppliers) with contact data and totals. search matches name, IČO, DIČ, IČ DPH, bank account, e-mail, address, city, phone, note and tags. Paged: pass next_page as page. GET /clients/index.json.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
search	string	Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records).
per_page	integer	Results per page, 1-100 (the account's profile default when omitted).
direction	string	Sort direction (default DESC).
created_period	string	Created in this period.
modified_period	string	Changed in this period.

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."
    },
    "search": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (the account's profile default when omitted)."
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (default DESC)."
    },
    "created_period": {
      "enum": [
        "all",
        "today",
        "yesterday",
        "this_week",
        "this_month",
        "last_month",
        "this_quarter",
        "last_quarter",
        "this_year",
        "last_year"
      ],
      "type": "string",
      "description": "Created in this period."
    },
    "modified_period": {
      "enum": [
        "all",
        "today",
        "yesterday",
        "this_week",
        "this_month",
        "last_month",
        "this_quarter",
        "last_quarter",
        "this_year",
        "last_year"
      ],
      "type": "string",
      "description": "Changed in this period."
    }
  }
}

superfaktura_list_contact_persons

The contact persons (name, e-mail, phone) stored for one client. GET /contact_people/getContactPeople/{client_id}.

read-only

Argument	Type	Description
client_id*	integer	Client id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id"
  ],
  "properties": {
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Client id.",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_list_countries

SuperFaktura's country ids with ISO code and EU flag, for the country_id of clients. GET /countries/index/view_full:1.

read-only

No arguments.

Input schema (JSON)

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

superfaktura_list_expense_categories

The expense category tree (id, name, parent) for the category_id of expenses. GET /expenses/expense_categories.

read-only

No arguments.

Input schema (JSON)

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

superfaktura_list_expenses

List received documents (expenses: received invoices, bills, internal documents) with amounts, VAT, supplier and payment status. status: issued (new), partially_paid, paid, overdue. Without a date filter SuperFaktura applies its default period; pass created_period='all' for everything. Paged: pass next_page as page. GET /expenses/index.json.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
type	string	Expense type (note the vendor's spelling recieved_credit_note).
search	string	Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records).
status	string	Payment status.
per_page	integer	Results per page, 1-100 (the account's profile default when omitted).
amount_to	number
client_id	integer	Supplier (client) id.
direction	string	Sort direction (default DESC).

superfaktura_list_invoices

List issued documents with client, items, totals and payment status. type selects the document kind (default regular = ordinary invoices; also proforma, estimate = quote, order, cancel = credit note, delivery, draft, reverse_order; several allowed). Without a date filter SuperFaktura returns only the CURRENT YEAR; use created_period='all' or a date range for older ones. status: issued, partially_paid, paid, overdue. search matches client name, number, VS ... Paged: pass next_page as page. GET /invoices/index.json.

read-only

Argument	Type	Description
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
type	array	Document types (default: regular).
search	string	Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records).
status	string	Payment status.
order_no	string	Order number the document was created from.
per_page	integer	Results per page, 1-100 (the account's profile default when omitted).
variable	string	Variable symbol.

superfaktura_list_sequences

The document numbering sequences per document type (id, name, mask, next formatted number, default flag); sequence ids are used when creating documents. GET /sequences/index.json.

read-only

No arguments.

Input schema (JSON)

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

superfaktura_list_stock_items

List warehouse items (name, SKU, unit, price, VAT, quantity in stock). search matches name, SKU and description; sku matches the SKU. Paged: pass next_page as page. GET /stock_items/index.json.

read-only

Argument	Type	Description
sku	string	Search by SKU.
page	integer	Page number, 1-based (default 1). Use next_page from the previous reply.
search	string	Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records).
per_page	integer	Results per page, 1-100 (the account's profile default when omitted).
price_to	number
direction	string	Sort direction.
price_from	number
in_stock_only	boolean	true = only items that are in stock.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sku": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1,
      "description": "Search by SKU."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, 1-based (default 1). Use next_page from the previous reply."
    },
    "search": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (the account's profile default when omitted)."
    },
    "price_to": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "price_from": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0
    },
    "in_stock_only": {
      "type": "boolean",
      "description": "true = only items that are in stock."
    }
  }
}

superfaktura_list_stock_movements

The stock log of one item (quantity changes, notes, related invoice or expense). Paged: pass next_page as page. GET /stock_items/movements/{id}.

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-100 (the account's profile default when omitted).
direction	string	Sort direction (default ASC).
stock_item_id*	integer	Stock item id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "stock_item_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": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (the account's profile default when omitted)."
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (default ASC)."
    },
    "stock_item_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Stock item id.",
      "exclusiveMinimum": 0
    }
  }
}

superfaktura_list_tags

The tags (id and name) usable on invoices, expenses and clients. GET /tags/index.json.

read-only

No arguments.

Input schema (JSON)

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

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "amount"
  ],
  "properties": {
    "due": {
      "type": "string",
      "description": "Due date (default today)."
    },
    "vat": {
      "type": "number",
      "maximum": 100,
      "minimum": 0,
      "description": "VAT rate in percent (default 0)."
    },
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Expense name / what it is for."
    },
    "type": {
      "enum": [
        "invoice",
        "bill",
        "internal",
        "nondeductible"
      ],
      "type": "string",
      "description": "Expense type (default invoice = received invoice)."
    },
    "amount": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": -1000000000000,
      "description": "Amount WITHOUT VAT."
    },
    "comment": {
      "type": "string",
      "maxLength": 2000,
      "description": "Comment."
    },
    "created": {
      "type": "string",
      "description": "Issue date (default today)."
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "3-letter currency code, e.g. EUR, CZK."
    },
    "delivery": {
      "type": "string",
      "description": "Delivery date (default today)."
    },
    "variable": {
      "type": "string",
      "maxLength": 40,
      "description": "Variable symbol."
    },
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Supplier (client) id from superfaktura_list_clients.",
      "exclusiveMinimum": 0
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Expense category id from superfaktura_list_expense_categories.",
      "exclusiveMinimum": 0
    },
    "document_number": {
      "type": "string",
      "maxLength": 60,
      "description": "The supplier's document number."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "items"
  ],
  "properties": {
    "due": {
      "type": "string",
      "description": "Due date."
    },
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Document title (default generated from the number)."
    },
    "type": {
      "enum": [
        "draft",
        "estimate",
        "order",
        "proforma"
      ],
      "type": "string",
      "description": "Document type: draft (default), estimate, order or proforma."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "unit_price"
        ],
        "properties": {
          "tax": {
            "type": "number",
            "maximum": 100,
            "minimum": 0,
            "description": "VAT rate in percent, e.g. 20 (use 0 when the company is not a VAT payer)."
          },
          "name": {
            "type": "string",
            "maxLength": 250,
            "minLength": 1,
            "description": "Item name."
          },
          "unit": {
            "type": "string",
            "maxLength": 20,
            "description": "Unit, e.g. ks, h, m."
          },
          "quantity": {
            "type": "number",
            "maximum": 1000000000,
            "description": "Quantity (default 1).",
            "exclusiveMinimum": 0
          },
          "unit_price": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": -1000000000,
            "description": "Unit price WITHOUT VAT (the full price when the company is not a VAT payer)."
          },
          "description": {
            "type": "string",
            "maxLength": 5000,
            "description": "Item description shown on the document."
          }
        }
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "1-100 items."
    },
    "comment": {
      "type": "string",
      "maxLength": 5000,
      "description": "Comment on the document."
    },
    "created": {
      "type": "string",
      "description": "Issue date (default today)."
    },
    "checksum": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._-]{1,32}$",
      "description": "Your own unique token (max 32 chars) to recover the reply if the call times out."
    },
    "constant": {
      "type": "string",
      "maxLength": 10,
      "description": "Constant symbol."
    },
    "delivery": {
      "type": "string",
      "description": "Delivery date."
    },
    "order_no": {
      "type": "string",
      "maxLength": 40,
      "description": "Order number."
    },
    "specific": {
      "type": "string",
      "maxLength": 20,
      "description": "Specific symbol."
    },
    "variable": {
      "type": "string",
      "maxLength": 40,
      "description": "Variable symbol (the document number when empty)."
    },
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing client id (superfaktura_list_clients). Give this OR client_name.",
      "exclusiveMinimum": 0
    },
    "client_dic": {
      "type": "string",
      "maxLength": 40,
      "description": "Client tax id (DIČ), with client_name."
    },
    "client_ico": {
      "type": "string",
      "maxLength": 40,
      "description": "Client company id (IČO), with client_name."
    },
    "client_zip": {
      "type": "string",
      "maxLength": 20,
      "description": "Client ZIP, with client_name."
    },
    "client_city": {
      "type": "string",
      "maxLength": 255,
      "description": "Client city, with client_name."
    },
    "client_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Name of a new/matching client (used when client_id is not given)."
    },
    "sequence_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Numbering sequence id (superfaktura_list_sequences).",
      "exclusiveMinimum": 0
    },
    "client_email": {
      "type": "string",
      "pattern": "^[^\\s@]+@[^\\s@]+$",
      "maxLength": 254,
      "description": "Client e-mail, with client_name (stored only; nothing is sent)."
    },
    "client_ic_dph": {
      "type": "string",
      "maxLength": 40,
      "description": "Client VAT id, with client_name."
    },
    "client_address": {
      "type": "string",
      "maxLength": 255,
      "description": "Client street and number, with client_name."
    },
    "header_comment": {
      "type": "string",
      "maxLength": 5000,
      "description": "Comment above the items (shown on the document)."
    },
    "internal_comment": {
      "type": "string",
      "maxLength": 5000,
      "description": "Internal comment (not shown on the document)."
    },
    "invoice_currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "3-letter currency code, e.g. EUR, CZK."
    },
    "client_country_id": {
      "type": "integer",
      "maximum": 1000,
      "description": "Client country id (superfaktura_list_countries), with client_name.",
      "exclusiveMinimum": 0
    }
  }
}

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."
    },
    "type": {
      "enum": [
        "invoice",
        "bill",
        "contribution",
        "internal",
        "nondeductible",
        "recieved_credit_note"
      ],
      "type": "string",
      "description": "Expense type (note the vendor's spelling recieved_credit_note)."
    },
    "search": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records)."
    },
    "status": {
      "enum": [
        "issued",
        "partially_paid",
        "paid",
        "overdue"
      ],
      "type": "string",
      "description": "Payment status."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (the account's profile default when omitted)."
    },
    "amount_to": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0
    },
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Supplier (client) id.",
      "exclusiveMinimum": 0
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (default DESC)."
    },
    "created_to": {
      "type": "string",
      "description": "Issued on or before (yyyy-mm-dd)."
    },
    "amount_from": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Expense category id (superfaktura_list_expense_categories).",
      "exclusiveMinimum": 0
    },
    "created_since": {
      "type": "string",
      "description": "Issued on or after (yyyy-mm-dd)."
    },
    "created_period": {
      "enum": [
        "all",
        "today",
        "yesterday",
        "this_week",
        "this_month",
        "last_month",
        "this_quarter",
        "last_quarter",
        "this_year",
        "last_year"
      ],
      "type": "string",
      "description": "Issue date as a period."
    }
  }
}

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."
    },
    "type": {
      "type": "array",
      "items": {
        "enum": [
          "regular",
          "proforma",
          "estimate",
          "order",
          "cancel",
          "delivery",
          "draft",
          "reverse_order"
        ],
        "type": "string"
      },
      "maxItems": 8,
      "minItems": 1,
      "description": "Document types (default: regular)."
    },
    "search": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Text to search for (matched by SuperFaktura in names, numbers, e-mails ... of the records)."
    },
    "status": {
      "enum": [
        "issued",
        "partially_paid",
        "paid",
        "overdue"
      ],
      "type": "string",
      "description": "Payment status."
    },
    "order_no": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "Order number the document was created from."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (the account's profile default when omitted)."
    },
    "variable": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "Variable symbol."
    },
    "amount_to": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0,
      "description": "Maximum amount."
    },
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only documents of this client (superfaktura_list_clients).",
      "exclusiveMinimum": 0
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (default DESC)."
    },
    "created_to": {
      "type": "string",
      "description": "Issued on or before (yyyy-mm-dd)."
    },
    "invoice_no": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "Formatted document number, e.g. 2026001."
    },
    "amount_from": {
      "type": "number",
      "maximum": 1000000000000,
      "minimum": 0,
      "description": "Minimum amount."
    },
    "created_since": {
      "type": "string",
      "description": "Issued on or after (yyyy-mm-dd)."
    },
    "created_period": {
      "enum": [
        "all",
        "today",
        "yesterday",
        "this_week",
        "this_month",
        "last_month",
        "this_quarter",
        "last_quarter",
        "this_year",
        "last_year"
      ],
      "type": "string",
      "description": "Issue date as a period (default this_year when no date filter is given)."
    },
    "modified_period": {
      "enum": [
        "all",
        "today",
        "yesterday",
        "this_week",
        "this_month",
        "last_month",
        "this_quarter",
        "last_quarter",
        "this_year",
        "last_year"
      ],
      "type": "string",
      "description": "Last changed in this period."
    }
  }
}