PHPackages                             canislupus/api-client-omie - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. canislupus/api-client-omie

ActiveLibrary[API Development](/categories/api)

canislupus/api-client-omie
==========================

Client for Omie ERP API

0.3.0(3w ago)015↓100%MITPHPPHP ^8.0

Since Jul 12Pushed 3w ago1 watchersCompare

[ Source](https://github.com/canis-lupus-solutions/t03-api-client-omie)[ Packagist](https://packagist.org/packages/canislupus/api-client-omie)[ Docs](https://canislupus.com.br)[ RSS](/packages/canislupus-api-client-omie/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (1)Versions (4)Used By (0)

API CLIENT - OMIE
=================

[](#api-client---omie)

Cliente para integração com a API do sistema ERP Omie. [Conheça o Omie](https://www.omie.com.br/sistema-erp)

Instalação
----------

[](#instalação)

### Composer

[](#composer)

```
"canislupus/api-client-omie": "dev-master"

```

Utilização
----------

[](#utilização)

```
use CanisLupus\ApiClients\Omie\v1\OmieApiClient;
use CanisLupus\ApiClients\Omie\v1\OmieApiConfig;

$clientOmie = new OmieApiClient(new OmieApiConfig('#appKey', '#appSecret'));

// A variável $clientOmie agora poderá ser utilizada para chamar os métodos da API

// Exemplo para a API de serviços

// LISTAR SERVIÇOS
// Irá trazer a primeira página de registros de serviços do Omie, permitindo filtros.
$servicos = $clientOmie->servicos->cadastro->listar();

// Há duas formas de filtrar a listagem, usando o objeto ListarServicosRequest.
$request = new ListarServicosRequest();
$request->inativo = 'N';
$servicosFiltrados = $clientOmie->servicos->cadastro->listar($request);

// Ou passando um array
$servicosFiltrados = $clientOmie->servicos->cadastro->listar(['inativo' => 'N']);

// LISTAR TODOS
// Irá trazer todos os serviços do Omie. Também permite os mesmos filtros do método listar.
$servicos = $clientOmie->servicos->cadastro->listarTodos();
$servicosFiltrados = $clientOmie->servicos->cadastro->listarTodos($request);
```

Exemplos
--------

[](#exemplos)

### Ordens de Serviço

[](#ordens-de-serviço)

```
use CanisLupus\ApiClients\Omie\v1\OmieApiClient;
use CanisLupus\ApiClients\Omie\v1\OmieApiConfig;

$clientOmie = new OmieApiClient(new OmieApiConfig('#appKey', '#appSecret'));

// LISTAR
// Irá trazer a primeira página de registros de ordens de serviço do Omie, permitindo filtros.
$ordensDeServico = $clientOmie->servicos->ordens->listar();

// Há duas formas de filtrar a listagem, usando o objeto ListarOrdensRequest
$request = new ListarOrdensRequest();
$request->ordenarPor = 'DATA_LANCAMENTO';
$request->filtrarPorEtapa = '50';
$ordensDeServicoFiltrados = $clientOmie->servicos->ordens->listar($request);

// Ou passando um array
$ordensDeServicoFiltrados = $clientOmie->servicos->ordens->listar([
    'ordenarPor'      => 'DATA_LANCAMENTO',
    'filtrarPorEtapa' => '50',
]);

// LISTAR TODOS
// Irá trazer todos os serviços do Omie. Também permite os mesmos filtros do método listar.
$ordensDeServico = $clientOmie->servicos->ordens->listarTodos();
$ordensDeServicoFiltrados = $clientOmie->servicos->ordens->listarTodos($request);

// INCLUIR
$ordemDeServico = new OrdemOmieModel();
$ordemDeServico->cabecalho->idIntegracao = '2';
$ordemDeServico->cabecalho->etapa = 10;
$ordemDeServico->cabecalho->dataPrevisao = '11/07/2023';
$ordemDeServico->cabecalho->idOmieCliente = '1266115471';
$ordemDeServico->cabecalho->quantidadeParcelas = 1;
$ordemDeServico->cabecalho->codigoParcela = '000';

$ordemDeServico->informacoesAdicionais->codigoCategoria = '1.01.02';
$ordemDeServico->informacoesAdicionais->idOmieContaCorrente = 1266022922;
$ordemDeServico->informacoesAdicionais->dadosAdicionaisNF = 'OS incluída via API';
$ordemDeServico->informacoesAdicionais->cidadeDePrestacaoDoServico = 'JUIZ DE FORA (MG)';

$servico1 = new ServicoPrestadoSubModel();
$servico1->idOmieServico = 2021517985;
$servico1->quantidade = 1;
$servico1->valorUnitario = 11.85;
$servico1->tipoDesconto = 'V';
$servico1->valorDesconto = 0;

$ordemDeServico->servicosPrestados[] = $servico1;

$result = $clientOmie->servicos->ordens->incluir($ordemDeServico);

// EXCLUIR
// Pegaremos uma OS qualquer para testar a exclusão
$ordensDeServico = $clientOmie->servicos->ordens->listarTodos();
$os = $ordensDeServico[0];

// É possível excluir passando 1 dos 3 tipos de identificadores possíveis
// O idOmie, podendo omitir o segundo argumento para este caso
$result = $clientOmie->servicos->ordens->excluir($os->cabecalho->idOmie, 'idOmie');
$result = $clientOmie->servicos->ordens->excluir($os->cabecalho->idOmie);

// idIntegracao ou numeroOs, devendo passar o segundo argumento de acordo
$result = $clientOmie->servicos->ordens->excluir($os->cabecalho->idIntegracao, 'idIntegracao');
$result = $clientOmie->servicos->ordens->excluir($os->cabecalho->numeroOs, 'numeroOs');

// ALTERAR
$os = $clientOmie->servicos->ordens->consultar(118, 'numeroOs');
$os->informacoesAdicionais->dadosAdicionaisNF = "Dados alterados pela API";

$result = $clientOmie->servicos->ordens->alterar($os);

// CONSULTAR
// É possível consultar passando 1 dos 3 tipos de identificadores possíveis
// O idOmie, podendo omitir o segundo argumento para este caso
$result = $clientOmie->servicos->ordens->consultar(2036552875, 'idOmie');
$result = $clientOmie->servicos->ordens->consultar(2036552875);

// idIntegracao ou numeroOs, devendo passar o segundo argumento de acordo
$result = $clientOmie->servicos->ordens->consultar('1222', 'idIntegracao');
$result = $clientOmie->servicos->ordens->consultar(102, 'numeroOs');

// VERIFICAR STATUS
// Há duas formas de verificar o status, passando o objeto VerificarStatusOrdemRequest
$request = new VerificarStatusOrdemRequest('2036552875');
$request->exibirRecibo = true;
$statusOs = $clientOmie->servicos->ordens->verificarStatus($request);

// ou passando um array
$statusOs = $clientOmie->servicos->ordens->verificarStatus([
    'nCodOS' => '2036552875',
    'lRps'   => true,
]);

// TROCAR ETAPA
// Há duas formas de trocar o status, passando o objeto TrocarEtapaOrdemRequest
$request = new TrocarEtapaOrdemRequest('2036552875');
$request->etapa = 30;
$result = $clientOmie->servicos->ordens->trocarEtapa($request);

// ou passando um array
$result = $clientOmie->servicos->ordens->trocarEtapa([
    'nCodOS' => '2036552875',
    'cEtapa'   => 20,
]);
```

Em breve exemplos de utilização aqui.

Abrangência das API's
---------------------

[](#abrangência-das-apis)

 Total de API's 128 Total de API's abrangidas 100% 1 Percentual abrangido 100% 1,28%### Lista de API's

[](#lista-de-apis)

**Grupo****SubGrupo****Recurso****Situação**GeralClientes, Fornecedores, Transportadoras, etc75%GeralClientes - Características0%GeralClientes - Tags75%GeralVendedores0%GeralProjetos0%GeralEmpresas50%GeralDepartamentos0%GeralCategorias0%GeralParcelas0%GeralTipos de Atividade da Empresa0%GeralCidades5%GeralPaíses0%GeralDocumentos Anexos0%GeralTipos de Anexos0%GeralTipo de Entrega0%GeralTipo de Assinante0%GeralFinançasTipos de Documento0%GeralFinançasTipos de Contas Correntes0%GeralFinançasContas Correntes25%GeralFinançasBancos0%GeralFinançasContas do DRE0%GeralFinançasFinalidade de Transferência0%GeralFinançasOrigem de títulos0%GeralFinançasBandeiras de Cartão0%GeralProdutosProdutos25%GeralProdutosProdutos - Características0%GeralProdutosProdutos - Estrutura0%GeralProdutosProdutos - Kit0%GeralProdutosFamilias de Produto0%GeralProdutosUnidades0%GeralProdutosCenário de Impostos50%GeralProdutosCaracterísticas0%GeralProdutosMeios de Pagamento0%GeralProdutosOrigem do Pedido0%GeralProdutosMotivos de Devolução0%CRMContas0%CRMContas - Características0%CRMContatos0%CRMOportunidades0%CRMOportunidades - Resumo0%CRMTarefas0%CRMTarefas - Resumo0%CRMAuxiliaresSoluções0%CRMAuxiliaresFases0%CRMAuxiliaresUsuários0%CRMAuxiliaresStatus0%CRMAuxiliaresMotivos0%CRMAuxiliaresTipos0%CRMAuxiliaresParceiros0%CRMAuxiliaresFinders0%CRMAuxiliaresOrigens0%CRMAuxiliaresConcorrentes0%CRMAuxiliaresVerticais0%CRMAuxiliaresTipos de Tarefas0%FinançasContas Correntes - Lançamentos0%FinançasContas a Pagar - Lançamentos0%FinançasContas a Receber - Lançamentos25%FinançasContas a Receber - Boletos25%FinançasContas a Receber - PIX0%FinançasExtrato de Conta Corrente0%FinançasOrçamento de Caixa0%FinançasPesquisar Títulos0%FinançasMovimentos Financeiros0%FinançasResumo0%ProdutosComprasRequisições de Compra0%ProdutosComprasPedidos de Compra0%ProdutosComprasOrdens de Produção0%ProdutosComprasNota de Entrada0%ProdutosComprasNota de Entrada - Faturamento0%ProdutosComprasRecebimento de Nota Fiscal0%ProdutosComprasResumo0%ProdutosAuxiliaresFormas de Pagamento0%ProdutosAuxiliaresNCM0%ProdutosAuxiliaresEtapas de Faturamento0%ProdutosAuxiliaresTabela de Preços75%ProdutosImpostosCFOP0%ProdutosImpostosCNAE0%ProdutosImpostosICMS - CST0%ProdutosImpostosICMS - CSOSN0%ProdutosImpostosICMS - Origem da Mercadoria0%ProdutosImpostosPIS - CST0%ProdutosImpostosCOFINS - CST0%ProdutosImpostosIPI - CST0%ProdutosImpostosIPI - Enquadramento0%ProdutosImpostosTipo de Cálculo0%ProdutosImpostosCEST0%ProdutosVendaPedidos de Venda - Resumido0%ProdutosVendaPedidos de Venda75%ProdutosVendaPedidos de Venda - Faturamento0%ProdutosVendaPedidos de Venda - Etapas0%ProdutosVendaCT-e / CT-e OS0%ProdutosVendaRemessa de Produtos0%ProdutosVendaRemessa de Produtos - Faturamento0%ProdutosVendaResumo0%ProdutosVendaObter Documentos0%ProdutosCupom FiscalAdicionar0%ProdutosCupom FiscalCancelar ou excluir0%ProdutosCupom FiscalConsultar0%ProdutosCupom FiscalImportar NFC-e0%ProdutosCupom FiscalImportar CFe-Sat0%ProdutosNF-eConsultas0%ProdutosNF-eUtilitários0%ProdutosNF-eImportar0%EstoqueAjustes de Estoque0%EstoqueConsulta Estoque25%EstoqueMovimento Estoque0%EstoqueLocais de Estoque25%EstoqueResumo do Estoque0%EstoqueAuxiliaresCompradores0%EstoqueAuxiliaresProduto x Fornecedor0%ServiçosServiços25%ServiçosOrdens de Serviço100%ServiçosOrdens de Serviço - Faturamento0%ServiçosContratos de Serviço0%ServiçosContratos de Serviço - Faturamento0%ServiçosResumo0%ServiçosObter Documentos0%ServiçosNFS-eConsultas0%ServiçosAuxiliaresServiços no Município0%ServiçosAuxiliaresTipos de Tributação0%ServiçosAuxiliaresLC 1160%ServiçosAuxiliaresNBS0%ServiçosAuxiliaresIBPT0%ServiçosAuxiliaresTipo de Faturamento de Contrato0%ServiçosAuxiliaresTipo de utilização0%ServiçosAuxiliaresClassificação do Serviço0%ContadorDocumentos Fiscais0%ContadorResumo0%Contribua
---------

[](#contribua)

Faça a sua contribuição ao código abrindo um Pull Request.
Ou
Faça uma doação
[![Doe utilizando o PayPal!](https://camo.githubusercontent.com/72d39e9a83e631dcb87984ff89982146d6a1a729079bc8c0827fd42b7fbfe32f/68747470733a2f2f7777772e70617970616c6f626a656374732e636f6d2f6469676974616c6173736574732f632f776562736974652f6d61726b6574696e672f617061632f43322f6c6f676f732d627574746f6e732f6f7074696d697a652f33345f59656c6c6f775f50617950616c5f50696c6c5f427574746f6e2e706e67)](https://www.paypal.com/donate/?hosted_button_id=XHTVXSBCQCL8Y)

Licença
-------

[](#licença)

- MIT License

###  Health Score

39

—

LowBetter than 87% of packages

Maintenance95

Actively maintained with recent releases

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~482 days

Total

3

Last Release

21d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c7e3014c18984d7f01f222a345c0df77a0725278f639c80909aa6e4febb525f0?d=identicon)[leoaguiarpereira@gmail.com](/maintainers/leoaguiarpereira@gmail.com)

---

Top Contributors

[![leoap](https://avatars.githubusercontent.com/u/2475774?v=4)](https://github.com/leoap "leoap (7 commits)")

---

Tags

apiclientERPcanis lupusomie

### Embed Badge

![Health badge](/badges/canislupus-api-client-omie/health.svg)

```
[![Health](https://phpackages.com/badges/canislupus-api-client-omie/health.svg)](https://phpackages.com/packages/canislupus-api-client-omie)
```

###  Alternatives

[jubaer/zoom-laravel

A comprehensive Zoom integration package for Laravel, providing easy-to-use API functionality to interact with the Zoom platform using PHP.

57102.7k](/packages/jubaer-zoom-laravel)[azuracast/php-api-client

An API client library for the AzuraCast API

311.3k](/packages/azuracast-php-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
