Ir para conteúdo
  • Cadastre-se

Recommended Posts

Postado

Boa tarde, gostaria de saber se alguém da comunidade do ACBR ja esta utilizando alguma API da Apuração Assistida, vi que ja existem alguns webservices disponibilizados ... e se sera criado algum componente para tal ou devemos criar soluções próprias?

Endpoint's Disponíveis

Endpoint Access Token

Endpoint Access Token URL de Produção e Produção Restrita:

https://api.receitafederal.gov.br/token

Endpoint Access Token URL de Homologação:

https://h-gateway.receitaintegra.serpro.gov.br/token

Exemplo de chamada:

            
curl -X POST --location 'https://api.receitafederal.gov.br/token' \
--user "<clientID>:<clientSecret>" \
-d 'grant_type=client_credentials'

Apuração de débitos do CBS

Fornece os dados de apuração de débitos da CBS de um contribuinte para o período atual.

Campos de Entrada

Endpoint

Campo Formato Descrição
CNPJ base String (8) CNPJ do contribuinte. Apenas o CNPJ Base (8 dígitos para filtro; quando necessário, informar com zeros à esquerda).

Header

Campo Formato Descrição
Authorization String Bearer <token de acesso>, informado na requisição.

Request Body

Campo Formato Descrição
URL Retorno String Url informada na solicitação para retorno da requisição.

Campos Retornados

Campo Formato Descrição
Tiquete String Tíquete gerado na requisição das informações. Deve ser usado para acessar o serviço o download do arquivo JSON. Este campo é retornado apenas em caso de sucesso da requisição.
Codigo Erro String Identifica o erro ocorrido durante a requisição. Este campo é retornado apenas em caso de erro.
Mensagem Erro String Mensagem que descreve o erro ocorrido durante a requisição. Este campo é retornado apenas em caso de erro.

Respostas

Grupo Cód. Status Descrição
Sucesso 201 Solicitação realizada com sucesso.
Erro 400 Requisição inválida
Erro 404 Requisição inválida ou erro interno.

Layout do JSON

Campo Nível Cardinalidade Formato Descrição
apuracaoCorrente 1 1:1   Grupo de débitos do período corrente (mês atual)
debitos 2 0:N   Grupo de documentos do débito
modeloDfe 3 1:1 string Modelo do Documento Fiscal Eletrônico (DF-e)
numeroDfe 3 1:1 string Número do Documento Fiscal Eletrônico (DF-e)
chaveDfe 3 1:1 string Chave do Documento Fiscal Eletrônico (DF-e)
dataDfeEmissao 3 1:1 datetime Data/Hora de emissão do Documento Fiscal (DF-e)
dataDfeAutorizacao 3 1:1 datetime Data/Hora de autorização Documento Fiscal (DF-e)
dataDfeRegistro 3 1:1 datetime Data/Hora de registro (recepção) do Documento Fiscal (DF-e)
dataApuracao 3 1:1 string(6) Período de apuração (AAAAMM)
niEmitente 3 1:1 string(14) CNPJ completo do emitente
niAdquirente 3 1:1 string(14) CPF ou CNPJ completo do adquirente
valorCBSTotal 3 1:1 decimal(18,2) Valor de débito de CBS principal
valorCBSExtinto 3 1:1 decimal(18,2) Valor de débito de CBS principal extinto
valorCBSNaoExtinto 3 1:1 decimal(18,2) Valor de débito de CBS principal que sobrou sem extinção
situacaoDebito 3 1:1 string Situação do Débito (Aguardando Processamento / Não Extinto / Extinto Parcial / Extinto Total / Cancelado)
formasExtincao 4 1:1   Grupo de formas de extinção do débito
creditosCBS 5 1:1   Grupo de créditos básicos utilizados
cClassCred 6 1:1 string Classificação do crédito (básico, presumido... 25 tipos)
modeloDfe 6 1:1 string Modelo do Documento Fiscal Eletrônico (DF-e)
numeroDfe 6 0:1 string Número do Documento Fiscal Eletrônico (DF-e)
chaveDfe 6 1:1 string Chave do Documento Fiscal Eletrônico (DF-e)
dataCreditoUtilizado 6 1:1 datetime Data/Hora de registro da apropriação com crédito
valorCreditoUtilizadoPrincipal 6 1:1 decimal(18,2) Valor do crédito utilizado para compensação do débito principal
valorCreditoUtilizadoMulta 6 1:1 decimal(18,2) Valor do crédito utilizado para compensação do débito de multa
valorCreditoUtilizadoJuros 6 1:1 decimal(18,2) Valor do crédito utilizado para compensação do débito de juros
creditosPISCOFINS 5 1:1   Grupo de créditos de PIS/COFINS utilizados
origem 6 1:1    
dataCreditoUtilizado 6 1:1 datetime Data de registro da compensação com crédito de PIS/COFINS
valorCreditoUtilizado 6 1:1 decimal(18,2) Valor do crédito PIS/COFINS para compensação do débito principal
valorCreditoUtilizadoMulta 6 1:1 decimal(18,2) Valor do crédito utilizado para débito de multa
valorCreditoUtilizadoJuros 6 1:1 decimal(18,2) Valor do crédito utilizado para débito de juros
pagamentosCBS 5 1:1   Grupo de pagamentos utilizados
numeroDarf 6 1:1 string(17) Número do DARF
tipoPagamento 6 1:1 string Tipo de pagamento (split, adquirente, contribuinte, responsável)
dataDarfArrecadado 6 1:1 datetime Data/Hora de arrecadação do pagamento
dataDarfUtilizado 6 1:1 datetime Data/Hora de utilização do pagamento
valorDarfUtilizadoPrincipal 6 1:1 decimal(18,2) Valor usado para pagar o débito principal
valorDarfUtilizadoMulta 6 1:1 decimal(18,2) Valor usado para pagar o débito de multa
valorDarfUtilizadoJuros 6 1:1 decimal(18,2) Valor usado para pagar o débito de juros
prescricao 5 1:1   Grupo de débitos extintos por prescrição
dataPrescrito 6 0:1 datetime Data/Hora da extinção por prescrição
valorPrescrito 6 0:1 decimal(18,2) Valor de CBS extinto por prescrição
eventos 4 1:1   Grupo de eventos vinculados ao débito
apuracaoAjuste 1 1:1   Grupo de débitos do período em ajuste (mês anterior). Mesmos grupos de apuracaoCorrente
Mesmos grupos de apuracaoCorrente        
debitosExtemporaneos 1 1:1   Débitos de períodos anteriores RECEBIDOS no mês da consulta.
Mesmos grupos da apuracaoCorrente      

