infolusa/php-facturalusa

PHP Facturalusa é uma biblioteca para ajudar na interacção com o Software de Facturação Online www.facturalusa.pt

Maintainers

Details

github.com/Infolusa/php-facturalusa

Source

Issues

Installs: 185

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 0

Open Issues: 0

pkg:composer/infolusa/php-facturalusa

v2.0.1 2025-05-21 18:35 UTC

Requires

MIT b43ff936b7033f6d933e063c7e3420fcbb42823f

  • Infolusa - Soluções Informáticas <geral.woop@infolusa.pt>

api clientfacturalusasoftware de facturaçãofacturalusa.pt

This package is auto-updated.

Last update: 2025-12-21 19:51:30 UTC

README

SDK PHP para ajudar na integração com o Software de Facturação Grátis www.facturalusa.pt

Visualize a API em https://facturalusa.pt/documentacao/api

Requisitos

  1. PHP >= 7.0
  2. Composer

Instalação

$ composer require infolusa/php-facturalusa

Endpoints

Todos os endpoints listados na documentação oficial estão disponíveis para utilizar neste SDK. Os parâmetros a serem preenchidos no $array devem ser consultados na API.

Exemplo prático

$facturalusa = new \Facturalusa\FacturalusaClient('api_token');
$customer = new \Facturalusa\Customer\Customer($facturalusa);
$customer->create([...]);

print_r($facturalusa->response());

// Outro endpoint chamado
$customer->create(['param1' => 'value1']);
print_r($facturalusa->response());

// Outra forma de chamar
(new \Facturalusa\Customer\Customer($facturalusa))->create(['param1' => 'value1']);

// Também pode ser atribuída a resposta à variável
$response = $customer->create();

Respostas & status

Três funções são disponibilizadas:

  1. $facturalusa->fail() - devolve se o pedido falhou
  2. $facturalusa->success() - devolve se o pedido foi bem executado
  3. $facturalusa->response() - devolve a resposta do pedido, tenha ou não falhado

As respostas diferem de endpoint para endpoint, pelo que deve consultar a documentação em https://facturalusa.pt/documentacao/api para saber que conteúdo é devolvido. Para aceder, por exemplo, ao ID criado basta $facturalusa->response()->id.

Clientes endpoints

Função URL
Customer\Customer->create($array) https://facturalusa.pt/documentacao/api/clientes/criar
Customer\Customer->update($id, $array) https://facturalusa.pt/documentacao/api/clientes/actualizar
Customer\Customer->delete($id) https://facturalusa.pt/documentacao/api/clientes/eliminar
Customer\Customer->find($array) https://facturalusa.pt/documentacao/api/clientes/procurar

Artigos endpoints

Função URL
Item\Item->create($array) https://facturalusa.pt/documentacao/api/artigos/criar
Item\Item->update($id, $array) https://facturalusa.pt/documentacao/api/artigos/actualizar
Item\Item->delete($id) https://facturalusa.pt/documentacao/api/artigos/eliminar
Item\Item->find($array) https://facturalusa.pt/documentacao/api/artigos/procurar

Vendas endpoints

Função URL
Sale\Sale->create($array) https://facturalusa.pt/documentacao/api/vendas/criar
Sale\Sale->update($id, $array) https://facturalusa.pt/documentacao/api/vendas/actualizar
Sale\Sale->delete($id) https://facturalusa.pt/documentacao/api/vendas/eliminar
Sale\Sale->cancel($id, $array) https://facturalusa.pt/documentacao/api/vendas/cancelar
Sale\Sale->duplicate($id, $array) https://facturalusa.pt/documentacao/api/vendas/duplicar
Sale\Sale->creditNote($id) https://facturalusa.pt/documentacao/api/vendas/nota-credito
Sale\Sale->debitNote($id) https://facturalusa.pt/documentacao/api/vendas/nota-debito
Sale\Sale->receipt($id) https://facturalusa.pt/documentacao/api/vendas/recibo
Sale\Sale->download($id, $array) https://facturalusa.pt/documentacao/api/vendas/download
Sale\Sale->sendEmail($id, $array) https://facturalusa.pt/documentacao/api/vendas/enviar-email
Sale\Sale->sendSms($id, $array) https://facturalusa.pt/documentacao/api/vendas/enviar-sms
Sale\Sale->sign($id, $array) https://facturalusa.pt/documentacao/api/vendas/assinar-digitalmente
Sale\Sale->generateMBReference($id) https://facturalusa.pt/documentacao/api/vendas/gerar-ref-multibanco
Sale\Sale->summary($array) https://facturalusa.pt/documentacao/api/vendas/sumario
Sale\Sale->find($array) https://facturalusa.pt/documentacao/api/vendas/procurar

Recibos endpoints

Função URL
Receipt\Receipt->create($array) https://facturalusa.pt/documentacao/api/recibos/criar
Receipt\Receipt->update($id, $array) https://facturalusa.pt/documentacao/api/recibos/actualizar
Receipt\Receipt->delete($id) https://facturalusa.pt/documentacao/api/recibos/eliminar
Receipt\Receipt->cancel($id, $array) https://facturalusa.pt/documentacao/api/recibos/cancelar
Receipt\Receipt->download($id, $array) https://facturalusa.pt/documentacao/api/recibos/download
Receipt\Receipt->sendEmail($id, $array) https://facturalusa.pt/documentacao/api/recibos/enviar-email
Receipt\Receipt->sendSms($id, $array) https://facturalusa.pt/documentacao/api/recibos/enviar-sms
Receipt\Receipt->sign($id, $array) https://facturalusa.pt/documentacao/api/recibos/assinar-digitalmente
Receipt\Receipt->summary($array) https://facturalusa.pt/documentacao/api/recibos/sumario
Receipt\Receipt->find($array) https://facturalusa.pt/documentacao/api/recibos/procurar

