Octibiz
Demo

Durchsucht Website und Dokumentation gemeinsam. Enter zeigt alle Treffer, Esc schließt.

Abrechnung — API und MCP

Überblick

Dieser Bereich stellt 35 Operationen bereit. Jede davon ist zugleich ein MCP-Werkzeug.

Der Bereich hängt am Modul-Schalter module.finance. Ist das Modul aus, antworten diese Operationen mit 404.

Operationen

MethodePfadZweckRechtParameter
GET/api/v1/billing-handoff-targetsListe der BillingHandoffTargetfinance.billing.viewpage, customerId, target
POST/api/v1/billing-handoff-targetsÜbergabeziel je Kunde setzen — Legt fest, wohin die Abrechnungs-Vorschauen dieses Kunden übergeben werden (Faktura in-house oder lexoffice). Ohne Eintrag gilt die Instanz-Vorgabe.finance.recurring.manage+ Rumpf
DELETE/api/v1/billing-handoff-targets/{ulid}Übergabeziel je Kunde zurücknehmen — Entfernt die kundenbezogene Ausnahme; danach gilt wieder die Instanz-Vorgabe.finance.recurring.manageulid
GET/api/v1/billing-handoffsListe der BillingHandofffinance.billing.viewpage, status, target, customerId, brandId, previewUlid, order[status], order[handedOverAt], order[createdAt]
GET/api/v1/billing-handoffs/{ulid}Eine BillingHandoff lesenfinance.billing.viewulid
POST/api/v1/billing-handoffs/{ulid}/retryÜbergabe wiederholen — Wiederholt eine gescheiterte oder aufgegebene Übergabe (error, gave_up); mit target an ein anderes Ziel. Eine bereits erfolgreiche Übergabe wird nicht erneut versucht (409) — das wäre ein zweiter Beleg. Unabhängig davon wiederholt das System gescheiterte Übergaben selbst mit wachsendem Abstand und gibt nach sechs Versuchen auf.finance.lexoffice.sync · finance.recurring.manageulid, + Rumpf
GET/api/v1/billing-previewsListe der BillingPreviewfinance.billing.viewpage, status, customerId, brandId, q, order[status], order[totalAmount], order[handedOverAt], order[createdAt]
POST/api/v1/billing-previewsEine BillingPreview anlegenfinance.recurring.manage+ Rumpf
POST/api/v1/billing-previews/lexoffice-sync-runEine LexofficeSyncRun anlegenfinance.lexoffice.sync+ Rumpf
GET/api/v1/billing-previews/{ulid}Eine BillingPreview lesenfinance.billing.viewulid
POST/api/v1/billing-previews/{ulid}/add-itemPosition zur Vorschau hinzufügen — Payload `{description, qty, unitPriceAmount, unit?, taxRate?\taxRateId?} (Preis in Cent, negativ = Nachlass; Steuersatz als Wert oder Katalog-Id, sonst Regelsatz; die Steuer-Behandlung des Kunden gilt). Fügt einer Vorschau im Entwurf eine freie Position hinzu (Herkunft manual`, 409 sonst) und rechnet die Summen neu.finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/create-invoiceAus der Abrechnungs-Vorschau eine Rechnung erzeugen — Erzeugt aus einer freigegebenen Vorschau einen Rechnungs-ENTWURF (Alternative zur lexoffice-Übergabe). Eine zweite Übergabe derselben Vorschau scheitert (409).finance.lexoffice.sync · finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/handoffVorschau an lexoffice übergeben — Übergibt die freigegebene Vorschau an lexoffice und setzt die enthaltenen Zeiten auf invoiced. Nur aus dem Zustand ready (sonst 409); idempotent über die lexoffice-Verknüpfung — ein zweiter Aufruf schiebt nichts nach.finance.lexoffice.sync · finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/readyAbrechnungs-Vorschau freigeben — Markiert die Vorschau als geprüft und gibt sie zur Übergabe frei (Zustand ready) — erst dann nimmt der Übergabeweg sie an.finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/remove-itemsQuellen aus der Vorschau abwählen — Payload {itemUlids: [...]}. Entfernt die genannten Zeilen aus einer Vorschau im Entwurf (409 sonst) und rechnet die Summen neu — die zugrunde liegenden Zeiten/Posten bleiben offen und erscheinen in der nächsten Vorschau. Der Abrechnen-Assistent aus dem Projekt nutzt das, um nur dessen Leistungen abzurechnen.finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/reopenGeprüfte Vorschau wieder öffnen — Öffnet eine geprüfte Vorschau wieder zur Bearbeitung. Nach der Übergabe ist das nicht mehr möglich.finance.recurring.manageulid, + Rumpf
POST/api/v1/billing-previews/{ulid}/update-itemPosition der Vorschau anpassen — Payload {itemUlid, description?, qty?, unitPriceAmount?} (Preis in Cent, Menge als Dezimaltext). Ändert Text, Menge und/oder Einzelpreis einer Zeile einer Vorschau im Entwurf (409 sonst) und rechnet Zeile und Summen neu. Angepasste Zeilen bleiben beim Neuaufbau der Vorschau erhalten. Abschlags- und Schlusszeilen gehören dem Abschlagsplan (409).finance.recurring.manageulid, + Rumpf
GET/api/v1/deposit-schedulesListe der DepositSchedulefinance.billing.viewpage, status, customerId, brandId, sourceType, sourceRef, order[status], order[baseAmount], order[createdAt]
POST/api/v1/deposit-schedulesAbschlagsplan anlegen — Legt einen Anzahlungs-/Abschlagsplan mit seinen Fälligkeiten an. Je Fälligkeit ist entweder percent oder amountAmount gesetzt; die Summe darf die Netto-Basis nicht übersteigen.finance.recurring.manage+ Rumpf
GET/api/v1/deposit-schedules/{ulid}Eine DepositSchedule lesenfinance.billing.viewulid
POST/api/v1/deposit-schedules/{ulid}/activateAbschlagsplan aktivieren — Schaltet den Plan für den Fälligkeits-Lauf frei — ab dann entsteht zu jedem erreichten Termin eine Abschlagsvorgabe.finance.recurring.manageulid, + Rumpf
POST/api/v1/deposit-schedules/{ulid}/cancelAbschlagsplan abbrechen — Bricht den Plan und alle offenen Fälligkeiten ab. Bereits abgerechnete Abschläge bleiben bestehen.finance.recurring.manageulid, + Rumpf
POST/api/v1/deposit-schedules/{ulid}/settleSchlussrechnung vorbereiten — Erzeugt die Schlussrechnungs-Vorgabe: volle Netto-Basis, danach je bereits abgerechnetem Abschlag eine negative Position (§14 UStG). Offene Fälligkeiten werden abgebrochen.finance.recurring.manageulid, + Rumpf
GET/api/v1/recurring-billing-plansListe der RecurringBillingPlanfinance.recurring.managepage, status, customerId, licenseId, runMode, q, order[amountAmount], order[status], order[nextRunAt]
POST/api/v1/recurring-billing-plansEine RecurringBillingPlan anlegenfinance.recurring.manage+ Rumpf
POST/api/v1/recurring-billing-plans/runEine RecurringBillingRun anlegenfinance.recurring.manage+ Rumpf
GET/api/v1/recurring-billing-plans/{ulid}Eine RecurringBillingPlan lesenfinance.recurring.manageulid
PATCH/api/v1/recurring-billing-plans/{ulid}Eine RecurringBillingPlan ändernfinance.recurring.manageulid, + Rumpf
POST/api/v1/recurring-billing-plans/{ulid}/endEnd recurring billing plan — End recurring billing plan. Dedicated action endpoint — not a standard CRUD create.finance.recurring.manageulid, + Rumpf
POST/api/v1/recurring-billing-plans/{ulid}/pausePause recurring billing plan — Pause recurring billing plan. Dedicated action endpoint — not a standard CRUD create.finance.recurring.manageulid, + Rumpf
POST/api/v1/recurring-billing-plans/{ulid}/resumeResume recurring billing plan — Resume recurring billing plan. Dedicated action endpoint — not a standard CRUD create.finance.recurring.manageulid, + Rumpf
GET/api/v1/recurring-plan-summaryListe der RecurringPlanSummaryfinance.recurring.manage—
GET/api/v1/usage-recordsListe der UsageRecordfinance.billing.viewpage, customerId, brandId, metric, billed, subjectType, subjectRef, from, to, order[occurredAt], order[metric]
POST/api/v1/usage-recordsVerbrauch einliefern — Bucht eine Verbrauchszeile (Seats/Transaktionen/Verbrauch). Mit externalRef idempotent: dieselbe Fremd-Kennung liefert die bestehende Zeile zurück, statt doppelt abzurechnen.finance.recurring.manage+ Rumpf
GET/api/v1/usage-records/{ulid}Eine UsageRecord lesenfinance.billing.viewulid

Zweckangaben, die nicht dem Standardmuster folgen, stammen unverändert aus der Schnittstellen-Beschreibung im Code.

referenz.api-finance · Gilt ab Version 0.5.4