Como consultar as inutilizações emitidas?

Após enviar uma requisição de emissão de inutilização, é recomendado consultar o retorno da solicitação.

Há duas formas de obter o retorno:

1. Consultar retorno de uma inutilização específica;
2. Consultar todas as inutilizações de uma empresa.

Em ambos os casos, no campo conteudo do retorno 200 da requisição, você encontra o XML Proc da inutilização. Esse documento é idêntico ao armazenado pela Sefaz deve ser guardado pelo contribuinte por pelo menos cinco anos.

---

Consultar retorno de uma inutilização específica

Para consultar os detalhes de uma inutilização específica, siga estes passos:

1. Faça uma requisição tipo GET ao endpoint consultar detalhes de uma inutilização;

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

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

   • {empresa}*: CNPJ da empresa;
   • {ambiente}*: hom ou prod;
   • {codModelo}*: 55 (NFe), 57 (CTe) ou 65 (NFCe);
   • {uf}*: sigla da UF. Valores aceitos: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO;
   • {ano}*: ano de emissão no formado AA (dois dígitos);
   • {serie}*: série do DFe inutilizado;
   • {numero}*: número do DFe inutilizado.

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 de consulta de inutilização específica.

curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/inutilizacoes/hom/55/GO/23/502/10000' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'

Exemplo de retorno

{
    "ambiente": "Homologação",
    "uf": "GO",
    "ano": 2023,
    "cnpjEmitente": "07385111000102",
    "modelo": 55,
    "serie": 502,
    "numeroInicial": 1000,
    "numeroFinal": 1003,
    "protocolo": null,
    "justificativa": "Teste de inutilizacao",
    "dataRecebimento": 1682446343000,
    "conteudo": "<?xml ...\>",
    "status": "REJ"
}

---

Consultar todas as inutilizações de uma empresa

Para consultar todas as inutilizações de uma empresa a partir de um modelo de DFe específico, UF e ano, siga estes passos:

1. Faça uma requisição tipo GET ao endpoint consultar inutilizações de uma empresa;

[URL_BASE]/api/empresas/{empresa}/docs/inutilizacoes/{ambiente}/{codModelo}/{uf}/{ano}

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

   • {empresa}*: CNPJ da empresa;
   • {ambiente}*: hom ou prod;
   • {codModelo}*: 55 (NFe), 57 (CTe) ou 65 (NFCe);
   • {uf}*: sigla da UF. Valores aceitos: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO;
   • {ano}*: ano de emissão no formado AAAA (quatro dígitos);

3. Preencha os seguintes parâmetros de consulta (query parameters):

   • {pagina}opcional: página de registros, onde 1 significa a primeira página;
   • {comXml}opcional: true (para retornar os XMLs) ou false (para não retornar os XMLs).

DICA

O campo {numeroTotal} do retorno 200 deste endpoint informa o total de itens que podem ser obtidos nas outras páginas do registro. Dessa forma, caso queira obter todos os XMLs Proc de inutilizações da empresa, basta realizar iterações, passando por cada página, até que não hajam mais elementos.

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 de consulta de todas inutilizações de uma empresa.

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

Exemplo de retorno

{
  "registros": [
      {
          "ambiente": "Homologação",
          "uf": "GO",
          "ano": 2023,
          "cnpjEmitente": "07385111000102",
          "modelo": 55,
          "serie": 503,
          "numeroInicial": 2,
          "numeroFinal": 6,
          "protocolo": null,
          "justificativa": "Teste de inutilizacao'",
          "dataRecebimento": 1682357080000,
          "conteudo": null,
          "status": "REJ"
      },
      {
          "ambiente": "Homologação",
          "uf": "GO",
          "ano": 2023,
          "cnpjEmitente": "07385111000102",
          "modelo": 55,
          "serie": 503,
          "numeroInicial": 10002,
          "numeroFinal": 10006,
          "protocolo": null,
          "justificativa": "Teste de inutilizacao'",
          "dataRecebimento": 1682357111000,
          "conteudo": null,
          "status": "REJ"
      }
  ]
    "pagina": 1,
    "totalPaginas": 1,
    "numeroTotal": 2,
    "numeroElementos": 2,
    "maximoPorPagina": 20
}  

Pronto! Você acaba de realizar a consulta de uma inutilização.