Passar para o conteúdo principal

Cadastrando uma Conta a Pagar via API

Nesse artigo, descubra como cadastrar uma Conta a Pagar no Omie ERP, via API.

Diego Pancera avatar
Escrito por Diego Pancera
Atualizado há mais de 2 semanas

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.

Aqui, vamos te mostrar o passo a passo para cadastrar as suas Contas a Pagar através das nossas APIs.

Preparado para simplificar sua gestão e otimizar seu tempo? Então, vamos lá! 🚀

Tópicos do Artigo:

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;

  • ⚙️ 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

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.

Antes de realizar a inclusão de uma Conta a Pagar via API, é importante já ter em mãos alguns dados necessário para enviar como parâmetros na requisição.

Você precisará das seguintes informações:

Cadastrando uma Conta a Pagar via API

1) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:

2) No Portal do Desenvolvedor, acesse no canto superior da tela a opção "Lista de APIs":

3) Em nossa listagem de APIs, localize tópico "Finanças" e selecione a opção "Contas a Pagar - Lançamentos":

4) Para cadastrar uma Conta a Pagar, é preciso utilizar o método IncluirContaPagar no canto direito da tela:

5) Após selecionar o método IncluirContaPagar, 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

Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:

  • 1) Nome. Identifica a variável dentro da API;

  • 2) Tipo de conteúdo. Indica o formato esperado (integer, string, decimal, etc.);

  • 3) Descrição. Explica a finalidade do parâmetro e como utilizá-lo;

  • 4) Detalhes. Para obter mais informações sobre um parâmetro específico, basta passar o mouse sobre o ícone ➕.

6) Após realizar o login, você será direcionado para a tela de testes do Developer, onde 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/financas/contarpagar/

  • (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;

    💡Lista de Aplicativos

    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 "IncluirContaPagar";

  • (4) Conteúdo. Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar a Conta a Pagar.

    ⚠️ Data de Vencimento ou Previsão

    Para facilitar a visualização no momento do preenchimento do campo, as datas exibidas começam com os últimos 5 anos a partir da data atual.

    Porém, após realizar a inclusão via API, você poderá alterar a Conta Pagar para uma data anterior a este período.

7) A seguir, demonstramos um exemplo de requisição para cadastro de uma Conta a Pagar com dados mínimos:

{
  "codigo_lancamento_integracao": "1740589558",
  "codigo_cliente_fornecedor": 3795260786,
  "data_vencimento": "26/02/2025",
  "valor_documento": 100,
  "codigo_categoria": "2.04.01",
  "data_previsao": "26/02/2025",
  "id_conta_corrente": 3731356020
}

⚠️ Importante

  • O codigo_cliente_fornecedor, codigo_categoria e id_conta_corrente poderão ser consultados conforme em "Dicas" no começo do artigo.
    ​

  • O parâmetro "codigo_lancamento_integracao" é utilizado exclusivamente para integrações via API, por isso, ele não será demonstrado no ERP.

8) Ao executar a requisição com todos os parâmetros corretamente informados, você receberá uma resposta positiva contendo o código da Conta a Pagar cadastrada.

Esse identificador, retornado na tag “codigo_lancamento_omie”, é fundamental, pois serve como referência para consultas e para a realização de operações via API.

 {
  "codigo_lancamento_omie": 3846660524,
  "codigo_lancamento_integracao": "1740589558",
  "codigo_status": "0",
  "descricao_status": "Lançamento cadastrado com sucesso!"
}

9) No Omie ERP, a Conta a Pagar estará cadastrada:

📚 Artigos Relacionados

Respondeu à sua pergunta?