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
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 2781 vezes desde 16/03/2018
Emissão de DFes na API Rest
Visualizado 3936 vezes desde 13/03/2018
Relatórios na API Rest
Visualizado 685 vezes desde 19/08/2021
Inutilização de Numeração na API Rest
Visualizado 2552 vezes desde 16/03/2018
Recebimento de Documentos Fiscais via API Rest
Visualizado 5207 vezes desde 16/03/2018
Consultar MDF-e não encerrado via API Rest
Visualizado 454 vezes desde 23/08/2021
Consulta Cadastro Centralizado de Contribuinte - Consulta Cadastro API Rest
Visualizado 1152 vezes desde 14/01/2021
Autenticação na API Rest
Visualizado 9777 vezes desde 09/03/2018
Emissão de Eventos Fiscais na API Rest
Visualizado 2659 vezes desde 16/03/2018
Configurar MDe na Api Rest
Visualizado 1425 vezes desde 27/09/2018
Comentários
Nome
Email
Código de Segurança Security Code
Não há comentários para este artigo. Seja o primeiro a postar um comentário.