omie-api-node v1.0.5

Omie Node Api

Trying to encapsulate omie ERP API in a more easy to use interface with promises.

How to use

Instantiate the Omie class with your appKey and appSecret

const Omie = require('omie-node-api');
const appSecret = 'YOUR_APP_SECRET';
const appKey = 'YOUR_APP_KEY';
const OmieClient = new Omie({ appSecret, appKey });

Endpoints registration

You can register all endpoints by doing

OmieClient.registerAll();

or just register the ones you need by passing their endpoints in an Array

OmieClient.registerEndpoints(['geral/clientes', 'geral/paises']);

Calling the API

After instantiating and registering all or some endpoints, you can call the API like this.

/**
 * Calling the api when endpoint = 'geral/clientes'
 *
 * @param {Object} payload request payload
 * @param {(Object|undefined)} headers Extra headers (optional)
 **/
OmieClient.geral.clientes
  .IncluirCliente(payload, headers)
  .then((body) => {
    // do something
  })
  .catch((err) => {
    // fail and do something
  });

Visit the docs or check /resources/resources.json to check which methods are available for each endpoint.

Valid endpoints

geral/clientetag -> Ver Documentaçao
geral/clientes -> Ver Documentaçao
geral/projetos -> Ver Documentaçao
geral/empresas -> Ver Documentaçao
geral/departamentos -> Ver Documentaçao
geral/categorias -> Ver Documentaçao
geral/parcelas -> Ver Documentaçao
geral/tpativ -> Ver Documentaçao
geral/cidades -> Ver Documentaçao
geral/paises -> Ver Documentaçao
geral/contacorrente -> Ver Documentaçao
geral/bancos -> Ver Documentaçao
geral/tiposdoc -> Ver Documentaçao
geral/tipocc -> Ver Documentaçao
geral/dre -> Ver Documentaçao
geral/produtos -> Ver Documentaçao
geral/prodcaract -> Ver Documentaçao
geral/malha -> Ver Documentaçao
geral/familias -> Ver Documentaçao
geral/unidade -> Ver Documentaçao
geral/cenarios -> Ver Documentaçao
geral/vendedores -> Ver Documentaçao
geral/caracteristicas -> Ver Documentaçao
geral/meiospagamento -> Ver Documentaçao
produtos/cnae -> Ver Documentaçao
produtos/requisicaocompra -> Ver Documentaçao
produtos/pedidocompra -> Ver Documentaçao
produtos/op -> Ver Documentaçao
produtos/formaspagcompras -> Ver Documentaçao
produtos/ncm -> Ver Documentaçao
produtos/cfop -> Ver Documentaçao
produtos/icmscst -> Ver Documentaçao
produtos/icmscsosn -> Ver Documentaçao
produtos/icmsorigem -> Ver Documentaçao
produtos/piscst -> Ver Documentaçao
produtos/cofinscst -> Ver Documentaçao
produtos/ipicst -> Ver Documentaçao
produtos/ipienq -> Ver Documentaçao
produtos/tpcalc -> Ver Documentaçao
produtos/cest -> Ver Documentaçao
produtos/pedido -> Ver Documentaçao
produtos/pedidovendaanexos -> Ver Documentaçao
produtos/pedidovendafat -> Ver Documentaçao
produtos/pedidoetapas -> Ver Documentaçao
produtos/cte -> Ver Documentaçao
produtos/remessa -> Ver Documentaçao
produtos/cupomfiscalincluir -> Ver Documentaçao
produtos/cupomfiscal -> Ver Documentaçao
produtos/formaspagvendas -> Ver Documentaçao
produtos/tabelaprecos -> Ver Documentaçao
produtos/etapafat -> Ver Documentaçao
produtos/nfconsultar -> Ver Documentaçao
produtos/notafiscalutil -> Ver Documentaçao
crm/contas -> Ver Documentaçao
crm/contatos -> Ver Documentaçao
crm/oportunidades -> Ver Documentaçao
crm/tarefas -> Ver Documentaçao
crm/solucoes -> Ver Documentaçao
crm/fases -> Ver Documentaçao
crm/usuarios -> Ver Documentaçao
crm/status -> Ver Documentaçao
crm/motivos -> Ver Documentaçao
crm/tipos -> Ver Documentaçao
crm/parceiros -> Ver Documentaçao
crm/finders -> Ver Documentaçao
crm/origens -> Ver Documentaçao
crm/concorrentes -> Ver Documentaçao
crm/verticais -> Ver Documentaçao
financas/contapagar -> Ver Documentaçao
financas/contareceber -> Ver Documentaçao
financas/contacorrentelancamentos -> Ver Documentaçao
financas/extrato -> Ver Documentaçao
financas/caixa -> Ver Documentaçao
financas/pesquisartitulos -> Ver Documentaçao
financas/mf -> Ver Documentaçao
financas/contapagaranexos -> Ver Documentaçao
financas/contareceberanexos -> Ver Documentaçao
estoque/comprador -> Ver Documentaçao
estoque/produtofornecedor -> Ver Documentaçao
estoque/ajuste -> Ver Documentaçao
estoque/consulta -> Ver Documentaçao
estoque/movestoque -> Ver Documentaçao
servicos/servico -> Ver Documentaçao
servicos/osp -> Ver Documentaçao
servicos/os -> Ver Documentaçao
servicos/nfse -> Ver Documentaçao
servicos/listaservico -> Ver Documentaçao
servicos/contrato -> Ver Documentaçao
servicos/tipotrib -> Ver Documentaçao
servicos/lc116 -> Ver Documentaçao
servicos/nbs -> Ver Documentaçao
servicos/ibpt -> Ver Documentaçao
servicos/contratotpfat -> Ver Documentaçao
contador/xml -> Ver Documentaçao

This is not an official module

Still under development