Administração endpoints

Função URL
Administration\Category->create($array) https://facturalusa.pt/documentacao/api/administracao-categorias/criar
Administration\Category->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-categorias/actualizar
Administration\Category->delete($id) https://facturalusa.pt/documentacao/api/administracao-categorias/eliminar
Administration\Category->find($array) https://facturalusa.pt/documentacao/api/administracao-categorias/procurar
Administration\Currency->create($array) https://facturalusa.pt/documentacao/api/administracao-moedas/criar
Administration\Currency->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-moedas/actualizar
Administration\Currency->delete($id) https://facturalusa.pt/documentacao/api/administracao-moedas/eliminar
Administration\Currency->find($array) https://facturalusa.pt/documentacao/api/administracao-moedas/procurar
Administration\Employee->create($array) https://facturalusa.pt/documentacao/api/administracao-colaboradores/criar
Administration\Employee->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-colaboradores/actualizar
Administration\Employee->delete($id) https://facturalusa.pt/documentacao/api/administracao-colaboradores/eliminar
Administration\Employee->find($array) https://facturalusa.pt/documentacao/api/administracao-colaboradores/procurar
Administration\Location->create($array) https://facturalusa.pt/documentacao/api/administracao-locais/criar
Administration\Location->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-locais/actualizar
Administration\Location->delete($id) https://facturalusa.pt/documentacao/api/administracao-locais/eliminar
Administration\Location->find($array) https://facturalusa.pt/documentacao/api/administracao-locais/procurar
Administration\PaymentCondition->create($array) https://facturalusa.pt/documentacao/api/administracao-condicoes-pagamento/criar
Administration\PaymentCondition->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-condicoes-pagamento/actualizar
Administration\PaymentCondition->delete($id) https://facturalusa.pt/documentacao/api/administracao-condicoes-pagamento/eliminar
Administration\PaymentCondition->find($array) https://facturalusa.pt/documentacao/api/administracao-condicoes-pagamento/procurar
Administration\PaymentMethod->create($array) https://facturalusa.pt/documentacao/api/administracao-formas-pagamento/criar
Administration\PaymentMethod->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-formas-pagamento/actualizar
Administration\PaymentMethod->delete($id) https://facturalusa.pt/documentacao/api/administracao-formas-pagamento/eliminar
Administration\PaymentMethod->find($array) https://facturalusa.pt/documentacao/api/administracao-formas-pagamento/procurar
Administration\Price->create($array) https://facturalusa.pt/documentacao/api/administracao-precos/criar
Administration\Price->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-precos/actualizar
Administration\Price->delete($id) https://facturalusa.pt/documentacao/api/administracao-precos/eliminar
Administration\Price->find($array) https://facturalusa.pt/documentacao/api/administracao-precos/procurar
Administration\Serie->create($array) https://facturalusa.pt/documentacao/api/administracao-series/criar
Administration\Serie->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-series/actualizar
Administration\Serie->delete($id) https://facturalusa.pt/documentacao/api/administracao-series/eliminar
Administration\Serie->communicate($id) https://facturalusa.pt/documentacao/api/administracao-series/comunicar
Administration\Serie->checkCommunication($id) https://facturalusa.pt/documentacao/api/administracao-series/verificar-comunicacao
Administration\Serie->find($array) https://facturalusa.pt/documentacao/api/administracao-series/procurar
Administration\ShippingMode->create($array) https://facturalusa.pt/documentacao/api/administracao-modos-expedicao/criar
Administration\ShippingMode->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-modos-expedicao/actualizar
Administration\ShippingMode->delete($id) https://facturalusa.pt/documentacao/api/administracao-modos-expedicao/eliminar
Administration\ShippingMode->find($array) https://facturalusa.pt/documentacao/api/administracao-modos-expedicao/procurar
Administration\Unit->create($array) https://facturalusa.pt/documentacao/api/administracao-unidades/criar
Administration\Unit->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-unidades/actualizar
Administration\Unit->delete($id) https://facturalusa.pt/documentacao/api/administracao-unidades/eliminar
Administration\Unit->find($array) https://facturalusa.pt/documentacao/api/administracao-unidades/procurar
Administration\VatRate->create($array) https://facturalusa.pt/documentacao/api/administracao-taxas-iva/criar
Administration\VatRate->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-taxas-iva/actualizar
Administration\VatRate->delete($id) https://facturalusa.pt/documentacao/api/administracao-taxas-iva/eliminar
Administration\VatRate->find($array) https://facturalusa.pt/documentacao/api/administracao-taxas-iva/procurar
Administration\Vehicle->create($array) https://facturalusa.pt/documentacao/api/administracao-veiculos/criar
Administration\Vehicle->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-veiculos/actualizar
Administration\Vehicle->delete($id) https://facturalusa.pt/documentacao/api/administracao-veiculos/eliminar
Administration\Vehicle->find($array) https://facturalusa.pt/documentacao/api/administracao-veiculos/procurar
Administration\Warehouse->create($array) https://facturalusa.pt/documentacao/api/administracao-armazens/criar
Administration\Warehouse->update($id, $array) https://facturalusa.pt/documentacao/api/administracao-armazens/actualizar
Administration\Warehouse->delete($id) https://facturalusa.pt/documentacao/api/administracao-armazens/eliminar
Administration\Warehouse->find($array) https://facturalusa.pt/documentacao/api/administracao-armazens/procurar

Ajuda

Se tiver alguma dúvida ou questão, envie-nos uma mensagem através do formulário de contacto, via Suporte Ticket (dentro da sua subscrição) ou via email para geral@facturalusa.pt

Licença

MIT