API Omie: guia prático de integração para automação contábil e gestão de despesas

A API Omie é o mecanismo que permite conectar o ERP Omie a sistemas externos — automatizando lançamentos, sincronizando despesas e eliminando a digitação manual entre plataformas. Para times financeiros que usam o Omie como sistema de gestão, entender como essa integração funciona é o primeiro passo para fechar o mês sem retrabalho.

A demanda por integração com o Omie cresce junto com o volume de operações das empresas. Mais de 1.000 buscas mensais por "omie api" e "api omie" refletem uma necessidade real: equipes de TI e finanças que precisam conectar sistemas de despesas, cartões corporativos, ERPs auxiliares e ferramentas de BI ao núcleo contábil da empresa.

Este guia cobre o que você precisa saber para usar a API do Omie com eficiência — desde autenticação e endpoints disponíveis até casos de uso práticos para gestão de despesas corporativas. Se você usa ou avalia o Omie como ERP principal, leia até o final.

O que é a API do Omie e como ela funciona

A API do Omie é uma interface de programação aberta que permite a comunicação entre o ERP Omie e sistemas externos via protocolo HTTP. Ela suporta dois formatos principais: SOAP (com XML) e JSON (via objeto WebSocket-like). Na prática, a grande maioria das integrações modernas usa JSON por ser mais leve e compatível com linguagens contemporâneas.

O modelo de comunicação é cliente-servidor: o sistema externo envia uma requisição (request) para um endpoint específico do Omie, e o servidor retorna uma resposta (response) com os dados solicitados ou a confirmação da operação executada. Cada operação — cadastrar um cliente, lançar uma conta a pagar, consultar categorias — corresponde a um método específico dentro de um módulo da omie api.

Estrutura básica de uma requisição

Toda requisição para a API do Omie segue um padrão consistente. Você envia um objeto JSON para o endpoint do módulo desejado, informando:

• app_key: identificador público do aplicativo Omie
• app_secret: chave secreta do aplicativo (equivalente a uma senha)
• call: nome do método a ser executado (ex: ListarCategorias)
• param: array com os parâmetros específicos da operação

O endpoint base para a maioria das APIs segue o padrão https://app.omie.com.br/api/v1/[módulo]/[serviço]/. Por exemplo, para acessar o módulo financeiro de contas a pagar, o endpoint é https://app.omie.com.br/api/v1/financas/contapagar/.

Tipos de APIs disponíveis no Omie

O Omie organiza suas APIs por módulos funcionais. Os principais grupos relevantes para gestão financeira e de despesas incluem:

• Geral: cadastro de clientes, fornecedores, categorias, contas correntes, departamentos
• Finanças: contas a pagar, contas a receber, lançamentos, baixas
• Produtos e NF-e: importação de notas fiscais, movimentação de estoque
• Serviços: ordens de serviço, contratos, faturamento em lote
• Vendas: pedidos, orçamentos, faturamento

Para times de finanças corporativas, os módulos de maior interesse são Finanças e Geral — especialmente os endpoints de categorias, centros de custo (departamentos) e contas a pagar, que são os pilares de qualquer integração de despesas com o Omie.

Como obter credenciais e autenticar na API Omie

Antes de fazer qualquer requisição, você precisa de um aplicativo Omie com credenciais válidas. O Omie usa autenticação por App Key e App Secret — não há OAuth ou token JWT. Cada aplicativo tem suas próprias credenciais, e é recomendável criar aplicativos separados para produção e testes.

Passo a passo para obter as credenciais

1. Acesse o Portal do Desenvolvedor em developer.omie.com.br
2. Faça login com as mesmas credenciais do ERP Omie
3. Acesse "Meus Aplicativos" e crie um novo aplicativo (gratuito)
4. Copie o App Key e o App Secret gerados
5. Use essas credenciais em todas as requisições à omie api

Uma boa prática é criar um aplicativo exclusivo para testes (sandbox) antes de apontar para o ambiente de produção. O Omie não cobra por aplicativos adicionais, então não há custo para manter ambientes separados.

Limites de consumo da API (rate limits)

A omie api tem limites de consumo que você precisa respeitar para evitar erros de throttling:

• Paginação: máximo de 100 registros por página em listagens
• Requisições por minuto: limite definido por aplicativo; consulte a documentação oficial para o valor atual
• Campos obrigatórios: cada método tem parâmetros obrigatórios — requisições incompletas retornam erro imediatamente

Para integrações de alto volume — como sincronização diária de centenas de lançamentos de despesas — implemente paginação corretamente e adicione delays entre requisições para não estourar o rate limit.

