Faktura — API und MCP
Überblick
Dieser Bereich stellt 36 Operationen bereit. Jede davon ist zugleich ein MCP-Werkzeug.
Der Bereich hängt am Modul-Schalter module.invoicing. Ist das Modul aus, antworten diese Operationen mit 404.
Operationen
| Methode | Pfad | Zweck | Recht | Parameter |
|---|---|---|---|---|
GET | /api/v1/dunning-levels | Liste der DunningLevel | invoicing.dunning.manage · invoicing.config.manage | page, brandId |
POST | /api/v1/dunning-levels | Eine DunningLevel anlegen | invoicing.config.manage | + Rumpf |
DELETE | /api/v1/dunning-levels/{ulid} | Eine DunningLevel löschen | invoicing.config.manage | ulid |
GET | /api/v1/dunning-levels/{ulid} | Eine DunningLevel lesen | invoicing.dunning.manage · invoicing.config.manage | ulid |
PATCH | /api/v1/dunning-levels/{ulid} | Eine DunningLevel ändern | invoicing.config.manage | ulid, + Rumpf |
GET | /api/v1/invoice-correction-summary | Liste der InvoiceCorrectionSummary | invoicing.invoice.view | — |
GET | /api/v1/invoice-payments | Liste der InvoicePayment | invoicing.payment.record · invoicing.invoice.view | page, customerId, source, invoiceUlid |
POST | /api/v1/invoice-payments | Eine InvoicePayment anlegen | invoicing.payment.record | + Rumpf |
GET | /api/v1/invoices | Liste der Invoice | invoicing.invoice.view | page, status, type, creditKind, recurringInvoiceId, customerId, brandId, q, order[number], order[status], order[issueDate], order[dueDate], order[totalAmount], order[createdAt] |
POST | /api/v1/invoices | Eine Invoice anlegen | invoicing.invoice.create | + Rumpf |
POST | /api/v1/invoices/dunning-run | Eine InvoiceDunning anlegen | invoicing.dunning.manage | + Rumpf |
POST | /api/v1/invoices/from-order | Create invoice from an order — Create invoice from an order. Dedicated action endpoint — not a standard CRUD create. | invoicing.invoice.create | + Rumpf |
DELETE | /api/v1/invoices/{ulid} | Eine Invoice löschen | invoicing.invoice.create | ulid |
GET | /api/v1/invoices/{ulid} | Eine Invoice lesen | invoicing.invoice.view | ulid |
PATCH | /api/v1/invoices/{ulid} | Eine Invoice ändern | invoicing.invoice.create | ulid, + Rumpf |
POST | /api/v1/invoices/{ulid}/cancel | Cancel invoice — Cancel invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.invoice.cancel | ulid, + Rumpf |
POST | /api/v1/invoices/{ulid}/correct | Correct invoice — Correct invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.invoice.cancel | ulid, + Rumpf |
GET | /api/v1/invoices/{ulid}/dunnings | Liste der InvoiceDunning | invoicing.invoice.view · invoicing.dunning.manage | ulid |
POST | /api/v1/invoices/{ulid}/dunnings/{dunningUlid}/mark-sent | Mahnung als postalisch versendet vermerken — Vermerkt die Mahnung als auf dem Postweg versendet (setzt sentAt). Es wird keine Mail verschickt. | invoicing.dunning.manage | ulid, dunningUlid, + Rumpf |
GET | /api/v1/invoices/{ulid}/dunnings/{dunningUlid}/pdf | Eine InvoiceDunning lesen | invoicing.invoice.view · invoicing.dunning.manage | ulid, dunningUlid |
POST | /api/v1/invoices/{ulid}/dunnings/{dunningUlid}/resolve | Mahnvorgang abschließen — Schließt den Mahnvorgang als erledigt ab; die Mahnstufe läuft nicht weiter. | invoicing.dunning.manage | ulid, dunningUlid, + Rumpf |
POST | /api/v1/invoices/{ulid}/dunnings/{dunningUlid}/send | Send dunning — Send dunning. Dedicated action endpoint — not a standard CRUD create. | invoicing.dunning.manage | ulid, dunningUlid, + Rumpf |
GET | /api/v1/invoices/{ulid}/e-invoice | Eine Invoice lesen | invoicing.invoice.view | ulid |
POST | /api/v1/invoices/{ulid}/e-invoice | E-Rechnung erzeugen — Erzeugt idempotent die E-Rechnung zur FESTGESCHRIEBENEN Rechnung. Format aus eInvoiceFormat, sonst vom Beleg, dann vom Kunden, sonst XRechnung. | invoicing.invoice.einvoice | ulid, + Rumpf |
POST | /api/v1/invoices/{ulid}/issue | Issue invoice — Issue invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.invoice.issue | ulid, + Rumpf |
GET | /api/v1/invoices/{ulid}/pdf | Eine Invoice lesen | invoicing.invoice.view | ulid |
POST | /api/v1/invoices/{ulid}/send | Send invoice — Send invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.invoice.send | ulid, + Rumpf |
GET | /api/v1/recurring-invoices | Liste der RecurringInvoice | invoicing.recurring.view | page, status, cycle, customerId, brandId, q, order[title], order[status], order[nextRunAt], order[totalAmount], order[createdAt] |
POST | /api/v1/recurring-invoices | Eine RecurringInvoice anlegen | invoicing.recurring.manage | + Rumpf |
DELETE | /api/v1/recurring-invoices/{ulid} | Eine RecurringInvoice löschen | invoicing.recurring.manage | ulid |
GET | /api/v1/recurring-invoices/{ulid} | Eine RecurringInvoice lesen | invoicing.recurring.view | ulid |
PATCH | /api/v1/recurring-invoices/{ulid} | Eine RecurringInvoice ändern | invoicing.recurring.manage | ulid, + Rumpf |
POST | /api/v1/recurring-invoices/{ulid}/end | End recurring invoice — End recurring invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.recurring.manage | ulid, + Rumpf |
POST | /api/v1/recurring-invoices/{ulid}/pause | Pause recurring invoice — Pause recurring invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.recurring.manage | ulid, + Rumpf |
POST | /api/v1/recurring-invoices/{ulid}/resume | Resume recurring invoice — Resume recurring invoice. Dedicated action endpoint — not a standard CRUD create. | invoicing.recurring.manage | ulid, + Rumpf |
POST | /api/v1/recurring-invoices/{ulid}/run-now | Fällige Rechnung sofort erzeugen — Erzeugt sofort die fällige Rechnung aus der Serienrechnung (respektiert runMode), idempotent je Leistungszeitraum. Die Antwort trägt generatedInvoiceUlid. | invoicing.recurring.manage | ulid, + Rumpf |
Zweckangaben, die nicht dem Standardmuster folgen, stammen unverändert aus der Schnittstellen-Beschreibung im Code.