Umsatzrealisierungs-APIBeta
Greifen Sie programmgesteuert auf die Umsatzrealisierungsberichte von Stripe zu, um Ihre Periodenrechnung zu automatisieren.
Für die Periodenrechnung bietet Stripe Revenue Recognition herunterladbare Berichte wie eine Monatsübersicht und ein Wasserfalldiagramm zum Umsatz. Sie können diese Berichte im CSV-Format über das Dashboard herunterladen oder programmgesteuert über die API abrufen.
Revenue Recognition verfügt über sechs unterstützte Berichtstypen:
revenue_recognition. debit_ credit_ summary. 1 revenue_recognition. debit_ credit_ by_ price. 1 revenue_recognition. debit_ credit_ by_ product. 1 revenue_recognition. debit_ credit_ by_ customer. 1 revenue_recognition. debit_ credit_ by_ invoice. 1 revenue_recognition. debit_ credit_ by_ invoice_ line_ item. 1
Vorsicht
Da sich diese Funktion in der Betaphase befindet, können sich die Datenfelder ändern.
Bericht herunterladen
Im folgenden Beispiel werden die Belastungen und Gutschriften als Zusammenfassung für Mai 2021 heruntergeladen.
Erstellen Sie zuerst eine Berichtsausführung mithilfe der Angaben unter Einen Berichtsverlauf erstellen.
Um einen Bericht für Mai 2023 zu erhalten, legen Sie parameters[interval_ auf 1. Mai 2023 und parameters[interval_ auf 1. Juni 2023 fest.
Prüfen Sie als Nächstes, ob das Report Run-Objekt erfolgreich ist, indem Sie das Berichtsausführungs-Objekt abrufen:
Die Objekt-ID für die Berichtsausführung beginnt mit frr_.
Wenn der status des Objekts succeeded ist, können Sie die CSV-Datei mit ihren result.-Wert herunterladen, wie im folgenden Beispiel:
Die Ergebnis-ID der Berichtsausführung beginnt mit file_.
Parameter für die Berichtsausführung
| Berichtstyp | Erforderliche Ausführungsparameter | Optionale Ausführungsparameter |
|---|---|---|
| revenue_recognition.debit_credit_summary.1 |
|
|
| revenue_recognition.debit_credit_by_price.1 |
|
|
| revenue_recognition.debit_credit_by_product.1 |
|
|
| revenue_recognition.debit_credit_by_customer.1 |
|
|
| revenue_recognition.debit_credit_by_invoice.1 |
|
|
| revenue_recognition.debit_credit_by_invoice_line_item.1 |
|
|
Spalten für die Report Run
Standardmäßig werden Berichte mit den Standardspalten ausgeführt. Sie können die Auswahl und Reihenfolge der Spalten in der Ausgabe anpassen, indem Sie den optionalen Parameter Spalten mit einer Liste von Spaltennamen hinzufügen. Unten finden Sie die unterstützten Spalten für jeden Berichtstyp.
Übersicht
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| debit_gl_code | Der belastete Hauptbuchcode |
Nach Preis
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| price_id | Der mit dieser Änderung verknüpfte Preis. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| debit_gl_code | Der belastete Hauptbuchcode |
Nach Produkt
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| product_id | Das mit dieser Änderung verknüpfte Produkt. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| debit_gl_code | Der belastete Hauptbuchcode |
Nach Kund/in
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| customer_id | Der/die mit dieser Änderung verknüpfte/r Kund/in. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| debit_gl_code | Der belastete Hauptbuchcode |
NachRechnung
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| transaction_model_id | Das mit dieser Änderung verknüpfte Modell in Stripe – entweder ein Rechnungseinzelposten, eine Rechnung, ein Rechnungsposten, eine Zahlung usw. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| booked_date | Das Datum, an dem der Hauptbucheintrag zu den Büchern hinzugefügt wird. | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| debit_gl_code | Der belastete Hauptbuchcode | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| invoice_id | Die mit dieser Änderung verknüpfte Rechnung. Eigenständige Zahlungen oder Rechnungsposten, die keiner Rechnung zugeordnet sind, sind null. | |
| invoice_line_item_id | Die ID des Rechnung-line_item. | |
| invoice_item_id | Die ID des Rechnungspostens | |
| invoice_number | The customer unique number associated with the invoice. | |
| subscription_item_id | Die ID des subscription_item. | |
| price_id | Der mit dieser Änderung verknüpfte Preis. Eigenständige Zahlungen oder Rechnungsposten, die keinem Preis zugeordnet sind, sind null. | |
| product_id | Das mit diesem Preis verknüpfte Produkt. | |
| customer_id | Der/die mit dieser Änderung verknüpfte/r Kund/in. | |
| subscription_id | Das mit dieser Änderung verknüpfte Abonnement. | |
| charge_id | Der mit dieser Änderung verknüpfte Zahlung. | |
| refund_id | Die mit dieser Änderung verknüpfte Rückerstattung. | |
| dispute_id | Die mit dieser Änderung verknüpfte Anfechtung. | |
| presentment_currency | Die (kundenseitige) Darstellungswährung der Transaktion. | |
| presentment_amount | Der (kundenseitige) Darstellungsbetrag. |
Nach Rechnungsposten
API-Berichtstyp: revenue_
| Spaltenname | Standard | Beschreibung |
|---|---|---|
| accounting_period | Der Abrechnungszeitraum | |
| open_accounting_period | Der offene Abrechnungszeitraum; Einträge in offenen Zeiträumen können sich ändern | |
| Währung | Dreistelliger ISO-Code für die Währung des Betrags. | |
| transaction_model_id | Das mit dieser Änderung verknüpfte Modell in Stripe – ein Rechnungseinzelposten, eine Rechnung, ein Rechnungsposten, eine Abbuchung usw. | |
| Debit | Das belastete Konto | |
| Gutschrift | Das gutgeschriebene Konto | |
| booked_date | Das Datum, an dem der Hauptbucheintrag zu den Büchern hinzugefügt wird. | |
| Betrag | Änderungsbetrag, ausgedrückt in den wichtigsten Währungseinheiten (zum Beispiel Dollar für USD oder Pesos für MXN). | |
| debit_gl_code | Der belastete Hauptbuchcode | |
| credit_gl_code | Der gutgeschriebene Hauptbuchcode | |
| invoice_id | Die mit dieser Änderung verknüpfte Rechnung. Eigenständige Zahlungen oder Rechnungsposten, die keiner Rechnung zugeordnet sind, sind null. | |
| invoice_line_item_id | Die ID des Rechnung-line_item. | |
| invoice_item_id | Die ID des Rechnungspostens | |
| subscription_item_id | Die ID des subscription_item. | |
| price_id | Der mit dieser Änderung verknüpfte Preis. Eigenständige Zahlungen oder Rechnungsposten, die keinem Preis zugeordnet sind, sind null. | |
| product_id | Das mit diesem Preis verknüpfte Produkt. | |
| customer_id | Der/die mit dieser Änderung verknüpfte/r Kund/in. | |
| subscription_id | Das mit dieser Änderung verknüpfte Abonnement. | |
| charge_id | Der mit dieser Änderung verknüpfte Zahlung. | |
| refund_id | Die mit dieser Änderung verknüpfte Rückerstattung. | |
| dispute_id | Die mit dieser Änderung verknüpfte Anfechtung. | |
| presentment_currency | Die (kundenseitige) Darstellungswährung der Transaktion. | |
| presentment_amount | Der (kundenseitige) Darstellungsbetrag. |
Bei Problemen wenden Sie sich bitte an revenue-recognition-api-beta@stripe.com.