Principais endpoints da API Omie para gestão de despesas corporativas

Se o objetivo da integração é automatizar o fluxo de despesas corporativas no Omie, os endpoints mais relevantes são os do módulo financeiro e os cadastros de suporte. Veja os que fazem mais diferença na prática:

Categorias e centros de custo

Antes de lançar qualquer despesa, você precisa que o sistema externo conheça as categorias e departamentos cadastrados no Omie. Use os métodos ListarCategorias e ListarDepartamentos para sincronizar essa estrutura.

• Endpoint de categorias: https://app.omie.com.br/api/v1/geral/categorias/
• Endpoint de departamentos: https://app.omie.com.br/api/v1/geral/departamentos/
• Método de criação: IncluirCategoria / IncluirDepartamento

Manter categorias e centros de custo sincronizados é a base da integração contábil entre o sistema de despesas e o Omie — garantindo que os lançamentos cheguem na conta correta sem ajuste manual posterior.

Contas a pagar: criação e baixa via API

O módulo de contas a pagar é central para qualquer integração de despesas. Através da omie api, você consegue:

• Criar lançamentos com IncluirContaPagar
• Consultar o status com ListarContasPagar
• Registrar pagamento com LancarPagamento
• Cancelar lançamentos com ExcluirContaPagar

Para despesas de cartão corporativo ou reembolsos, o fluxo típico é: criar o lançamento como conta a pagar → associar à categoria e centro de custo corretos → registrar a baixa quando o pagamento for confirmado. Esse ciclo, quando automatizado, elimina toda a digitação manual que o time contábil faria ao final do mês.

Webhooks: sincronização em tempo real

Além das chamadas ativas (pull), a API do Omie suporta webhooks — notificações que o Omie envia automaticamente para o seu servidor quando eventos ocorrem no ERP. Isso é útil para manter sistemas externos sincronizados sem precisar consultar a API periodicamente.

Exemplos de eventos que podem disparar webhooks:

• Inclusão ou alteração de conta a pagar
• Baixa de lançamento financeiro
• Inclusão de novo cliente ou fornecedor
• Emissão de NF-e

Para times de finanças que precisam de visibilidade em tempo real sobre o que entra no ERP, configurar webhooks reduz a latência entre a execução da despesa e o registro contábil — o que impacta diretamente a qualidade do fechamento mensal.

Quer ver na prática como despesas corporativas são sincronizadas automaticamente com o Omie, sem código e sem planilha?Agende uma demonstração da Payfy e veja o fluxo completo em funcionamento.

Como testar a API Omie antes de ir para produção

O Omie oferece um ambiente de testes integrado ao Portal do Desenvolvedor. Você pode testar qualquer método diretamente pelo browser, sem precisar configurar Postman ou escrever código. Isso acelera o processo de validação antes de implementar a integração.

Usando o portal do desenvolvedor para testes

1. Acesse developer.omie.com.br e faça login
2. Clique em "Lista das API's" para ver todos os módulos disponíveis
3. Selecione o módulo e o método desejado
4. Clique em "Teste agora mesmo" — a interface de teste abre com o endpoint preenchido
5. Selecione o aplicativo (ou insira App Key e App Secret manualmente)
6. Ajuste o conteúdo da requisição conforme necessário
7. Clique em "Executar" e analise o retorno no painel direito

O resultado da requisição mostra o status HTTP, o cabeçalho da resposta e o corpo com os dados retornados. Se houver erro, o Omie retorna um código de status e uma descrição — o que facilita o diagnóstico sem precisar de ferramentas externas.

{{banner-despesas}}

Ferramentas externas para testes mais avançados

Para integrações mais complexas, as ferramentas mais usadas com a omie api são:

• Postman: ideal para criar coleções de requisições e testar fluxos completos
• Insomnia: alternativa ao Postman, mais leve e com interface limpa
• ThunderClient: extensão do VS Code para quem prefere não sair do editor
• cURL: o portal do Omie converte automaticamente qualquer requisição para cURL, facilitando testes via terminal

O repositório oficial github.com/omiexperience/api-examples traz exemplos de código em Delphi, .NET, PHP e Node.js — útil como ponto de partida para quem está começando a integração.

Erros comuns na integração com a API Omie e como resolver

Quem já integrou sistemas com o Omie sabe que alguns erros aparecem com frequência. Conhecê-los antecipadamente economiza horas de debugging.

Tabela de erros frequentes

Os erros mais comuns retornados pela omie api são:

