escolalms/fakturownia-integration

Escola Headless LMS Fakturownia Integration

0.3.10 2023-04-25 10:49 UTC

README

Package for generate Fakturownia Integration from order

swagger codecov Tests PHPUnit in environments Maintainability Test Coverage downloads downloads downloads

What does it do

This package is used to add invoices to Fakturownia after catch dispatched event EscolaLms\Cart\Events\OrderPaid.

EscolaLms/Invoices package defined routing to generate PDF invoice on the same path. The two packages cannot run in parallel.

Installing

  • composer require escolalms/fakturownia-integration
  • php artisan migrate
  • Create file .env and set to your account in Fakturownia
FAKTUROWNIA_HOST=
FAKTUROWNIA_TOKEN=

Database

Add table fakturownia_orders and relation to table order from packed escolalms/cart

Endpoints

All the endpoints are defined in swagger

Tests

Run ./vendor/bin/phpunit to run tests. See tests folder as it's quite good staring point as documentation appendix.

Test details codecov Tests PHPUnit in environments

Events

This package does not dispatch any events.

Listeners

  • ImportInvoiceListener catch EscolaLms\Cart\Events\OrderPaid => add invoice to Fakturownia

Permissions

The package uses the cart_order_list permission from the Cart package. All permissions are defined in Cart package seeder