Receita Federal · Documentação oficial
Créditos CBS
Retorna créditos de CBS incluídos ou atualizados entre a data da consulta e a da última consulta anterior. Janela máxima: 8 dias.
Endpoints
POST
https://api.receitafederal.gov.br/apuracao-cbs-prr/v2/creditos/{cnpj} produção restrita POST
https://api.receitafederal.gov.br/apuracao-cbs/v2/creditos/{cnpj} produção Exemplos de chamada
Com variáveis de ambiente
curl --location --request POST \
'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" }' Com dados fictícios
curl --location --request POST \
'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" }' Webhook — payload de sucesso
{
"tiqueteSolicitacao": "48d88a3c-eff9-4489-8e3a-cde8d878d3f7.1E0CE7A4",
"urlAssinadaExpiraEm": "2026-08-26T14:30:00Z",
"urlAssinada": "https://storagegw.estaleiro.serpro.gov.br/..."
} Estrutura do JSON de retorno
| Campo | Nível | Cardinalidade | Formato | Descrição |
|---|---|---|---|---|
tiqueteSolicitacao | 1 | 1:1 | string | Tíquete da solicitação |
ni | 1 | 1:1 | string (8) | NI do contribuinte |
niConsumidor | 1 | 0:1 | string | NI do consumidor |
geradoEm | 1 | 1:1 | datetime | Data/hora geração arquivo |
apuracao | 1 | 1:N | array | Lista de apurações |
apuracao[].pa | 2 | 1:1 | date (mm/aaaa) | Período de apuração |
apuracao[].creditos | 2 | 1:N | array | Lista de créditos |
apuracao[].creditos[].origem | 3 | 1:1 | integer | Origem do crédito |
apuracao[].creditos[].documento | 3 | 1:1 | integer | Tipo de documento fiscal |
apuracao[].creditos[].chave | 3 | 1:1 | string (50) | Chave documento fiscal |
apuracao[].creditos[].emissao | 3 | 1:1 | datetime | Data/hora emissão |
apuracao[].creditos[].registro | 3 | 1:1 | datetime | Data/hora registro |
apuracao[].creditos[].atualizacao | 3 | 1:1 | datetime | Data/hora última atualização |
apuracao[].creditos[].cbs | 3 | 1:1 | object | Grupo valores CBS |
apuracao[].creditos[].cbs.excedentes | 4 | 0:1 | number (18,2) | Excedentes não processados |
apuracao[].creditos[].cbs.apurado | 4 | 1:1 | number (18,2) | Valor apurado |
apuracao[].creditos[].cbs.apropriacao | 4 | 0:1 | object | Grupo apropriação |
apuracao[].creditos[].cbs.apropriacao.inapropriavel | 5 | 0:1 | number (18,2) | Valor inapropriável |
apuracao[].creditos[].cbs.apropriacao.suspenso | 5 | 0:1 | number (18,2) | Valor suspenso |
apuracao[].creditos[].cbs.apropriacao.prescrito | 5 | 0:1 | number (18,2) | Valor prescrito |
apuracao[].creditos[].cbs.apropriacao.aApropriar | 5 | 0:1 | number (18,2) | Valor a apropriar |
apuracao[].creditos[].cbs.apropriacao.apropriado | 5 | 0:1 | number (18,2) | Valor apropriado |
apuracao[].creditos[].cbs.apropriacao.utilizacao | 5 | 0:1 | object | Grupo utilização |
apuracao[].creditos[].cbs.apropriacao.utilizacao.inutilizavel | 6 | 0:1 | number (18,2) | Valor inutilizável |
apuracao[].creditos[].cbs.apropriacao.utilizacao.utilizado | 6 | 0:1 | number (18,2) | Valor utilizado |
apuracao[].creditos[].cbs.apropriacao.utilizacao.restabelecido | 6 | 0:1 | number (18,2) | Valor restabelecido |
apuracao[].creditos[].cbs.apropriacao.utilizacao.naoUtilizado | 6 | 0:1 | object | Grupo não utilizado |
apuracao[].creditos[].cbs.apropriacao.utilizacao.naoUtilizado.saldoCredor | 7 | 0:1 | number (18,2) | Saldo credor |
apuracao[].creditos[].cbs.apropriacao.utilizacao.naoUtilizado.pedidoRessarcimento | 7 | 0:1 | number (18,2) | Pedido ressarcimento |
Exemplo completo de resposta JSON
{
"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,
"excedentes": 0,
"apropriacao": {
"inapropriavel": 0,
"suspenso": 0,
"prescrito": 0,
"aApropriar": 0,
"apropriado": 0,
"utilizacao": {
"inutilizavel": 0,
"utilizado": 0,
"restabelecido": 0,
"naoUtilizado": {
"saldoCredor": 0,
"pedidoRessarcimento": 0
}
}
}
}
}
]
}
]
}