API Revenue RecognitionVersion bêta publique
Accédez aux rapports de comptabilisation des revenus de Stripe de manière programmatique pour automatiser votre comptabilité d'exercice.
Si vous utilisez une comptabilité d’exercice, Stripe Revenue Recognition fournit des rapports téléchargeables, notamment un récapitulatif mensuel et un rapport de revenus en cascade. Vous pouvez télécharger ces rapports au format CSV via le Dashboard ou y accéder de manière programmatique via l’API.
Revenue Recognition prend en charge six types de rapports :
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
Mise en garde
Cette fonctionnalité étant en version bêta, les champs de données sont susceptibles de changer.
Télécharger un rapport
Dans l’exemple suivant, nous téléchargeons les débits et les crédits par résumé pour le mois de mai 2021.
Tout d’abord, créez un objet Report Run (exécution de rapport).
Afin d’obtenir un rapport pour le mois de mai 2023, définissez parameters[interval_ sur la date du 1er mai 2023 et parameters[interval_ sur la date du 1er juin 2023.
Ensuite, récupérez l’objet Report Run pour vérifier s’il a réussi :
L’ID de l’objet d’exécution de rapport commence par frr_.
Lorsque l’attribut status (état) de l’objet est succeeded (réussi), vous pouvez le télécharger au format CSV à l’aide de sa valeur result., comme illustré ci-dessous :
L’ID du résultat de l’exécution de rapport commence par file_.
Paramètres d’exécution des rapports
| Type de rapport | Paramètres d’exécution obligatoires | Paramètres d’exécution facultatifs |
|---|---|---|
| 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 |
|
|
Colonnes d’exécution des rapports
Par défaut, les rapports sont exécutés avec la sélection de colonnes par défaut. Vous pouvez personnaliser la sélection et l’ordre des colonnes générées en incluant le paramètre de colonnes facultatives avec une liste de noms de colonnes. Vous trouverez ci-dessous les colonnes prises en charge pour chaque type de rapport.
Récapitulatif
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| debit_gl_code | Le code de compte du grand livre débité |
Par tarif
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| price_id | Le tarif associé à cette modification. | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| debit_gl_code | Le code de compte du grand livre débité |
Par produit
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| product_id | Le produit associé à cette modification. | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| debit_gl_code | Le code de compte du grand livre débité |
Par client
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| customer_id | Le client associé à cette modification. | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| debit_gl_code | Le code de compte du grand livre débité |
Par facture
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| transaction_model_id | Le modèle associé à cette modification dans Stripe (poste de facture, facture, paiement, etc.). | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| booked_date | Date à laquelle l’écriture comptable est ajoutée aux livres. | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| debit_gl_code | Le code de compte du grand livre débité | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| invoice_id | La facture associée à cette modification. Les paiements isolés ou les postes de facture non associés à une facture ont la valeur null. | |
| invoice_line_item_id | L’ID du poste de facture line_item. | |
| invoice_item_id | L’ID du poste de facture | |
| invoice_number | Numéro unique du client associé à la facture. | |
| subscription_item_id | L’ID du poste subscription_item. | |
| price_id | Le tarif associé à cette modification. Les paiements isolés ou les postes de facture non associés à un tarif ont la valeur null. | |
| product_id | Le produit associé à ce tarif. | |
| customer_id | Le client associé à cette modification. | |
| subscription_id | L’abonnement associé à cette modification. | |
| charge_id | Le paiement associé à cette modification. | |
| refund_id | Le remboursement associé à cette modification. | |
| dispute_id | Le litige associé à cette modification. | |
| presentment_currency | La devise de présentation (celle que voit le client) de la transaction. | |
| presentment_amount | Le montant de présentation (celui que voit le client). |
Par poste de facture
Type de rapport d’API : revenue_
| Nom de la colonne | Par défaut | Description |
|---|---|---|
| accounting_period | La période comptable | |
| open_accounting_period | La période comptable ouverte ; les écritures des périodes ouvertes sont sujettes à changement | |
| devise | Code ISO de la devise associée au montant. | |
| transaction_model_id | Modèle associé à cette modification dans Stripe (poste de facture, facture, paiement, etc.). | |
| débit | Le compte débité | |
| crédit | Le compte crédité | |
| booked_date | Date à laquelle l’écriture comptable est ajoutée aux livres. | |
| montant | Variation du montant, exprimée dans l’unité principale de la devise (par exemple en dollars pour l’USD ou en pesos pour le MXN). | |
| debit_gl_code | Le code de compte du grand livre débité | |
| credit_gl_code | Le code de compte du grand livre crédité | |
| invoice_id | La facture associée à cette modification. Les paiements isolés ou les postes de facture non associés à une facture ont la valeur null. | |
| invoice_line_item_id | L’ID du poste de facture line_item. | |
| invoice_item_id | L’ID du poste de facture | |
| subscription_item_id | L’ID du poste subscription_item. | |
| price_id | Le tarif associé à cette modification. Les paiements isolés ou les postes de facture non associés à un tarif ont la valeur null. | |
| product_id | Le produit associé à ce tarif. | |
| customer_id | Le client associé à cette modification. | |
| subscription_id | L’abonnement associé à cette modification. | |
| charge_id | Le paiement associé à cette modification. | |
| refund_id | Le remboursement associé à cette modification. | |
| dispute_id | Le litige associé à cette modification. | |
| presentment_currency | La devise de présentation (celle que voit le client) de la transaction. | |
| presentment_amount | Le montant de présentation (celui que voit le client). |
Si vous rencontrez des problèmes, vous pouvez contacter revenue-recognition-api-beta@stripe.com.