# API Revenue Recognition Acesse relatórios do Stripe Revenue Recognition de forma automática para automatizar seu regime de competência. Para o regime de competência, o Stripe Revenue Recognition fornece [relatórios disponíveis para download](https://docs.stripe.com/revenue-recognition/reports.md), como um [resumo do período](https://docs.stripe.com/revenue-recognition/reports/period-summary.md) e uma [cascata de receita](https://docs.stripe.com/revenue-recognition/reports/waterfall.md). Você pode baixar esses relatórios em formato CSV pelo [Dashboard](https://dashboard.stripe.com/revenue-recognition) ou acessá-los automaticamente pela API. Stripe Revenue Recognition tem suporte para seis tipos de relatórios: - `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` > Como esse recurso está em beta, os campos de dados podem mudar. ## Baixar um relatório O exemplo a seguir baixa os débitos e créditos por resumo para maio de [Error: Invalid unit "ano"]. Primeiro, crie uma execução de relatório usando [Criar uma execução de relatório](https://docs.stripe.com/api/reporting/report_run/create.md). Para obter um relatório para maio [Error: Invalid unit "ano"], defina `parâmetros[interval_start]` como 1º de maio [Error: Invalid unit "ano"] e `parâmetros[interval_end]` como 1º de junho [Error: Invalid unit "ano"]. ```curl curl https://api.stripe.com/v1/reporting/report_runs \ -u "<>:" \ -d "report_type=revenue_recognition.debit_credit_summary.1" \ -d "parameters[interval_start]=1746057600" \ -d "parameters[interval_end]=1748736000" ``` Em seguida, recupere o objeto [Report Run](https://docs.stripe.com/api/reporting/report_run/object.md) para verificar se foi bem-sucedido ao obter o objeto Report Run: O ID do objeto de execução do relatório começa com `frr_`. ```curl curl https://api.stripe.com/v1/reporting/report_runs/{{REPORT_RUN_OBJECT_ID}} \ -u "<>:" ``` Quando o `status` do objeto é `succeeded`, você pode baixar o CSV usando seu valor `result.id`, como neste exemplo: O ID do resultado da execução do relatório começa com `file_`. #### curl ```bash curl https://files.stripe.com/v1/files/{{REPORT_RUN_RESULT_ID}}/contents \ -u <>: ``` ## Parâmetros de execução do relatório | Tipo de relatório | Parâmetros de execução obrigatórios | Parâmetros de execução opcionais | | ------------------------------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | | revenue_recognition.debit_credit_summary.1 | - `interval_start` - `interval_end` | - `decimal_format` | | revenue_recognition.debit_credit_by_price.1 | - `interval_start` - `interval_end` | - `customer` - `decimal_format` | | revenue_recognition.debit_credit_by_product.1 | - `interval_start` - `interval_end` | - `customer` - `decimal_format` | | revenue_recognition.debit_credit_by_customer.1 | - `interval_start` - `interval_end` | - `decimal_format` | | revenue_recognition.debit_credit_by_invoice.1 | - `interval_start` - `interval_end` | - `customer` - `invoice` - `invoice_line_item` - `decimal_format` | | revenue_recognition.debit_credit_by_invoice_line_item.1 | - `interval_start` - `interval_end` | - `customer` - `invoice` - `invoice_line_item` - `decimal_format` | ## Colunas de execução de relatório Por padrão, os relatórios são executados com o conjunto padrão de colunas. É possível personalizar a seleção e a ordem das colunas na saída ao incluir o parâmetro de colunas opcional com uma [lista de nomes de colunas](https://docs.stripe.com/reports/api.md#report-runs). Veja abaixo as colunas aceitas para cada tipo de relatório. ### Resumo Tipo de relatório de API: `revenue_recognition.debit_credit_summary.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | credit_gl_code | | O código do livro-razão creditado | | debit_gl_code | | O código do livro-razão debitado | ### Por preço Tipo de relatório de API: `revenue_recognition.debit_credit_by_price.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | price_id | ✓ padrão | O preço associado a esta mudança. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | credit_gl_code | | O código do livro-razão creditado | | debit_gl_code | | O código do livro-razão debitado | ### Por produto Tipo de relatório de API: `revenue_recognition.debit_credit_by_product.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | product_id | ✓ padrão | O produto associado a esta mudança. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | credit_gl_code | | O código do livro-razão creditado | | debit_gl_code | | O código do livro-razão debitado | ### Por cliente Tipo de relatório de API: `revenue_recognition.debit_credit_by_customer.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | customer_id | ✓ padrão | O cliente associado a esta mudança. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | credit_gl_code | | O código do livro-razão creditado | | debit_gl_code | | O código do livro-razão debitado | ### Por fatura Tipo de relatório de API: `revenue_recognition.debit_credit_by_invoice.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | transaction_model_id | ✓ padrão | O modelo na Stripe associado a essa alteração — seja um item de linha da fatura, fatura, item da fatura, cobrança e assim por diante. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | booked_date | ✓ padrão | A data em que a entrada do livro-razão é adicionada aos livros. | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | debit_gl_code | | O código do livro-razão debitado | | credit_gl_code | | O código do livro-razão creditado | | invoice_id | | A fatura associada a esta mudança. Cobranças avulsas ou itens de fatura não associados a uma fatura são `null`. | | invoice_line_item_id | | O ID do line_item da fatura. | | invoice_item_id | | O ID do item da fatura | | invoice_number | | O número único do cliente associado à fatura. | | subscription_item_id | | O ID do subscription_item. | | price_id | | O preço associado a esta mudança. Cobranças avulsas ou itens de fatura não associados a um preço são `null`. | | product_id | | O produto associado a este preço. | | customer_id | | O cliente associado a esta mudança. | | subscription_id | | A assinatura associada a esta mudança. | | charge_id | | A cobrança associada a essa mudança. | | refund_id | | O reembolso associado a esta mudança. | | dispute_id | | A contestação associada a esta mudança. | | presentment_currency | | A moeda de apresentação (voltada para o cliente) da transação. | | presentment_amount | | O valor de apresentação (voltado para o cliente). | ### Por item de linha da fatura Tipo de relatório de API: `revenue_recognition.debit_credit_by_invoice_line_item.1` | Nome da coluna | Padrão | Descrição | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | accounting_period | ✓ padrão | O período contábil | | open_accounting_period | ✓ padrão | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | | moeda | ✓ padrão | [Código ISO para a moeda](https://docs.stripe.com/currencies.md) de três letras do valor. | | transaction_model_id | ✓ padrão | O modelo na Stripe associado a essa mudança: um item de linha de fatura, fatura, item de fatura, cobrança e assim por diante. | | débito | ✓ padrão | A conta debitada | | crédito | ✓ padrão | A conta creditada | | booked_date | ✓ padrão | A data em que a entrada do livro-razão é adicionada aos livros. | | valor | ✓ padrão | Alteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN). | | debit_gl_code | | O código do livro-razão debitado | | credit_gl_code | | O código do livro-razão creditado | | invoice_id | | A fatura associada a esta mudança. Cobranças avulsas ou itens de fatura não associados a uma fatura são `null`. | | invoice_line_item_id | | O ID do line_item da fatura. | | invoice_item_id | | O ID do item da fatura | | subscription_item_id | | O ID do subscription_item. | | price_id | | O preço associado a esta mudança. Cobranças avulsas ou itens de fatura não associados a um preço são `null`. | | product_id | | O produto associado a este preço. | | customer_id | | O cliente associado a esta mudança. | | subscription_id | | A assinatura associada a esta mudança. | | charge_id | | A cobrança associada a essa mudança. | | refund_id | | O reembolso associado a esta mudança. | | dispute_id | | A contestação associada a esta mudança. | | presentment_currency | | A moeda de apresentação (voltada para o cliente) da transação. | | presentment_amount | | O valor de apresentação (voltado para o cliente). | Se ocorrer algum problema, entre em contato com [revenue-recognition-api-beta@stripe.com](mailto:revenue-recognition-api-beta@stripe.com).