A integração com o Omie conecta a Aira ao seu ERP para sincronizar faturas, contratos, pagamentos e documentos fiscais automaticamente.
O que é sincronizado
| Dados | Direção | Descrição |
|---|
| Faturas | Aira → Omie | Faturas emitidas são enviadas como ordens de serviço no Omie |
| Contratos | Aira ↔ Omie | Contratos sincronizados bidirecionalmente com número de contrato do Omie |
| Pagamentos | Omie → Aira | Confirmações de pagamento (baixas) atualizam o status na Aira |
| Boletos | Omie → Aira | Boletos gerados no Omie são armazenados e disponibilizados na Aira |
| NFSe | Omie → Aira | Notas fiscais emitidas no Omie são sincronizadas de volta para a Aira |
Webhooks recebidos do Omie
A Aira recebe webhooks do Omie para manter os dados sincronizados. Os tópicos suportados são:
| Tópico Omie | O que acontece na Aira |
|---|
Financas.ContaReceber.BaixaRealizada | Status do pagamento atualizado para Pago |
Financas.ContaReceber.Alterado | Pagamento criado ou atualizado |
Financas.ContaReceber.BoletoGerado | Arquivo do boleto armazenado |
Financas.ContaReceber.BoletoCancelado | Boleto removido |
ContratoServico.Alterado | Número do contrato atualizado |
NFSe.NotaAutorizada | Documento fiscal criado e armazenado |
OrdemServico.Faturada | Ciclo de cobrança sincronizado |
appKey + appHash presentes no payload do webhook. Payloads com credenciais inválidas são rejeitados.
O Omie também envia payloads de ping ({ "ping": "omie" }) para verificar a disponibilidade do endpoint — a Aira responde com {"message":"pong"}.
Para ambientes que não são produção, use o mesmo caminho (/v1/webhooks/omie) e altere apenas o host.
Configuração
Habilitar a integração
- No Dashboard da Aira, acesse Configurações → Integrações
- Ative a integração Omie
- Informe as credenciais (
app_key e app_secret da sua conta Omie)
Configurar webhooks no Omie
- Acesse o Portal de Desenvolvedor do Omie
- Clique em Adicionar novo webhook
- Informe a URL do endpoint da Aira:
https://api.useaira.com/v1/webhooks/omie
- Selecione todos os tópicos suportados (listados acima)
- Salve a configuração
Módulos de sincronização
Após habilitar, configure quais módulos deseja ativar:
- Sincronização de pagamentos — receber confirmações de pagamento do Omie
- Sincronização de documentos fiscais — receber NFSe emitidas pelo Omie
Mapeamento de serviços
Para que as faturas sejam criadas corretamente no Omie, configure o mapeamento entre entidades da Aira e serviços do Omie:
- Por produto — cada produto da Aira é mapeado para um serviço do Omie
- Por recurso — cada recurso é mapeado individualmente
- Por valor mínimo da fatura — itens de franquia mínima mapeados separadamente
O mapeamento é feito na aba de Mapeamentos dentro das configurações da integração Omie.
Próximos passos
