Skip to main content

CLI wrapper for Collmex accounting API - LLM-friendly interface

Project description

collmex-cli

LLM-friendly CLI wrapper for the Collmex accounting API (Buchhaltung Pro).

Installation

# From PyPI (recommended)
uv tool install collmex-cli

# From source (development)
uv pip install -e .

Configuration

Set environment variables (or use a .env file):

export COLLMEX_CUSTOMER_ID="your_customer_id"
export COLLMEX_COMPANY_ID="1"  # usually 1
export COLLMEX_USERNAME="your_username"
export COLLMEX_PASSWORD="your_password"

Seller master data (required for PDF invoice rendering)

export COLLMEX_SELLER_NAME="cognovis GmbH"
export COLLMEX_SELLER_STREET="Musterstraße 1"
export COLLMEX_SELLER_ZIP="12345"
export COLLMEX_SELLER_CITY="Berlin"
export COLLMEX_SELLER_VAT_ID="DE123456789"
export COLLMEX_SELLER_HRB="HRB 12345"
export COLLMEX_SELLER_IBAN="DE00 1234 5678 9012 3456 78"
export COLLMEX_SELLER_BIC="BELADEBEXXX"

# Optional
export COLLMEX_SELLER_AMTSGERICHT="Amtsgericht Berlin-Charlottenburg"
export COLLMEX_SELLER_GESCHAEFTSFUEHRUNG="Max Mustermann"
export COLLMEX_SELLER_PHONE="+49 30 123456"
export COLLMEX_SELLER_FAX="+49 30 123457"
export COLLMEX_SELLER_WEB="https://www.cognovis.de"
export COLLMEX_SELLER_EMAIL="info@cognovis.de"
export COLLMEX_SELLER_BANK_NAME="Deutsche Bank"

Usage

Test Connection

collmex test

Vendors (Lieferanten)

# List all vendors
collmex vendors

# Search vendors
collmex vendors --search "Amazon"

# Output as JSON (LLM-friendly)
collmex vendors --json

# Create a vendor
collmex vendor-create --company "New Supplier GmbH" --city "Berlin" --email "info@supplier.de"

Open Items (Offene Posten)

# List vendor open items (unpaid vendor invoices)
collmex open-items --vendor

# List customer open items
collmex open-items --customer

# Output as JSON
collmex open-items --vendor --json

Bookings (Buchungen)

# List all bookings
collmex bookings

# Filter by account
collmex bookings --account 1200

# Filter by date range
collmex bookings --from 2024-01-01 --to 2024-12-31

# Search in booking text
collmex bookings --search "Amazon"

Unmatched Bank Transactions

# Find bank transactions without matching invoices/receipts
collmex unmatched

# For a specific bank account
collmex unmatched --account 1200

# Output as JSON
collmex unmatched --json

Customer Invoices (Ausgangsrechnungen)

# Book a customer invoice in accounting (no invoicing module required)
collmex customer-invoice \
  --customer-id 10001 \
  --invoice "RE-2024-042" \
  --date 2024-01-15 \
  --net 1000.00 \
  --tax-rate 19 \
  --text "Consulting January 2024" \
  --account 8400

# Override the computed tax amount explicitly
collmex customer-invoice --customer-id 10001 --invoice "RE-2024-043" \
  --date 2024-01-15 --net 500.00 --tax 95.00

# Output as JSON
collmex customer-invoice --customer-id 10001 --invoice "RE-2024-044" \
  --date 2024-01-15 --net 200.00 --json

After booking, the invoice appears in open-items --customer until payment is received and in bookings with the debtor and revenue accounts.

ZUGFeRD Customer Invoice (PDF/A-3 with embedded XML)

Generate a ZUGFeRD-compliant PDF/A-3 invoice with embedded EN16931 XML. Seller is always cognovis (VAT ID DE118620281); buyer master data is fetched from Collmex by customer ID.

collmex customer-zugferd-create \
  --customer-id 10001 \
  --invoice "RE-2026-042" \
  --date 2026-05-21 \
  --items '[
    {"description": "Consulting May 2026", "quantity": 8, "unit_price": 150.00, "vat_rate": 19},
    {"description": "Travel expenses", "quantity": 1, "unit_price": 42.50, "vat_rate": 19}
  ]' \
  --output rechnung-RE-2026-042.pdf

