fakturownia-client 0.1.1

Python client for the Fakturownia (InvoiceOcean) REST API

fakturownia-client

Python client for the Fakturownia (InvoiceOcean) REST API. Covers invoices (list/search, create/update, status changes, PDF download), clients (CRUD) and products.

Security note: token in header, never in URL

The official Fakturownia docs mostly show ?api_token=... in URLs, which leaks tokens into server and proxy logs. This client sends the token only in the Authorization: Bearer header. Header auth was verified against the live API for every endpoint used here (see scripts/verify_auth.py — a no-side-effects check you can run against your own account).

Install

uv add fakturownia-client   # or: pip install fakturownia-client

Usage

from fakturownia_client import FakturowniaClient, InvoiceCreate, InvoicePositionCreate

with FakturowniaClient("mycompany", api_token="...") as fk:
    # list & search
    invoices = fk.list_invoices(period="this_month", include_positions=True)
    for inv in fk.iter_invoices(period="this_year"):  # auto-pagination
        print(inv.number, inv.price_gross)

    # create
    created = fk.create_invoice(
        InvoiceCreate(
            buyer_name="ACME Sp. z o.o.",
            buyer_tax_no="1234567890",
            positions=[InvoicePositionCreate(name="Usługa", total_price_gross=123.00, tax=23)],
        )
    )

    # status & PDF
    fk.change_invoice_status(created.id, "paid")
    pdf = fk.download_invoice_pdf(created.id)

    # clients / products
    clients = fk.list_clients(tax_no="1234567890")
    products = fk.list_products()

Async

AsyncFakturowniaClient mirrors the sync API 1:1 on httpx.AsyncClient:

from fakturownia_client import AsyncFakturowniaClient

async with AsyncFakturowniaClient("mycompany", api_token="...") as fk:
    invoices = await fk.list_invoices(period="this_month")
    async for inv in fk.iter_invoices(period="this_year"):
        print(inv.number)

domain accepts "mycompany", "mycompany.fakturownia.pl" or a full URL.

InvoiceOcean

InvoiceOcean is the international brand of Fakturownia — same API. Pass your full domain: FakturowniaClient("mycompany.invoiceocean.com", api_token=...). There is also an official alias package, invoiceocean-client, which re-exports this API as InvoiceOceanClient / AsyncInvoiceOceanClient. Errors raise typed exceptions: AuthenticationError, NotFoundError, ValidationError, RateLimitError, ServerError (all subclass FakturowniaError).

Caveat: delete_product() calls an endpoint absent from the official API docs — it may not work on all accounts.

Development

uv sync --extra dev
uv run ruff check . && uv run mypy && uv run pytest -m "not live"

# optional read-only smoke test against the real API:
FAKTUROWNIA_DOMAIN=mycompany FAKTUROWNIA_API_TOKEN=... uv run pytest -m live

License

MIT