API Revenue RecognitionVisualização pública
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 para download, como um resumo mensal e um relatório de receitas em cascata. Estes relatórios podem ser baixados em formato CSV pelo Dashboard ou acessados automaticamente pelo API.
O Revenue Recognition tem seis tipos de relatórios aceitos:
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
Cuidado
Como esse recurso está em beta, os campos de dados podem mudar.
Baixar um relatório
Este exemplo baixa os débitos e créditos por resumo de maio de 2021.
Primeiro, crie uma execução de relatório usando Criar uma execução de relatório.
Para obter um relatório de maio de 2023, defina parameters[interval_ como 1º de maio de 2023 e parameters[interval_ como 1º de junho de 2023.
Em seguida, recupere o objeto Report Run 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_.
Quando o status do objeto é succeeded, você pode baixar o CSV usando seu valor result., como neste exemplo:
O ID do resultado da execução do relatório começa com file_.
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 |
|
|
| 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 |
|
|
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. Veja abaixo as colunas aceitas para cada tipo de relatório.
Resumo
Tipo de relatório de API: revenue_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| débito | A conta debitada | |
| crédito | A conta creditada | |
| valor | 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_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| price_id | O preço associado a esta mudança. | |
| débito | A conta debitada | |
| crédito | A conta creditada | |
| valor | 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_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| product_id | O produto associado a esta mudança. | |
| débito | A conta debitada | |
| crédito | A conta creditada | |
| valor | 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_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| customer_id | O cliente associado a esta mudança. | |
| débito | A conta debitada | |
| crédito | A conta creditada | |
| valor | 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_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| transaction_model_id | O modelo na Stripe associado a essa alteração — um item de linha de fatura, fatura, item de fatura, cobrança ou etc. | |
| débito | A conta debitada | |
| crédito | A conta creditada | |
| booked_date | A data em que a entrada do livro-razão é adicionada aos livros. | |
| valor | 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_
| Nome da coluna | Padrão | Descrição |
|---|---|---|
| accounting_period | O período contábil | |
| open_accounting_period | O período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações | |
| moeda | Código ISO para a moeda de três letras do valor. | |
| transaction_model_id | 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 | A conta debitada | |
| crédito | A conta creditada | |
| booked_date | A data em que a entrada do livro-razão é adicionada aos livros. | |
| valor | 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.