Índice

1. Objetivo
2. Histórico de versão
3. Regras de retorno
4. Endpoint da api
5. Estrutura principal do JSON do arquivo de retorno(download via urlAssinada)
6. Exemplo do JSON de retorno (download via urlAssinada)

Consultar créditos em operações de consumo (CBS)

1. Objetivo

Retorna os créditos de Contribuição sobre Bens e Serviços (CBS) incluídos ou atualizados entre a data consulta e a data da última consulta anterior.

Esta API funciona em modo assíncrono. Para orientações de uso, consulte as Regras Comuns às APIs Assíncronas da Apuração de CBS: regras de APIs assíncronas

2. Histórico de versão

3. Regras de retorno

A janela máxima de retorno das informações é de 8 dias, exceto para primeira consulta (quando não há registro de consulta anterior), situação em que serão retornadas as inclusões e atualizações ocorridas a partir do 1º dia do mês corrente.

4. Endpoint da api

• URL de Produção Restrita:

  • https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/creditos/{cnpj}

• URL de Produção:

  • https://api.receitafederal.gov.br/apuracao-cbs/v2/creditos/{cnpj}

4.1 Campos de Entrada

4.2 Header

4.3 Request Body

4.4 Acionar o endpoint

1. Substitua $TOKEN pelo valor de access_token.
2. Substitua {cnpj} pelo CNPJ base com 8 dígitos.
3. Informe no corpo uma urlRetorno(URL do webhook) - url https válida para receber o payload com o link do arquivo de retorno.

Exemplo de chamada (com variável TOKEN)

curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/creditos/{cnpj}' \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{ "urlRetorno": "https://cliente.exemplo.com/webhooks/apuracao-cbs" }'

Exemplo com dados fictícios

curl --location 'https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/creditos/12345678' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.dadoFicticio.assinaturaFicticia' \
  --data '{ "urlRetorno": "https://cliente.exemplo.com/webhooks/apuracao-cbs" }'

4.5 Campos Retornados

Exemplo de retorno em caso de sucesso (HTTP 201)

{
  "tiqueteSolicitacao": "692b7b25-44cb-4415-8625-2b9522dd7933.B5E08D55",
  "tEASegundos": "120"
}

Exemplo de retorno em caso de erro (HTTP 400/401/404/500)

{
  "codigoErro": "APURACAO-001",
  "mensagemErro": "Parâmetros inválidos para processamento da solicitação."
}

Exemplo de objeto enviado para urlRetorno(webhook) em caso de sucesso (HTTP 200)

{
  "tiqueteSolicitacao":"48d88a3c-eff9-4489-8e3a-cde8d878d3f7.1E0CE7A4",
  "urlAssinadaExpiraEm": "2026-08-26T14:30:00Z",
  "urlAssinada":"https://storagegw.estaleiro.serpro.gov.br/apuracao-assistida-des/arquivos/apuracao-cbs/87654321000198/48d88a3c-eff9-4489-8e3a-cde8d878d3f7.1E0CE7A4_1788876458089.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=N5B4BZIDF0S5FGG4AOUT%2F20260908%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260908T140738Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=7a02254ac3514124ebe8c3ea0a15facfd82ec0e4a572843716d75217d2c4214f%22,%22urlAssinadaExpiraEm%22:%222026-09-10T11:07:38.377213789-03:00%22%7D"  
 } 

5. Estrutura principal do JSON do arquivo de retorno(download via urlAssinada)

6. Exemplo do JSON de retorno (download via urlAssinada)

{
  "tiqueteSolicitacao": "<tiqueteSolicitacao>",
  "ni": "12345678",
  "niConsumidor": "12345678",
  "geradoEm": "2026-08-26T16:00:00Z",
  "apuracao": [
    {
      "pa": "08/2026",
      "creditos": [
        {
          "origem": 1,
          "documento": 1,
          "chave": "string",
          "emissao": "2026-08-01T00:00:00Z",
          "registro": "2026-08-01T00:00:00Z",
          "atualizacao": "2026-08-01T00:00:00Z",
          "cbs": {
            "apurado": 15,
            "excedente": 12,
            "apropriacao": {
              "inapropriavel": 12,
              "suspenso": 1231,
              "prescrito": 1231,
              "aApropriar": 123123,
              "apropriado": 1231
            },
            "utilizacao": {
              "inutilizavel": 12312,
              "utilizado": 12312,
              "restabelecido": 1231,
              "naoUtilizado": {
                "saldoCredor": 123123,
                "pedidoRessarcimento": 1231
              }
            }
          }
        }
      ]
    }
  ]
}