As APIs do Omie foram desenvolvidas para oferecer flexibilidade e eficiência na integração de sistemas e automatização de processos, permitindo que você conecte suas soluções diretamente ao Omie.
Após a importação de uma Nota de Entrada no sistema, e antes de recebê-la, é possível ajustar algumas informações conforme necessário.
Aqui, vamos te mostrar o passo a passo para alterar alguns dados de uma Nota de Compra que já foi recebida no Omie, através das nossas APIs.
Preparado para simplificar sua gestão e otimizar seu tempo? Então, vamos lá! 🚀
Informações Importantes sobre as APIs Omie
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
✅ Acessando a documentação: Consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros.
🔑 Chaves de Integração da API: Saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições.
⚙️ Características e Recomendações: Fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie
🔐 Login no Portal: Para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: Aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nosso recursos.
💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Alterando uma Nota de Compra via API
💡 Diversos dados podem ser alterados via API. Neste exemplo, demonstraremos como alterar a situação dos itens da nota, para ignorar os produtos e não movimentar estoque.
1) No Portal do Desenvolvedor, acesse a lista de APIs:
2) Antes de realizar qualquer alteração em uma NF-e de entrada, é necessário ter alguns dados em mãos para enviá-los como parâmetros na requisição.
O primeiro dado necessário é o Código do Recebimento, que pode ser obtido através do método ConsultarRecebimento.
Para isso, basta realizar a seguinte requisição, utilizando a chave de acesso da nota:
{"cChaveNfe": "XXXXXXX"
No retorno da requisição, uma das informações mais importantes está no cabeçalho: a tag "nIdReceb". Esse identificador pode ser utilizado como referência nas requisições futuras, substituindo a chave de acesso e tornando a gestão da nota mais prática dentro do sistema.
2) Então, no tópico "Compras, Estoque e Produção", selecione a opção "Recebimento de Nota Fiscal":
3) Para alterar um Recebimento de NF-e, é preciso utilizar o método AlterarRecebimento:
4) Após selecionar o método AlterarRecebimento, você poderá consultar todos os parâmetros disponíveis (1).
Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo" (2).
💡 Entendendo os parâmetros
💡 Entendendo os parâmetros
Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:
Nome – Identifica a variável dentro da API.
Tipo de dado – Indica o formato esperado (integer, string, decimal, etc.)
Descrição – Explica a finalidade do parâmetro e como utilizá-lo.
Para obter mais detalhes sobre um parâmetro específico, basta passar o mouse sobre o ícone ➕, e uma explicação detalhada será exibida.
5) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
6) Após realizar o login, na tela de testes do Developer, você poderá configurar e enviar requisições para a API. Veja como cada campo funciona:
(1) Endpoint:O Omie preencherá automaticamente este campo com:
🔗
https://app.omie.com.br/api/v1/produtos/recebimentonfe/(2) Aplicativo ou Chave de Acesso: Aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente.
Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: O Omie definirá automaticamente o tipo de chamada como AlterarRecebimento.
(4) Conteúdo – Este é o campo onde você configurará sua requisição, inserindo os dados necessários para alterar o Recebimento.
7) A seguir, demonstramos um exemplo de requisição para alterar uma NF-e de Entrada com dados mínimos:
{
"ide": {
"nIdReceb": 3792012845
},
"itensRecebimentoEditar": [
{
"itensIde": {
"nSequencia": 1,
"cAcao": "IGNORAR"
}
},
{
"itensIde": {
"nSequencia": 2,
"cAcao": "IGNORAR"
}
}
📣 Importante
Ao editar itens de uma nota de recebimento no Omie via API, é fundamental compreender a estrutura correta da requisição, ou seja, a ordem das tags e como utilizá-las corretamente.
1. Tag "ide"
Identifica o recebimento a ser editado.
O parâmetronIdRecebcorresponde ao identificador único do recebimento no sistema.2. Tag "itensRecebimentoEditar"
Trata-se de um array, ou seja, uma lista de itens que serão editados.
Dentro desse array, cada item deve conter a tagitensIde.3. Tag "itensIde"
Identifica cada item na nota de recebimento.
O parâmetronSequenciarepresenta o número de sequência do item dentro da nota.
O parâmetrocAcaodefine a ação a ser realizada no item.
8) Ao executar a requisição com todos os parâmetros corretamente informados, você receberá uma resposta positiva:
{
"nIdReceb": 3792012845,
"cCodStatus": "0",
"cDescStatus": "Recebimento alterado com sucesso!"
}
9) No Omie ERP, os itens do Recebimento de NF-e estarão alterados:
10) Dica Extra: Vamos demonstrar uma requisição exemplo para alterar o CFOP dos itens da nota.
{
"ide": {
"nIdReceb": 5378752907
},
"itensRecebimentoEditar": [
{
"itensIde": {
"nSequencia": 1,
"cAcao": "EDITAR"
},
"itensAjustes": {
"cCFOPEntrada": "1.102"
}
},
{
"itensIde": {
"nSequencia": 2,
"cAcao": "EDITAR"
},
"itensAjustes": {
"cCFOPEntrada": "1.101"
}
}
]
}
📚 Artigos Relacionados
