Consultar Base de Conhecimento (BC) via API Rest

A Consulta à Base de Conhecimento 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
Existe apenas um Endpoint para a consulta, e pode ser implementada na aplicação para facilitar na correção de documentos que foram rejeitados.

 

Consultar Base de Conhecimento (GET)

A requisição da Base de conhecimento apresentará como retorno um link, o qual direcionará para a base de conhecimento relacionada à . Muito utilizado antes da emissão de um documento para validar se os interessados nos documentos estão com o cadastro ativo e habilitado, evitando que documentos sejam rejeitados/denegados previamente.

A URL é construída da seguinte forma: 

http:// ou https:// + /endereço da API Rest + /api/base-conhecimento/{codModelo}/{codigoCstat}

 

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

  • {codModelo} : Código do Modelo do documento (55, 57, 65 etc)
  • {codigoCstat} : Sigla da UF da consulta

Exemplo de requisição preenchida:

 

http://rest.oobj-dfe.com.br/api/base-conhecimento/55/434

 

Exemplo de Retorno da Consulta à Base de Conhecimento

 

https://www.oobj.com.br/bc/article/rejei%c3%a7%c3%a3o-434-nf-e-sem-indicativo-do-intermediador-como-resolver-1075.html

 

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

0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Relatórios na API Rest
Visualizado 698 vezes desde 19/08/2021
Emissão de DFes na API Rest
Visualizado 445 vezes desde 13/03/2018
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 295 vezes desde 16/03/2018
Inutilização de Numeração na API Rest
Visualizado 451 vezes desde 16/03/2018
Consulta Cadastro Centralizado de Contribuinte - Consulta Cadastro API Rest
Visualizado 728 vezes desde 14/01/2021
Integração API Rest
Visualizado 606 vezes desde 09/03/2018
Recebimento de Documentos Fiscais via API Rest
Visualizado 598 vezes desde 16/03/2018
Configurar MDe na Api Rest
Visualizado 359 vezes desde 27/09/2018
Geração de chave AC (Assinatura do Contribuinte) para SAT na API Rest
Visualizado 1087 vezes desde 26/12/2019
Configurando Contingência Automática no Monitor da Oobj via API Rest
Visualizado 240 vezes desde 23/08/2021