Pular para o conteúdo
Criar conta
ou
Entrar
O logotipo da documentação da Stripe
/
Pergunte à IA
Criar conta
Login
Comece já
Pagamentos
Receita
Plataformas e marketplaces
Gestão de valores
Recursos para desenvolvedores
Visão geral
Billing
Visão geralSobre as APIs do Billing
Assinaturas
Invoicing
Cobrança por uso
Cotações
Gerenciamento de clientes
Cobrança com outros produtos
Recuperação de receitas
Automações
Teste sua integração
Tributos
Visão geral
Usar Stripe Tax
Gerenciar conformidade
Relatórios
Visão geral
Selecionar um relatório
Configurar relatórios
API de relatórios
Relatórios para várias contas
Reconhecimento de receitas
    Visão geral
    Comece já
    Como funciona o reconhecimento de receitas
    Atualização dos dados
    Preços
    Multimoedas
    Conectar plataformas
    Reconhecimento de receitas para cobrança por uso
    Contratos de receita
    Relatórios
    Sobreposições
    Audite seus números
    Exemplos
    Regras de reconhecimento de receitas
    Configurações do Revenue Recognition
    Mapeie para sua tabela de contas
    API de obrigações de desempenho
    Importar dados para a Stripe
    Exportar dados da Stripe
Dados
Visão geralEsquema
Relatórios personalizados
Data Pipeline
Gerenciamento de dados
Página inicialReceitaRevenue recognition

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.

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

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_start] como 1º de maio de 2023 e parameters[interval_end] como 1º de junho de 2023.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
curl https://api.stripe.com/v1/reporting/report_runs \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d report_type="revenue_recognition.debit_credit_summary.1" \ -d "parameters[interval_start]"=1682899200 \ -d "parameters[interval_end]"=1685577600

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_.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
curl https://api.stripe.com/v1/reporting/report_runs/{{REPORT_RUN_OBJECT_ID}} \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

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_.

Command Line
curl
No results
curl https://files.stripe.com/v1/files/{{REPORT_RUN_RESULT_ID}}/contents \ -u
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

Parâmetros de execução do relatório

Tipo de relatórioParâmetros de execução obrigatóriosParâ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. 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 colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
débitoA conta debitada
créditoA conta creditada
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
credit_gl_codeO código do livro-razão creditado
debit_gl_codeO 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 colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
price_idO preço associado a esta mudança.
débitoA conta debitada
créditoA conta creditada
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
credit_gl_codeO código do livro-razão creditado
debit_gl_codeO código do livro-razão debitado

Por produto

Tipo de relatório de API: revenue_recognition.debit_credit_by_product.1

Nome da colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
product_idO produto associado a esta mudança.
débitoA conta debitada
créditoA conta creditada
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
credit_gl_codeO código do livro-razão creditado
debit_gl_codeO código do livro-razão debitado

Por cliente

Tipo de relatório de API: revenue_recognition.debit_credit_by_customer.1

Nome da colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
customer_idO cliente associado a esta mudança.
débitoA conta debitada
créditoA conta creditada
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
credit_gl_codeO código do livro-razão creditado
debit_gl_codeO código do livro-razão debitado

Por fatura

Tipo de relatório de API: revenue_recognition.debit_credit_by_invoice.1

Nome da colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
transaction_model_idO modelo na Stripe associado a essa alteração — um item de linha de fatura, fatura, item de fatura, cobrança ou etc.
débitoA conta debitada
créditoA conta creditada
booked_dateA data em que a entrada do livro-razão é adicionada aos livros.
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
debit_gl_codeO código do livro-razão debitado
credit_gl_codeO código do livro-razão creditado
invoice_idA 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_idO ID do line_item da fatura.
invoice_item_idO ID do item da fatura
invoice_numberO número único do cliente associado à fatura.
subscription_item_idO ID do subscription_item.
price_idO 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_idO produto associado a este preço.
customer_idO cliente associado a esta mudança.
subscription_idA assinatura associada a esta mudança.
charge_idA cobrança associada a essa mudança.
refund_idO reembolso associado a esta mudança.
dispute_idA contestação associada a esta mudança.
presentment_currencyA moeda de apresentação (voltada para o cliente) da transação.
presentment_amountO 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 colunaPadrãoDescrição
accounting_periodO período contábil
open_accounting_periodO período contábil em aberto; as inscrições em períodos abertos estão sujeitas a alterações
moedaCódigo ISO para a moeda de três letras do valor.
transaction_model_idO 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ébitoA conta debitada
créditoA conta creditada
booked_dateA data em que a entrada do livro-razão é adicionada aos livros.
valorAlteração no valor, expressa em unidades principais da moeda (por exemplo, dólares para USD ou pesos para MXN).
debit_gl_codeO código do livro-razão debitado
credit_gl_codeO código do livro-razão creditado
invoice_idA 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_idO ID do line_item da fatura.
invoice_item_idO ID do item da fatura
subscription_item_idO ID do subscription_item.
price_idO 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_idO produto associado a este preço.
customer_idO cliente associado a esta mudança.
subscription_idA assinatura associada a esta mudança.
charge_idA cobrança associada a essa mudança.
refund_idO reembolso associado a esta mudança.
dispute_idA contestação associada a esta mudança.
presentment_currencyA moeda de apresentação (voltada para o cliente) da transação.
presentment_amountO valor de apresentação (voltado para o cliente).

Se ocorrer algum problema, entre em contato com revenue-recognition-api-beta@stripe.com.

Esta página foi útil?
SimNão
  • Precisa de ajuda? Fale com o suporte.
  • Participe do nosso programa de acesso antecipado.
  • Confira nosso changelog.
  • Dúvidas? Fale com a equipe de vendas.
  • LLM? Read llms.txt.
  • Powered by Markdoc