Octibiz
Demo

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

Verbrauch

Überblick

Nutzungsbasierte Abrechnung berechnet, was tatsächlich verbraucht wurde: API-Aufrufe, Stunden, Gigabyte, Arbeitsplätze. Jede Meldung ist eine Verbrauchszeile mit Kunde, Größe, Menge und Zeitpunkt. Offene Zeilen fließen beim nächsten Lauf je Größe zusammengefasst in die Abrechnungs-Vorschau des Kunden; danach stehen sie auf Abgerechnet.

Normalerweise kommen die Zeilen über die Schnittstelle herein — aus dem System, das den Verbrauch misst. Von Hand erfasst wird, was nachgetragen werden muss. Die Seite steht im Menü als Unterpunkt von Abrechnung.

Kernaufgaben

Verbrauch prüfen. Die Liste zeigt Zeitpunkt, Kunde, Größe mit Beschreibung, Menge mit Einheit, Einzelpreis und Status Offen oder Abgerechnet. Filtern lässt sich nach Kunde, Größe, Abgerechnet und Bezug. Steht statt eines Preises Preis aus dem Plan, gilt der Preis des Abrechnungsplans.

Verbrauch erfassen. Verbrauch erfassen legt eine Zeile von Hand an. Pflicht sind Kunde, Größe und Menge.

Korrigieren. Eine Verbrauchszeile lässt sich nach dem Erfassen weder ändern noch löschen — auch nicht über die Schnittstelle. Eine zu viel erfasste Menge gleichen Sie mit einer negativen Zeile derselben Größe aus.

Zur Abrechnung. Zu den Abrechnungen führt zur Liste der Vorschauen.

Felder im Detail

Verbrauch erfassen

FeldPflichtWerte / FormatWas es bewirkt
Kunde customerIdjabestehender KundeWem der Verbrauch berechnet wird.
Größe metricjaText, max. 60 Zeichen, z. B. api_callsDer abgerechnete Wert. Zeilen derselben Größe werden in der Vorschau zusammengefasst — schreiben Sie sie deshalb immer gleich.
Einheit unitneinText, max. 50 ZeichenStunden, Stück, GB … Steht in der Liste neben der Menge.
Menge quantityjaZahl mit bis zu vier Nachkommastellen, nicht 0Wie viel verbraucht wurde. Ein negativer Wert korrigiert eine zu viel erfasste Menge.
Einzelpreis (netto) unitPriceAmountneinBetragPreis je Einheit. Leer = es gilt der Preis des Abrechnungsplans.
Zeitpunkt occurredAtneinDatum und Uhrzeit; leer = jetztEntscheidet, in welche Abrechnungsperiode die Zeile fällt.
Bezug subjectTypeneinLizenz, Vertrag, Auftrag oder ohneWorauf sich der Verbrauch bezieht.
Bezugs-Kennung subjectRefneinText, max. 100 ZeichenWelche Lizenz, welcher Vertrag oder Auftrag gemeint ist.
Fremd-Referenz externalRefneinText, max. 100 ZeichenKennung im meldenden System. Dieselbe Referenz legt keine zweite Zeile an; die Schnittstelle liefert dann die bestehende zurück. So darf ein System eine Meldung gefahrlos wiederholen.
Beschreibung descriptionneinText, max. 255 ZeichenSteht in der Liste unter der Größe.

Nur über Schnittstelle und Automation

FeldWerte / FormatWas es bewirkt
brandIdMarke; leer = ohne MarkeMarke der Zeile. Setzen darf sie nur, wer in dieser Marke Abrechnungen verwalten darf.

Einstellungen & Rechte

  • Modul module.finance.
  • Sehen: finance.billing.view. Erfassen: finance.recurring.manage — ohne es fehlt der

Knopf Verbrauch erfassen.

  • Schnittstelle: POST /api/v1/usage-records (mit externalRef wiederholbar),

GET /api/v1/usage-records mit den Filtern customerId, brandId, metric, billed, subjectType, subjectRef, from und to.

FAQ & Fehlerbilder

**Eine Zeile steht noch auf Offen.** Sie wird erst beim nächsten Abrechnungslauf ihres Kunden verrechnet; maßgeblich ist ihr Zeitpunkt.

Eine Meldung kam zweimal, steht aber nur einmal da. So gewollt, wenn beide dieselbe Fremd-Referenz tragen.

Die Menge ist falsch. Nicht ändern — mit einer negativen Zeile ausgleichen.

„customerId, metric und quantity sind erforderlich." Beim Einliefern über die Schnittstelle fehlt eines der drei Pflichtfelder.

billing.usage · Gilt ab Version 0.6.23