Fakturoid

Manage user accounts. Use action=index first to discover available account slugs, then action=show for full details.

accounts

List bank accounts for an account. Use before creating invoices to check available accounts and their IDs.

bank_accounts

Expenses of one Fakturoid account (bounded by slug). Six operations, selected by action: index lists expenses (optional filters), show returns full details of one expense, create records a new expense, search runs fulltext search, add_attachment returns a one-time upload token and the Fakturoid upload endpoint for attaching a file to an existing expense, mark_as_paid records a payment for the remaining amount in Fakturoid and marks the expense as paid; no money is transferred. Create a subject first using subjects tool.

expenses

Inbox files (Krabice) of one Fakturoid account (bounded by slug). Three operations, selected by action: index lists uploaded files, create returns a one-time upload token and the Fakturoid upload endpoint for a new file, send_to_ocr sends a file for document extraction.

inbox_files

Invoices of one Fakturoid account (bounded by slug). Five operations, selected by action: index lists invoices (optional filters), show returns full details of one invoice, create issues a new invoice, search runs fulltext search, pay records a payment on a regular invoice or proforma in Fakturoid; no money is transferred (proforma_followup_document controls what is created when proforma is paid). Create a subject first using subjects tool. For revenue sums, filter by document_type (invoice, proforma, correction, tax_document) — these categories are disjoint and safe to sum separately; summing across them double-counts. Use issued_from/issued_to for historical analysis by issue date (works for retroactively dated documents); since filters by created_at, not issued_on. Use order=asc for chronological walks. To check whether an invoice is paid, use status (paid/open/overdue/cancelled/uncollectible) and paid_on — not remaining_amount. The remaining_amount field tracks how much of the invoice is NOT covered by a linked proforma/advance (equals total for regular invoices, regardless of payments), not the outstanding balance. The show response includes public_html_url, a shareable link that opens without login; appending .pdf, .isdoc or .ubl gives the document file.

invoices

Aggregate financial reports. Use action=yearly to get income/expense/profit totals broken down by month, quarter, or year. For period=month or quarter, totals equal the sum of lines for the requested year. For period=year, response contains 4 lines (current year and 3 previous years) for trend context, while totals reflect only the requested year. Choose date_column based on what you want to measure: issued_on for revenue analysis (what was billed), taxable_fulfillment_due for VAT periods (what is reportable for VAT returns), paid_on for cash actually received/spent on documents, cashflow for bank-account cashflow including payments without documents (always with VAT). When the response contains payment_summary (date_column=cashflow or paid_on with period=year), always display its adjustment (payment adjustment) and rate_difference (exchange rate difference) alongside the totals table — they show the gap between document amounts and actual payments.

reports

Manage contacts (subjects). Use action=index to list, action=show for details, action=create to add new contact, action=search for fulltext search.

subjects