Pré-requisitos

Passo a passo para utilização

  1. Acionar o endpoint informando CNPJ básico, url do webhook e token de acesso.

    Exemplo de chamada
    curl --location 'https://api.receitafederal.gov.br/rtc/apuracao-cbs/v1/{cnpj}' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Bearer X9XnF1L55CyyhO6zZZzL9qiw1uJ33qkG' \
        --data '{ "urlRetorno": "<url do webhook>" }'

    Observação: O acesso ao endpoint está restrito a 2 chamadas por dia.

  2. Após receber o retorno da requisição na url indicada, acessar o endpoint de download (acessível através de URL de Produção: https://api.receitafederal.gov.br/rtc/download/v1/{tiquete} ou URL de Produção Restrita: https://api.receitafederal.gov.br/prr-rtc/download/v1/{tiquete} ou URL de Homologação: https://h-gateway.receitaintegra.serpro.gov.br/rtc/download/v1/{tiquete}) para realizar o download do arquivo JSON com os dados retornados pela api.

    Exemplo de chamada
    
          curl --location --request GET 'https://api.receitafederal.gov.br/rtc/download/v1/{tiquete}' \
          --header 'Content-Type: application/json' \
          --header 'Authorization: Bearer X9XnF1L55CyyhO6zZZzL9qiw1uJ33qkG'
                

    Observação: O acesso ao endpoint está restrito a 8 chamadas por dia, sendo permitido um único acesso por tíquete.

Endpoints

URL de Produção:
https://api.receitafederal.gov.br/rtc/apuracao-cbs/v1/{cnpj}

URL de Produção Restrita:
https://api.receitafederal.gov.br/prr-rtc/apuracao-cbs/v1/{cnpj}

URL de Homologação:
https://h-gateway.receitaintegra.serpro.gov.br/rtc/apuracao-cbs/v1/{cnpj}

Download Arquivo

Realiza o download do arquivo de apuração gerado previamente, identificado pelo tíquete.

Pré-requisitos

Passo a passo para utilização

  1. Após receber o retorno da requisição na url indicada, acessar o endpoint de download (acessível através de URL de Produção: https://api.receitafederal.gov.br/rtc/download/v1/{tiquete} ou URL de Produção Restrita: https://api.receitafederal.gov.br/prr-rtc/download/v1/{tiquete} ou URL de Homologação: https://h-gateway.receitaintegra.serpro.gov.br/rtc/download/v1/{tiquete}) para realizar o download do arquivo JSON com os dados retornados pela api.

    Exemplo de chamada
    
          curl --location --request GET 'https://api.receitafederal.gov.br/rtc/download/v1/{tiquete}' \
          --header 'Content-Type: application/json' \
          --header 'Authorization: Bearer X9XnF1L55CyyhO6zZZzL9qiw1uJ33qkG'
                

    Observação: O acesso ao endpoint está restrito a 8 chamadas por dia, sendo permitido um único acesso por tíquete.

Endpoints

URL de Produção:
https://api.receitafederal.gov.br/rtc/download/v1/{tiquete}

URL de Produção Restrita:
https://api.receitafederal.gov.br/prr-rtc/download/v1/{tiquete}

URL de Homologação:
https://h-gateway.receitaintegra.serpro.gov.br/rtc/download/v1/{tiquete}

Campos de Entrada

Endpoint

Campo Formato Descrição
Tíquete String Tíquete gerado na solicitação das informações de apuração CBS, utilizando um dos serviços gratuitos disponíveis.

Header

Campo Formato Descrição
Authorization String Bearer <token de acesso>, informado na requisição.

Respostas

Grupo Cód. Status Descrição
Sucesso 200 Arquivo baixado com sucesso. Retorna o arquivo JSON do extrato.
Erro 400 Requisição inválida.
Erro 403 CNPJ do consumidor não corresponde ao CNPJ da solicitação.
Erro 404 Arquivo não encontrado ou ticket inválido.
Voltar
  • Curtir 1
  • 2 semanas depois ...
  • Membro Pro Verificado
Postado
2 minutos atrás, marcosvillatore disse:

Eu consegui autenticar, gerar o Tiquete. Mas quando consulto pelo tiquete gerado me retorna "Tiquete inexistente"

Boa tarde

O tíquete que retorna não é o que você vai usar na rota que faz o download.

O código para baixar o json vem no webHook.

Eu tinha conseguido chegar até o ponto de receber o código para download, mas o download não funcionava. Não retornava nada.

Agora nem o webHook está mais funcionando. Não dá erro nenhum, mas a API não envia o body para o webHook.

Acredito que estejam ajustando.

Espero ter ajudado.

  • Obrigado 1

Valdir Dill

Rio de Janeiro - RJ

 

 

  • Renato Rubinho changed the title to [ACBR-8968] Apuração Assistida
  • Consultores
Postado

Criada tarefa ACBR-8968 e adicionada no backlog para análise de viabilidade da implementação do consumo dos métodos da Apuração Assistida.
Vinculado seu tópico à tarefa e assim que for dado andamento, reportaremos aqui.

  • Curtir 1
  • 2 semanas depois ...
Postado

Bom dia pessoal,

 

Estou tentando realizar a chamada para o endpoint /rtc/apuracao-cbs/v1/CNPJ, porém estou recebendo o erro "O CNPJ informado no cabeçalho 'x-consumer-titular' não corresponde ao cnpj da rota consultada". Tentei passar esse parametro no Header, mas sem sucesso.

Alguém já passou por esse erro?

 

Tentei realizar a chamada usando o ambiente de produção restrita (prr-rtc/apuracao-cbs) e recebo o erro "You cannot consume this service".

E no ambiente de homologação sequer consigo gerar o token, estou recebendo timeout toda vez...

 

Se alguém puder me dar uma luz ficaria agradecido.

Postado
Em 22/02/2026 at 10:48, msiqueira disse:

Bom dia pessoal,

 

Estou tentando realizar a chamada para o endpoint /rtc/apuracao-cbs/v1/CNPJ, porém estou recebendo o erro "O CNPJ informado no cabeçalho 'x-consumer-titular' não corresponde ao cnpj da rota consultada". Tentei passar esse parametro no Header, mas sem sucesso.

Alguém já passou por esse erro?

 

Tentei realizar a chamada usando o ambiente de produção restrita (prr-rtc/apuracao-cbs) e recebo o erro "You cannot consume this service".

E no ambiente de homologação sequer consigo gerar o token, estou recebendo timeout toda vez...

 

Se alguém puder me dar uma luz ficaria agradecido.

Olá, tudo bem?

Você deve estar informando como estava fazendo.

Entrei em contato com o suporte dentro do próprio portal, onde me passaram essa documentação atualizada, mas resumidamente, você deve informar apenas os 8 primeiros digitos do CNPJ.

Só tenho outra informação para fazer o download, o ticket usado deve ser o que será retornado para seu Webhook, para ser mais exato o valor do campo tiqueteDownload

{
"tiqueteSolicitacao": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.XXXXXXXX",
"tiqueteDownload": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.XXXXXXXX"
}

PASSO 1: Autenticar (token)

Faça a chamada para o endpoint abaixo, informando o clientID e clientSecret gerados para sua empresa ou procurador.

A chave de acesso (token) gerada permite solicitar e baixar arquivos por até 1 hora. Após esse tempo, uma nova autenticação precisa ser realizada.

Endpoint:

https://api.receitafederal.gov.br/token

Entradas:
• [user] clientID e clientSecret.

Retorno:
• chave de acesso (token).

PASSO 2: Solicitar (tíquete)

Faça a chamada para o endpoint abaixo, informando a inscrição no CNPJ (apenas os 8 primeiros dígitos), chave de acesso (token) e webhook (URL), onde receberá o retorno da chamada.

O acesso ao endpoint é restrito a 2 chamadas por dia. Excedido o número máximo de chamadas, a API retornará o erro 429: “Too many requests”.

Endpoint:

https://api.receitafederal.gov.br/rtc/apuracao-cbs/v1/{cnpj}

Entradas:
• [endpoint] inscrição no CNPJ (8 dígitos);
• [header] chave de acesso (token); e
• [body] webhook (URL).

Retorno:
• tíquete da solicitação.

PASSO 3: Baixar (download)

Faça a chamada para o endpoint abaixo, informando o tíquete gerado no passo anterior e a chave de acesso (token).

O acesso ao endpoint é restrito a 8 chamadas por dia, sendo permitido um único acesso por tíquete.

Endpoint:

https://api.receitafederal.gov.br/rtc/download/v1/{tiquete}

Entradas:
• [endpoint] tíquete; e
• [header] chave de acesso (token).

Retorno:
• arquivo JSON com a relação de débitos de CBS.

Atenciosamente,

Alan Leônidas - LT Tech

Postado

Boa tarde Alan,

 

Você resolveu meu problema....

Eles solicitam o CNPJ (pelo menos nas documentações que li), porém tem que passar apenas o CNPJ Raiz (8 primeiros digitos).

Agora consegui fazer a requisição.

 

Muito obrigado!

  • Curtir 1
  • 1 mês depois ...
Postado

Pessoal

 

apesar de eu estar recebendo a requisição da receita no meu webhook, na minha requisição de registro o retorno é {"mensagemErro":"Erro ao enfileirar XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.XXXXXXXX","codigoErro":"ERRO_INTERNO"} 

esse comportamento é normal ? a receita está com algum problem ao registrar o webhook 

Postado

Boa tarde, estão conseguindo receber o json com os débitos da apuração assistida? Aqui parou de funcionar no dia 27/03/2026, retorna sempre o erro: {"mensagemErro":"Erro ao enfileirar XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.XXXXXXXX","codigoErro":"ERRO_INTERNO"} 

Postado

Olá pessoal, estou desenvolvendo agora o webhook para receber os dados. É no modelo abaixo que a receita envia para o webhook?

{
   
    "tiqueteSolicitacao":"teste2",
    "tiqueteDownload":"teste2"
 
}
Postado

Continuam com esse erro ? 

 

{
    "mensagemErro": "Erro ao enfileirar XXXXXXXXXXXXXXXXXXXXXX",
    "codigoErro": "ERRO_INTERNO"
}
Postado

Olá Pessoal. bom dia.  Estou recebendo uma chamada HEAD no meu webhook, mas após isso não estou recebendo nenhuma outra chamado com o tiqueteDownload.

A API está normal pra vcs ? Esse processo demora ?

Postado

Bom dia, o retorno para o webhook não é muito demorado, aqui também só está chegando o HEAD, quando estava funcionando, o POST chegava alguns segundos depois do HEAD, até dia 27/03 estava funcionando perfeitamente.

Testei agora e está com o mesmo problema

{
    "mensagemErro": "Erro ao enfileirar xxxxxxxxxxxxxxxxxxxxxxxxx",
    "codigoErro": "ERRO_INTERNO"
}
Postado

Pessoal meu gerente que acesso (ja é restrito) tem entrar em contato com  os gestores do projeto Reforma Tributária para solicitar acesso da plataforma para fazer, porém meu gerente ja abriu chamado e a Receita e informa que ja acionou a equipe tecnica , porém ainda sem retorno da resolução.

  • 3 semanas depois ...
Postado

Olá Pessoal.. Consegui obter a apuração... Mas tenho várias raízes de CNPJ, estou recebendo apenas de um CNPJ, os demais estou recebendo apenas o HEAD e vcs ?

Crie uma conta ou entre para comentar

Você precisar ser um membro para fazer um comentário

Criar uma conta

Crie uma nova conta em nossa comunidade. É fácil!

Crie uma nova conta

Entrar

Já tem uma conta? Faça o login.

Entrar Agora
×
×
  • Criar Novo...

Informação Importante

Colocamos cookies em seu dispositivo para ajudar a tornar este site melhor. Você pode ajustar suas configurações de cookies, caso contrário, assumiremos que você está bem para continuar.