# With optional metadata
collmex customer-zugferd-create \
  --customer-id 10001 \
  --invoice "RE-2026-042" \
  --date 2026-05-21 \
  --items '[{"description": "Consulting", "quantity": 8, "unit_price": 150.00, "vat_rate": 19}]' \
  --output rechnung.pdf \
  --delivery-date 2026-05-31 \
  --due 2026-06-14 \
  --payment-terms "Zahlbar innerhalb von 14 Tagen" \
  --project-ref "Projekt XYZ" \
  --notes "Gemäß Rahmenvertrag vom 01.01.2026"

The output file is a PDF/A-3 with the ZUGFeRD XML (factur-x.xml) attached as AFRelationship=Alternative. It passes EN16931 schematron validation automatically; missing seller or buyer master-data fields produce a clear error listing the affected fields before any file is written.

Seller master data must be present in CollmexConfig (env vars starting with COLLMEX_SELLER_). See the Seller master data section under Configuration above.

Vendor Invoices (Lieferantenrechnungen)

# Create a vendor invoice
collmex vendor-invoice \
  --vendor-id 123 \
  --invoice "INV-2024-001" \
  --date 2024-01-15 \
  --net 100.00 \
  --text "Office supplies"

Invoice PDF Rendering

Generate a cognovis-layout PDF from structured invoice data:

from collmex_cli.invoice_renderer import render_invoice, InvoiceData, InvoiceLineItem

data = InvoiceData(
    company_name="Acme GmbH",
    company_contact_name="Jane Doe",
    address_line1="Hauptstraße 5",
    postal_code="10115",
    city="Berlin",
    country="DE",
    vat_number="DE987654321",
    invoice_nr="2026-0042",
    invoice_date="21.05.2026",
    delivery_date="21.05.2026",
    project_ref="Projekt XYZ",
    line_items=[
        InvoiceLineItem(name="Beratung", quantity="8 h", unit_price="150,00 €", amount="1.200,00 €"),
    ],
    subtotal="1.200,00 €",
    vat_rate="19%",
    vat_amount="228,00 €",
    total="1.428,00 €",
)

pdf_bytes = render_invoice(data)
with open("rechnung.pdf", "wb") as f:
    f.write(pdf_bytes)

Seller master data is read from CollmexConfig. Missing mandatory fields raise a ValueError listing the affected field names.

LLM Integration

All commands support --json output for easy parsing by LLMs:

collmex vendors --json | jq '.[] | select(.city == "Berlin")'

Workflow: Matching Bank Transactions

  1. Import bank statement (MT940) via Collmex Web UI
  2. Find unmatched transactions:
    collmex unmatched --json
    
  3. For each unmatched transaction, create vendor invoice:
    collmex vendor-invoice --vendor-id 123 --invoice "INV-001" --date 2024-01-15 --net 50.00
    

API Coverage

Currently supported Collmex record types:

  • VENDOR_GET / CMXLIF - Query and create vendors
  • CMXLRN - Create vendor invoices
  • CMXUMS - Create customer invoices (outgoing invoices in accounting)
  • OPEN_ITEMS_GET / OPEN_ITEM - Query open items
  • ACCDOC_GET / ACCDOC - Query accounting documents/bookings

Development

# Install with dev dependencies
uv sync --dev

# Run tests
uv run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collmex_cli-2026.5.5.tar.gz (102.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

collmex_cli-2026.5.5-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file collmex_cli-2026.5.5.tar.gz.

File metadata

  • Download URL: collmex_cli-2026.5.5.tar.gz
  • Upload date:
  • Size: 102.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for collmex_cli-2026.5.5.tar.gz
Algorithm Hash digest
SHA256 96e0bbcba89d8a24fc0e0905860974a3c4e7207f7df7442da16889cdf5f0e646
MD5 959222d8f12e3ff9334088da17379473
BLAKE2b-256 76b702a3f763786516c814b3f7cb52cfcf33e72b45359a9a0e1162d031ca6e1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for collmex_cli-2026.5.5.tar.gz:

Publisher: release.yml on cognovis/collmex-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file collmex_cli-2026.5.5-py3-none-any.whl.

File metadata

  • Download URL: collmex_cli-2026.5.5-py3-none-any.whl
  • Upload date:
  • Size: 64.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for collmex_cli-2026.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 33a3d4957661a7636e410eaff6172fdb26c39fc5e1ea362be5d880644a20e035
MD5 6246eb5b209984a415a366a7df7cb13d
BLAKE2b-256 40f59818a6d28f26120bea3ece57223919aff8d0f4431a7488f193667b65f945

See more details on using hashes here.

Provenance

The following attestation bundles were made for collmex_cli-2026.5.5-py3-none-any.whl:

Publisher: release.yml on cognovis/collmex-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page