Como saber o que significa um CSTAT?
Os Códigos de Status da Sefaz (CSTAT) têm o propósito de amparar na resolução dos problemas que podem acontecer ao realizar a emissão de um DFe.
Neste endpoint, a API irá retornar um link de artigo da Base de Conhecimento (BC) Oobj com informações sobre o que significa e, em algumas situações, sobre como resolver o CSTAT.
Consultar BC Oobj sobre CSTAT
Para começar, faça uma requisição tipo GET ao endpoint de consultar BC Oobj sobre Códigos de Status da Sefaz (CSTAT);
[URL_BASE]/api/base-conhecimento/{codigoModelo}/{codigoCstat}
Preencha as seguintes informações (
path parameters
):{codigoModelo}
*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe) ou 66 (NF3e);{codigoCstat}
*: código CSTAT;
Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
O exemplo abaixo traz um modelo de requisição preenchido para consulta de um link de artigo com informações do CSTAT.
A requisição contém dados fictícios, somente para demonstração.
curl -L -X GET 'https://rest-teste.oobj.com.br/api/base-conhecimento/55/220' \
-H 'Accept: */*'
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'
Exemplo de retorno
http://www.oobj.com.br/bc/article/rejei%C3%A7%C3%A3o-220-prazo-de-cancelamento-superior-ao-previsto-na-legisla%C3%A7%C3%A3o-como-resolver-416.html
Pronto! Você acaba de completar a consulta de um CSTAT na BC Oobj.