Inutilização de Numeração na API Rest

A Emissão / Envio de Inutilizações através da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token. Existem alguns Endpoints para o serviço Registro de Inutilizações de Numeração e para cada um, há uma URL específica.

Autorização / Envio de Inutilizações (POST)

Nesse Endpoint é possível o registrar uma Inutilização para um único número ou para uma faixa numérica.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/inutilizacoes/{ambiente}/{codModelo}/{uf}/{ano}/{serie}?numInicial={NumeroInicial}&numFinal={NumeroFinal}&justificativa={Justificativa}

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

• {empresa} : CNPJ da Empresa
• {ambiente} : hom ou prod
• {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
• {uf} : Estado Emissor
• {ano} : Ano de Emissão no formado AAAA
• {serie} : Série do DFe
• {NumeroInicial} : Número Inicial da Inutilização
• {NumeroFinal} : Número Final da Inutilização
• {Justificativa} : Texto de no mínimo 15 caracteres para Justificar a Inutilização

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/inutilizacoes/hom/55/RS/2018/502?numInicial=100002&numFinal=100003&justificativa=Teste%20de%20Inutilizacao

Obter retorno de uma Inutilização (GET)

É possível obter os detalhes de uma Inutilização após a emissão / envio. É obtido através desse Endpoint o XML Proc da Inutilização.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/inutilizacoes/{ambiente}/{codModelo}/{uf}/{ano}/{serie}/{numero}

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

• {empresa} : CNPJ da Empresa
• {ambiente} : hom ou prod
• {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
• {uf} : Estado Emissor
• {ano} : Ano de Emissão no formado AAAA
• {serie} : Série do DFe
• {numero} : Número inutilizado

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/inutilizacoes/hom/55/RS/2018/502/100002

Obter todas as Inutilizações de Numeração (GET)

O XML Proc é de uma Inutilização com Assinatura Digital, que é idêntico ao armazenado na Sefaz, deve ser guardado pelo contribuinte por no mínimo 5 anos.

Nesse Endpoint, é possível obter o XML Proc de uma Inutilização. Sempre que esse serviço for utilizado será retornado as Inutilizações registradas / emitidas pela empresa informada na URL de forma paginada com 20 elementos (XML Proc de Inutilização), ou seja, ao realizar o primeiro acesso a esse Endpoint, você poderá informar a página que deseja consultar na URL, ou poderá deixar em branco, assim virá a primeira página.

Na resposta da sua consulta nesse serviço, será informado no final a quantidade de itens que há na página, e qual o Total de itens que pode ser obtidos em todas as outras páginas. Dessa forma, basta realizar uma iteração, passando por cada página até que não hajam mais elementos, caso queira obter todos os XML's Proc de Inutilização da sua empresa.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/docs/inutilizacoes/{ambiente}/{codModelo}/{uf}?pagina={numPagina}&comXml={true ou false}

• {empresa} : CNPJ da Empresa
• {ambiente} : hom ou prod
• {codModelo} : 55, 57, 58 ou 65 (respectivamente, NFe, CTe, MDFe ou NFCe)
• {uf} : Estado Emissor
• {numeroPagina} : numero da pagina (Opcional. Se não informado, o valor 1 é assumido como padrão)
• {comXml} : true ou false (Opcional. Se não informado, o valor false é assumido como padrão) 

Exemplo com os parâmetros opcionais preenchidos:

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/inutilizacoes/hom/55/RS/2018?pagina=1&comXml=true

Exemplo sem os parâmetros opcionais preenchidos:

http://rest.oobj-dfe.com.br/api/empresas/07385111000102/docs/inutilizacoes/hom/55/RS/2018

Existe também uma requisição para gerar os relatórios dos documentos que foram inutilizado dentro de um determinado período. Para mais informações acesse o artigo Relatórios na API Rest 

Para realizar testes com a API Rest, e ter mais detalhes sobre a Inutilização de Numerações, acesse a documentação completa através do link: http://rest.oobj-dfe.com.br/swagger-ui.html#/Inutilizacao