Referência
542 operações em 169 serviços. Cada serviço é um endereço; a operação vai em call. OpenAPI · Novidades (selo "novo" por 30 dias).
Autenticação e aplicativos 9Geral 148Finanças 60Produtos 177Serviços 61Estoque 20CRM 56Painel do Contador 11
Por onde começar
O que chamar, em que ordem, e quando assinar um webhook.
Antes de tudo: as tabelas de apoioOs códigos que os cadastros e lançamentos pedem.
- ListarCategoriasas categorias do financeiro
- ListarContasCorrentesas contas correntes (banco e caixa)
- ListarCenariosos cenários de impostos das vendas
- ListarVendedoresos vendedores
Vender produto e emitir NF-eDo cliente à nota, com o pedido no meio.
- UpsertClientecria ou atualiza o cliente pelo seu código
- UpsertProdutocria ou atualiza o produto
- IncluirPedidoo pedido de venda
- FaturarPedidoVendafatura o pedido
- ConsultarNFa nota gerada
- GetUrlDanfeo PDF da nota
Prestar serviço e emitir NFS-eDa ordem de serviço à nota de serviço.
- UpsertClienteo tomador do serviço
- IncluirOSa ordem de serviço
- FaturarOSfatura a OS
- ObterNFSea nota de serviço
Cobrar com contrato recorrenteMensalidade que fatura sozinha.
- IncluirContratoo contrato, com itens e vencimento
- FaturarContratofatura o período
Assine:ContratoServico.Faturado
ReceberDo título ao dinheiro na conta.
- IncluirContaRecebero título a receber
- GerarBoletoo boleto
- GerarPixou o Pix
- LancarRecebimentoa baixa, quando o pagamento vem por fora
PagarContas a pagar e a baixa.
- IncluirContaPagara conta a pagar
- LancarPagamentoa baixa
Acompanhar o estoqueSaldo e ajustes.
- PosicaoEstoqueo saldo de um produto
- ListarPosEstoqueo saldo de todos
- IncluirAjusteEstoqueentrada, saída ou acerto
Assine:Produto.MovimentacaoEstoque
Sincronizar cadastrosUma carga inicial e, depois, só o que mudou.
- ListarClientesa carga inicial, página a página
- ListarProdutosidem para os produtos
- ConsultarClienteo detalhe de quem o webhook avisou
Assine:ClienteFornecedor.IncluidoClienteFornecedor.AlteradoProduto.Alterado
Analisar o financeiroPara BI e conciliação.
- ListarMovimentosos movimentos de pagar, receber e conta corrente
- ListarContasReceberos títulos a receber
- ListarContasPagaros títulos a pagar
Disponível emNo conector oficial do Omie no Claude.No plugin oficial do Omie no ChatGPT.No MCP da Omie, para conectar um cliente próprio (precisa de client ID).
ConsultaAlteração
Autenticação e aplicativos
Antes de chamar as APIs: o token de usuário e o do aplicativo, os aplicativos da pessoa, os usuários, os grupos e os convites.
Aplicativos da pessoa, usuários, grupos de permissão e convites
portal/aplicativosGeral
Cadastros que todos os módulos usam: clientes e fornecedores, produtos, categorias, contas correntes, projetos, vendedores e tabelas auxiliares.
A negativação de clientes é uma funcionalidade que permite registrar pendências...
geral/negativacaoclientesAdicionar anexos as tabelas do sistema
geral/anexoCadastro de características de produto
geral/caracteristicasCadastro de Categorias
geral/categoriasCadastro de contas corrrentes
geral/contacorrenteCadastro de Departamentos
geral/departamentosCadastro de Familias de Produtos
geral/familiasCadastro de parcelas
geral/parcelasCadastro de Produtos
geral/produtosCadastro de Projetos
geral/projetosCadastro de Tipos de Entrega
geral/tiposentregaCadastro de Vendedores
geral/vendedoresCaracterísticas do produto
geral/prodcaractClientes, fornecedores e transportadoras
geral/clientesEstrutura de produtos
geral/malhaImpostos dos produtos
geral/prodimpKIT de produtos
geral/produtoskitManutenção do Cadastro de Características para Clientes ou Fornecedores
geral/clientescaractRealizar operações relacionados aos tipos de tarefa do ERP
geral/tipostarefaTarefas do ERP
geral/tarefasTabelas de apoio
API das configurações de Lote e Validade
geral/lotevalidadeCadastro das Cidades do Omie
geral/cidadesCadastro de DRE
geral/dreCadastro de Empresas
geral/empresasCadastro de Estados
geral/estadosCadastro de meios de pagamento
geral/meiospagamentoCadastro de Países
geral/paisesCadastro de Tipo de Assinante (NF modelo 21 e 22)
geral/tipoassinanteCadastro de Tipos de Anexos
geral/tiposanexoCadastro de tipos de Atividades
geral/tpativCadastro de Unidades de Medidas
geral/unidadeCenários de Impostos
geral/cenariosConsulta de restrição de crédito de clientes
geral/clienterestricaoLista as origens de pedido
geral/origempedidoLista origem de lançamento
geral/origemlancamentoListagem das bandeiras de cartões
geral/bandeiracartaoListar as origens de tarefa do ERP
geral/tarefasorigemListar os períodos de notificação
geral/periodosnotificacaoMotivos de devolução
geral/motivodevolucaoTipo de categoria
geral/tipocategoriaTipos de conta corrente
geral/tipoccFinanças
Contas a pagar e a receber, lançamentos e extrato de conta corrente, boletos, PIX e resumos financeiros.
Anexos do Contas a Pagar
financas/contapagaranexosAnexos do Contas a Receber
financas/contareceberanexosBoletos de contas a receber
financas/contareceberboletoInclusão de um PIX
financas/pixLançamento de Contas a Pagar
financas/contapagarLançamento de Contas a Pagar a partir do código de barras do boleto
financas/contapagar-barrasLançamento de Contas a Receber
financas/contareceberLançamento de contas a receber a partir do código de barras do boleto
financas/contareceber-barrasLançamentos de contas correntes
financas/contacorrentelancamentosResumo das finanças
financas/resumoTabelas de apoio
Listagem do Extrato de Conta Corrente
financas/extratoOperações de consultas de aging (faixas ou carteira)
financas/consultaagingPesquisa titulos de Contas a Pagar e Receber
financas/pesquisartitulosProdutos
Pedidos de venda e de compra, notas fiscais (NF-e, NFC-e, CT-e e cupom), ordens de produção, tabelas de preço e tabelas fiscais.
Adicionar cupons fiscais
produtos/cupomfiscalincluirAnexos do Pedido de Vendas
produtos/pedidovendaanexosCadastro de Cupons Fiscais
produtos/cupomfiscalConsultas de cupom fiscal
produtos/cupomfiscalconsultarCotação, contratação e rastreio de frete
produtos/freteEntrada de produtos
produtos/notaentradaEntrada de produtos - Faturamento
produtos/notaentradafatFaturamento de Devolução de Venda
produtos/devolucaovendafaturamentoGerenciamento de Notas Fiscais Eletrônicas
produtos/nfImportação de CF-e SAT
produtos/satImportação de NFC-e
produtos/nfceOpções de Faturamento de Remessa de Produtos
produtos/remessafatOpções de faturamento do Pedido de Venda
produtos/pedidovendafatOrdem de Produção
produtos/opPedido de venda montado item a item
produtos/pedidovendaPedido de Vendas de Produtos
produtos/pedidoPedidos de Compra
produtos/pedidocompraRecebimento de NF-e de fornecedor
produtos/recebimentonfeRemessa de Produtos
produtos/remessaRequisição de Compras
produtos/requisicaocompraRetorna informações do faturamento de produtos
produtos/dfedocsTabela de Preços
produtos/tabelaprecosUtilitários da Nota Fiscal
produtos/notafiscalutilVariação do produto
produtos/variacaoVínculo de cotação de frete do e-commerce
produtos/frete-ecommerceTabelas de apoio
Cadastros do PDV
produtos/pdvcadastrosClassificações tributárias do IBS e CBS
produtos/classtribCST do IBS e CBS
produtos/icbscstDados da exportação do bloco X
produtos/blocoxEtapas do faturamento
produtos/etapafatEtapas do processo de vendas de produtos
produtos/pedidoetapasFormas de Pagamento de Compras
produtos/formaspagcomprasFormas de Pagamento de Vendas
produtos/formaspagvendasListagem de CFOPs
produtos/cfopListagem de CNAEs
produtos/cnaeListagem de CSOSN do ICMS
produtos/icmscsosnListagem de CST do COFINS
produtos/cofinscstListagem de CST do ICMS
produtos/icmscstListagem de CST do IPI
produtos/ipicstListagem de CST do PIS
produtos/piscstListagem de Enquadramento do IPI
produtos/ipienqListagem de NCM
produtos/ncmListagem de Origem da Mercadoria do ICMS
produtos/icmsorigemListagem de Tipo de Cálculo
produtos/tpcalcListagem do CEST
produtos/cestLotes de produtos
produtos/produtosloteRealiza as consultas na Nota Fiscal
produtos/nfconsultarResumo de compras de produtos
produtos/compras-resumoResumo de vendas de produtos
produtos/vendas-resumoServiços
Ordens de serviço, contratos, NFS-e e o cadastro de serviços.
API Resumida de Ordem de serviço
servicos/ordemservicoCadastro de Serviços
servicos/servicoContrato de Serviço
servicos/contratoFaturamento para Contratos em Lote
servicos/contratoloteFaturamento para Ordens de Serviços em Lote
servicos/osloteGeração de Ordem de Serviço
servicos/osProcessos da Ordem de Serviço
servicos/ospProcessos do fatutamento de Contratos
servicos/contratofatRetorna informações do faturamento de serviços
servicos/osdocsTabelas de apoio
Cadastro de Classificação do Serviço (NF modelo 21 e 22)
servicos/classificacaoservicoCadastro de Tipo de Faturamento de Contrato
servicos/contratotpfatCadastro de Tipos de Utilização do Serviço (NF modelo 21 e 22)
servicos/tipoutilizacaoIndicador de operação
servicos/indoperLista de Serviços no Município
servicos/listaservicoNota Fiscal de Serviços
servicos/nfseResumos dos serviços
servicos/resumoTabela IBPT
servicos/ibptTipo de Tributação do Serviço
servicos/tipotribEstoque
Posição, movimento, ajustes e locais de estoque.
Consulta de Estoque do Omie
estoque/consultaMovimentos de Ajustes de Estoque do Omie
estoque/ajusteReserva de Estoque do Omie
estoque/reservaTabelas de apoio
Cadastro de Compradores
estoque/compradorMovimentação do estoque
estoque/movestoquePosição de estoque do produto
estoque/resumoRelação de Produtos por fornecedor
estoque/produtofornecedorCRM
Contas, contatos, oportunidades e tarefas.
Contas (empresas do CRM)
crm/contasInclusão de oportunidade no CRM
crm/adicionaroportunidadeManutenção do Cadastro de Características das Contas do CRM
crm/contascaractOperações relacionadas a CRM - Contatos
crm/contatosOportunidades
crm/oportunidadesResumo de tarefas
crm/tarefas-resumoTarefas da oportunidade
crm/tarefasTipos de tarefas
crm/tipostarefaTabelas de apoio
Concorrentes da oportunidade
crm/concorrentesFases da Oportunidade
crm/fasesFinders da oportunidade
crm/findersMotivos da Oportunidade
crm/motivosOrigens da oportunidade
crm/origensParceiros e equipes da oportunidade
crm/parceirosResumo de oportunidades
crm/oportunidades-resumoSoluções da Oportunidade
crm/solucoesStatus da oportunidade
crm/statusTipos de oportunidades
crm/tiposVerticais
crm/verticaisPainel do Contador
Resumo e XMLs dos documentos fiscais, para o contador.
Guias de impostos e bloqueio de período
contador/fechamentoLançamentos Contábeis
contador/lancamentoscontabeisPlano de Contas Contábeis
contador/planocontabilTabelas de apoio
Configurações de Categorias x Plano Contábeis
contador/configplanocategListagem de Layouts Contábeis
contador/layoutcontabilListagem de Plano de Contas
contador/planocontasResumo do Painel do contador
contador/resumo