superfaktura_get_company
Get the company profile and API limits
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.
Parametersall_companies
superfaktura_list_invoices
List or search 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.
Parameterspagetypesearchstatusorder_noper_pagevariableamount_toclient_iddirectioncreated_toinvoice_no+4 more
superfaktura_get_invoice
Get an 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.
Parametersinvoice_idrequired
superfaktura_list_clients
List or search 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.
Parameterspagesearchper_pagedirectioncreated_periodmodified_period
superfaktura_get_client
Get a client
One client with address, tax ids, bank data, default currency/due days/discount and statistics. GET /clients/view/{id}.
Parametersclient_idrequired
superfaktura_list_contact_persons
List a client's contact persons
The contact persons (name, e-mail, phone) stored for one client. GET /contact_people/getContactPeople/{client_id}.
Parametersclient_idrequired
superfaktura_list_expenses
List or search 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.
Parameterspagetypesearchstatusper_pageamount_toclient_iddirectioncreated_toamount_fromcategory_idcreated_since+1 more
superfaktura_get_expense
Get an expense
One expense with its items, VAT rates, payments and supplier. Attachments are not returned. GET /expenses/view/{id}.json.
Parametersexpense_idrequired
superfaktura_list_expense_categories
List expense categories
The expense category tree (id, name, parent) for the category_id of expenses. GET /expenses/expense_categories.
Takes no parameters.
superfaktura_list_bank_accounts
List bank accounts
The company's bank accounts as stored in SuperFaktura (bank name, IBAN, SWIFT, default flag). GET /bank_accounts/index.
Takes no parameters.
superfaktura_list_bank_moves
List imported bank account 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.
Parameterspagesearchdate_toper_pageamount_todirectionmove_typedate_sinceamount_fromdate_period
superfaktura_list_cash_registers
List cash registers
The company's cash registers with currency, number of entries and current balance (read only). GET /cash_registers/getDetails.
Takes no parameters.
superfaktura_get_cash_register
Get a cash register
One cash register with currency, number of entries and current balance (read only). GET /cash_registers/view/{id}.
Parameterscash_register_idrequired
superfaktura_list_stock_items
List or search 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.
Parametersskupagesearchper_pageprice_todirectionprice_fromin_stock_only
superfaktura_get_stock_item
Get a stock item
One warehouse item with SKU, price, VAT, purchase price and quantity in stock. GET /stock_items/view/{id}.
Parametersstock_item_idrequired
superfaktura_list_stock_movements
List stock movements of an item
The stock log of one item (quantity changes, notes, related invoice or expense). Paged: pass next_page as page. GET /stock_items/movements/{id}.
Parameterspageper_pagedirectionstock_item_idrequired
superfaktura_list_tags
List tags
The tags (id and name) usable on invoices, expenses and clients. GET /tags/index.json.
Takes no parameters.
superfaktura_list_sequences
List numbering 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.
Takes no parameters.
superfaktura_list_countries
List countries
SuperFaktura's country ids with ISO code and EU flag, for the country_id of clients. GET /countries/index/view_full:1.
Takes no parameters.
superfaktura_get_response_by_checksum
Recover the reply of a create by its 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}.
Parameterschecksumrequired
superfaktura_create_client
Create a 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.
Parametersdicicozipcityibannamerequiredemailphoneswiftic_dphaddresscomment+1 more
superfaktura_add_contact_person
Add a contact person to a client
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.
Parametersnamerequiredemailrequiredphoneclient_idrequired
superfaktura_create_tag
Create a 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.
Parametersnamerequired
superfaktura_create_expense
Record a received 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.
Parametersduevatnamerequiredtypeamountrequiredcommentcreatedcurrencydeliveryvariableclient_idcategory_id+1 more
superfaktura_create_invoice
Create an unsent invoice document
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.
Parametersduenametypeitemsrequiredcommentcreatedchecksumconstantdeliveryorder_nospecificvariable+14 more
