API Revenue RecognitionVista previa pública
Accede a los informes de Stripe Revenue Recognition mediante programación para automatizar tu contabilidad de ejercicio.
Para la contabilidad de ejercicio, Stripe Revenue Recognition proporciona informes descargables, como un resumen mensual y un gráfico de cascada de ingresos. Puedes descargar estos informes en formato CSV a través del Dashboard o puedes acceder a ellos mediante programación a través de la API.
Revenue Recognition admite seis tipos de informes:
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
Precaución
Los campos de datos pueden cambiar porque esta funcionalidad está en versión beta.
Descargar un informe
En el siguiente ejemplo, se descargan los débitos y créditos por resumen de mayo de 2021.
En primer lugar, crea el objeto report run utilizando Crear un objeto Report Run.
Para obtener un informe de mayo de 2023, establece parameters[interval_ en 1 de mayo de 2023 y parameters[interval_ en 1 de junio de 2023.
A continuación, verificar si el objeto Report Run es correcto recuperando dicho objeto:
El ID del objeto Report Run comienza con frr_.
Cuando el status del objeto es succeeded, puedes descargar el archivo CSV usando su valor result., como en el siguiente ejemplo:
El ID del resultado de la ejecución del informe comienza confile_.
Parámetros de ejecución del informe
| Tipo de informe | Parámetros de ejecución obligatorios | Parámetros de ejecución opcionales |
|---|---|---|
| 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 |
|
|
Columnas de ejecución del informe
De forma predeterminada, los informes se ejecutan con el conjunto predeterminado de columnas. Puedes personalizar la selección y el orden de las columnas en el resultado si incluyes el parámetro opcional columns con una lista de nombres de columnas. A continuación, encontrarás las columnas aceptadas para cada tipo de informe.
Resumen
Tipo de informe de API: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| credit_gl_code | El código acreditado del libro mayor | |
| debit_gl_code | El código debitado del libro mayor |
Por precio
Tipo de informe de API: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| price_id | El precio asociado a este cambio. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| credit_gl_code | El código acreditado del libro mayor | |
| debit_gl_code | El código debitado del libro mayor |
Por producto
Tipo de informe de API: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| product_id | El producto asociado con este cambio. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| credit_gl_code | El código acreditado del libro mayor | |
| debit_gl_code | El código debitado del libro mayor |
Por cliente
Tipo de informe de API: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| customer_id | El cliente asociado con este cambio. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| credit_gl_code | El código acreditado del libro mayor | |
| debit_gl_code | El código debitado del libro mayor |
Por factura
API tipo de informe: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| transaction_model_id | El modelo de Stripe asociado con este cambio, ya sea una partida de factura, factura, ítem de factura, cargo, etc. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| booked_date | La fecha en que el movimiento en el libro mayor se agrega a los libros. | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| debit_gl_code | El código debitado del libro mayor | |
| credit_gl_code | El código acreditado del libro mayor | |
| invoice_id | La factura asociada a este cambio. Los cargos independientes o las partidas de factura no asociados a una factura son null. | |
| invoice_line_item_id | El ID de la line_item de factura. | |
| invoice_item_id | El ID de la partida de factura | |
| invoice_number | El número único del cliente asociado a la factura. | |
| subscription_item_id | El ID del subscription_item. | |
| price_id | El precio asociado a este cambio. Los cargos independientes o las partidas de factura no asociados a un precio son null. | |
| product_id | El producto asociado con este precio. | |
| customer_id | El cliente asociado con este cambio. | |
| subscription_id | La suscripción asociada con este cambio. | |
| charge_id | El cargo asociado con este cambio. | |
| refund_id | El reembolso asociado con este cambio. | |
| dispute_id | La disputa asociada con este cambio. | |
| presentment_currency | La moneda de pago (de cara al cliente) de la transacción. | |
| presentment_amount | El importe de pago (de cara al cliente). |
Por partida individual de factura
API tipo de informe: revenue_
| Nombre de la columna | Valor predeterminado | Descripción |
|---|---|---|
| accounting_period | El período contable | |
| open_accounting_period | El período contable abierto; las inscripciones en períodos abiertos están sujetas a cambios | |
| moneda | El código ISO de tres letras de la moneda del importe. | |
| transaction_model_id | El modelo de Stripe asociado a este cambio: una partida individual de factura, una factura, una partida de factura, un cargo, etc. | |
| débito | La cuenta debitada | |
| crédito | La cuenta acreditada | |
| booked_date | La fecha en que el movimiento en el libro mayor se agrega a los libros. | |
| importe | Cambio del importe, expresado en unidades principales de la moneda (por ejemplo, dólares para USD o pesos para MXN). | |
| debit_gl_code | El código debitado del libro mayor | |
| credit_gl_code | El código acreditado del libro mayor | |
| invoice_id | La factura asociada a este cambio. Los cargos independientes o las partidas de factura no asociados a una factura son null. | |
| invoice_line_item_id | El ID de la line_item de factura. | |
| invoice_item_id | El ID de la partida de factura | |
| subscription_item_id | El ID del subscription_item. | |
| price_id | El precio asociado a este cambio. Los cargos independientes o las partidas de factura no asociados a un precio son null. | |
| product_id | El producto asociado con este precio. | |
| customer_id | El cliente asociado con este cambio. | |
| subscription_id | La suscripción asociada con este cambio. | |
| charge_id | El cargo asociado con este cambio. | |
| refund_id | El reembolso asociado con este cambio. | |
| dispute_id | La disputa asociada con este cambio. | |
| presentment_currency | La moneda de pago (de cara al cliente) de la transacción. | |
| presentment_amount | El importe de pago (de cara al cliente). |
Si tienes algún problema, puedes ponerte en contacto con revenue-recognition-api-beta@stripe.com.