RechnungsübersichtspostenPrivate Vorschau

Erfahren Sie, wie Sie Rechnungsposten mithilfe von Invoicing APIs zusammenfassen und ausblenden können.

In diesem Leitfaden wird die Verwendung der zugrunde liegenden API (Rechnungsübersichtsposten) beschrieben, die das Gruppieren von Rechnungsposten ermöglicht. Mit der Funktion für Übersichtsposten können Sie Rechnungsposten über die API gruppieren.

Wenn Sie Rechnungsposten dynamisch kategorisieren und anzeigen möchten, erhalten Sie weitere Informationen unter Rechnungsposten gruppieren.

Übersichtsposten erstellen

Erstellen Sie für einen bestehenden Rechnungsentwurf einen Rechnungsübersichtsposten wie unten beschrieben. Der Übersichtsposten stellt eine Gruppe dar, der Sie Einzelposten zuweisen können, und das Feld description des Übersichtspostens dient als Gruppen-Header für diese Einzelposten.

Standardmäßig rendert Stripe alle dem Übersichtsposten zugewiesenen Einzelposten. Sie können auch alle dem Übersichtsposten zugewiesenen Einzelposten ausblenden und nur den Gruppen-Header anzeigen, indem Sie display_items=none als Parameter für den Übersichtsposten festlegen. Wenn Sie display_items=none festlegen, werden alle dem Übersichtsposten zugewiesenen Einzelposten ausgeblendet. Es ist nicht möglich, einige Posten selektiv auszublenden, andere jedoch nicht, mit Ausnahme von Posten mit einem Wert von 0 USD (siehe Abschnitt Einzelne Posten im Wert von 0 USD ausblenden).

Command Line
curl https://api.stripe.com/v1/invoices/{{INVOICE_ID}}
/summary_items \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d description="Summary item 1" \
  -d display_items="none"

Statt die Übersichtsposten einzeln zu erstellen, können Sie auch eine Massenerstellung mit den Rechnungs-Endpoints Erstellen oder Aktualisieren durchführen. Der folgende Beispielcode erstellt einen Rechnungsentwurf mit zwei leeren Übersichtsposten

Command Line
curl https://api.stripe.com/v1/invoices \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "rendering[summary_items_data][0][description]"="Summary item 1" \
  -d "rendering[summary_items_data][0][display_items]"="none" \
  -d "rendering[summary_items_data][1][description]"="Summary item 2" \
  -d "expand[]"="rendering.summary_items"

Denken Sie daran, rendering.summary_items zu erweitern, damit Sie die Liste der Übersichtsposten in der Antwort sehen können.

Übersichtsposten zuweisen

Da die Rechnung nun leere Übersichtsposten enthält (vorausgesetzt, die Rechnung enthält bereits Einzelposten), können wir dem Einzelposten einen Übersichtsposten zuweisen.

Command Line
curl https://api.stripe.com/v1/invoices/{{INVOICE_ID}}
/lines/{{INVOICE_LINE_ITEM_ID}} \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "rendering[summary_item]"={{SUMMARY_ITEM_ID}}

Sie können mithilfe desselben Endpoints den Übersichtsposten aktualisieren, zu dem der Einzelposten gehört, oder die Gruppierung des Einzelpostens aufheben.

Übersichtsposten aktualisieren

Mit dem Rechnungs-Endpoint Aktualisieren können Sie die Übersichtsposten neu ordnen, löschen oder aktualisieren. Im folgenden Code ist beispielsweise die Reihenfolge für den ersten und zweiten Übersichtsposten umgekehrt.

Command Line
curl https://api.stripe.com/v1/invoices \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "rendering[summary_items_data][0][id]"="{{SUMMARY_ITEM_2_ID}}" \
  -d "rendering[summary_items_data][1][id]"="{{SUMMARY_ITEM_1_ID}}" \
  -d "expand[]"="rendering.summary_items"

Um alle bestehenden Übersichtsposten aus einer Rechnung zu löschen, verwenden Sie denselben Endpoint, um das Feld rendering[summary_items_data] wie folgt zu deaktivieren:

Command Line
curl https://api.stripe.com/v1/invoices \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "rendering[summary_items_data]"="" \
  -d "expand[]"="rendering.summary_items"

Wenn Sie die Übersichtsposten löschen, werden alle zugehörigen Einzelposten nicht mehr gruppiert.

Alternativ können Sie einen einzelnen Übersichtsposten wie folgt löschen:

Command Line
curl https://api.stripe.com/v1/invoices/{{INVOICE_ID}}
/summary_items/{{SUMARY_ITEM_ID}} \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -x DELETE

Einzelne Posten mit 0 USD ausblenden

Die API unterstützt auch das Ausblenden einzelner Posten mit 0 USD. Für einen bestimmte Posten auf der Rechnung können Sie rendering[display]=hidden_if_zero wie folgt festlegen:

Command Line
curl https://api.stripe.com/v1/invoices/{{INVOICE_ID}}
/lines/{{INVOICE_LINE_ITEM_ID}} \
  -usk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "rendering[display]"= "hidden_if_zero"

Wenn der Posten dann 0 USD beträgt, wird er automatisch überall dort ausgeblendet, wo der Kunde/die Kundin die Rechnung sieht.