Como saber se a Sefaz emitiu meu documento?

Solicite à API um retorno sobre o status do documento enviado para a Sefaz. Isso é importante para saber se o DFe foi autorizado, rejeitado ou se o arquivo foi dado como inválido.

Há duas formas de solicitar esse retorno:

1. Utilizando o ano, série e número;
2. Utilizando chave de acesso do documento.

Observação

Durante a integração do seu sistema com a API REST Oobj, a equipe de desenvolvimento pode escolher um dos dois métodos, ou ambos.

---

Consultar retorno com ano, série e número

1. Faça uma requisição tipo GET ao endpoint buscar um DFe por ano, série e número;

[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{ano}/{serie}/{numero}

2. Preencha as seguintes informações:

   • {empresa}*: CNPJ da empresa;
   • {ambiente}*: hom ou prod;
   • {codModelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe) ou 99 (NFSe);
   • {ano}*: ano de emissão no formato AAAA;
   • {serie}*: série do documento;
   • {numero}*: número do documento;

3. 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 do retorno da Sefaz com ano, série e número.

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/prod/55/2023/503/750165' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'

Exemplo de retorno

{
  "idLote": 750165,
  "timestamp": 1674569850000,
  "conteudo": "<?xml ... >",
  "status": "Autorizada",
  "statusArquivo": "Válido",
  "chaveAcesso": "43230107385111000102555030007395551671396516",
  "cStat": 100,
  "xMotivo": "Autorizado o uso da NF-e",
  "codigoUF": 43,
  "numeroProtocolo": "143230000049119",
  "dataRecebimento": 1674569850000,
  "permiteImpressao": true,
  "tipoEmissao": {
    "codigo": 1,
    "descricao": "Normal"
  }
}

Atenção

Caso o documento tenha sido autorizado, o campo conteudo do retorno trará o XML PROC, que deve ser armazenado pela empresa emitente durante cinco anos.

---

Consultar retorno com chave de acesso

1. Faça uma requisição GET ao endpoint buscar um DFe por chave de acesso;

[URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/{chaveAcesso}

2. Preencha as seguintes informações (path parameters):

   • {empresa}*: CNPJ da empresa;
   • {ambiente}*: hom ou prod;
   • {codModelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe) ou 99 (NFSe);
   • {chaveAcesso}*: chave de acesso do documento;

3. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Exemplo de requisição

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/prod/55/2023/503/739578' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'

Exemplo de retorno

{
  "idLote": 739578,
  "timestamp": 1674569850000,
  "conteudo": "Conteúdo do XML",
  "status": "Autorizada",
  "statusArquivo": "Válido",
  "chaveAcesso": "43230107385111000102555030007395551671396516",
  "cStat": 100,
  "xMotivo": "Autorizado o uso da NF-e",
  "codigoUF": 43,
  "numeroProtocolo": "143230000049119",
  "dataRecebimento": 1674569850000,
  "permiteImpressao": true,
  "tipoEmissao": {
    "codigo": 1,
    "descricao": "Normal"
  }
}

Atenção

Caso o documento tenha sido autorizado, o campo conteudo do retorno traz o XML PROC, que deve ser armazenado durante cinco anos pela empresa emitente.

Pronto, você acaba de finalizar o processo de consultar o retorno de status do documento enviado para a Sefaz! Siga para o artigo Como fazer download do DADFe ou do DANFe?