• Código 500 — App Key ou App Secret inválido: verifique se as credenciais estão corretas e se o aplicativo está ativo no portal
• Código 500 — Parâmetro obrigatório não informado: consulte a documentação do método e verifique todos os campos marcados como obrigatórios
• Código 500 — Registro duplicado: a API do Omie não permite duplicatas em campos únicos — use o código de integração externo (codigo_lancamento_integracao) para identificar registros já enviados
• Paginação incompleta: ao listar registros, sempre verifique o campo total_de_paginas no retorno e itere até a última página
• Rate limit excedido: implemente retry com backoff exponencial para requisições que retornam erro de limite

Uma prática importante: sempre registre o código de integração externo nos lançamentos criados via API. Isso permite identificar registros já sincronizados e evitar duplicatas em caso de reenvio.

Como a Payfy usa a API Omie para automatizar despesas corporativas

A Payfy tem integração direta com o Omie — e é exatamente a API Omie que viabiliza essa conexão. Na prática, quando um colaborador usa o cartão corporativo da Payfy ou solicita um reembolso, os dados da despesa são automaticamente enviados ao Omie sem qualquer intervenção manual do time financeiro.

O fluxo funciona assim:

1. A despesa é realizada e registrada na plataforma Payfy (cartão, PIX ou reembolso)
2. A IA da Payfy lê o comprovante via OCR, extrai os dados (valor, CNPJ, data, categoria) e valida a despesa contra a política da empresa
3. A despesa categorizada é enviada automaticamente ao Omie via API, com centro de custo, categoria contábil e código de integração corretos
4. O lançamento aparece no módulo financeiro do Omie pronto para conciliação automática — sem digitação manual

O resultado mensurável: fechamento mensal até 4x mais rápido, conciliação de 100% dos comprovantes e eliminação do retrabalho de lançamento manual no ERP. Para empresas com múltiplos centros de custo e alto volume de pequenas despesas, essa automação representa horas de trabalho recuperadas por mês.

Além da sincronização de despesas, a Payfy usa a omie api para manter categorias e departamentos sincronizados em tempo real — garantindo que qualquer nova estrutura criada no Omie seja automaticamente refletida nas políticas de aprovação da plataforma de despesas.

FAQ — Perguntas frequentes sobre a API Omie

A API do Omie é gratuita?

Sim. O acesso à API do Omie é gratuito para clientes do ERP. Não há cobrança adicional por chamadas de API ou por criar aplicativos no portal do desenvolvedor. Os limites de consumo existem para garantir estabilidade, mas não implicam custo.

Posso integrar um sistema de gestão de despesas ao Omie via API?

Sim. Plataformas como a Payfy fazem exatamente isso — usam a API do Omie para sincronizar despesas, categorias e lançamentos contábeis automaticamente. A integração elimina a necessidade de exportar planilhas ou digitar lançamentos manualmente no ERP.

Quanto tempo leva para integrar um sistema ao Omie?

Depende da complexidade. Uma integração customizada desenvolvida internamente pode levar semanas, considerando autenticação, mapeamento de endpoints, tratamento de erros e testes. Soluções pré-integradas como a Payfy funcionam em horas — sem necessidade de desenvolvimento.

A API Omie suporta webhooks?

Sim. O Omie oferece webhooks que notificam seu servidor em tempo real quando eventos ocorrem no ERP — como inclusão de lançamentos, baixas financeiras ou alterações de cadastro. Isso permite manter sistemas externos sincronizados sem precisar consultar a API periodicamente.

Quais linguagens de programação posso usar para consumir a API Omie?

Qualquer linguagem que suporte requisições HTTP com JSON ou SOAP. O repositório oficial do Omie no GitHub traz exemplos prontos em PHP, .NET (C#), Delphi e Node.js. Ferramentas como Postman e Insomnia permitem testar sem escrever código.

Conclusão

A API Omie é uma ferramenta poderosa para qualquer empresa que usa o Omie como ERP e quer alcançar a automação contábil de lançamentos e conciliação. Entender como funciona a autenticação, quais endpoints usar para despesas e como estruturar as requisições é o que separa uma integração robusta de uma solução frágil que quebra no primeiro volume maior de dados.

Para times financeiros que não querem — ou não têm recursos para — desenvolver essa integração internamente, a Payfy entrega a conexão com o Omie pronta, com categorização automática por IA, validação de política em tempo real e fechamento mensal até 4x mais rápido. Sem código, sem planilha, sem retrabalho.

Agende uma demonstração gratuita da Payfy e veja como a integração com o Omie funciona na prática — do primeiro lançamento ao fechamento do mês.