Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escolalms/invoices
Allows to generate Invoices with laraveldaily/laravel-invoices package and Wellms Events
https://github.com/escolalms/invoices
api invoice laravel
Last synced: 4 days ago
JSON representation
Allows to generate Invoices with laraveldaily/laravel-invoices package and Wellms Events
- Host: GitHub
- URL: https://github.com/escolalms/invoices
- Owner: EscolaLMS
- License: mit
- Created: 2022-02-09T14:11:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T05:44:24.000Z (4 months ago)
- Last Synced: 2024-10-13T17:29:38.015Z (about 1 month ago)
- Topics: api, invoice, laravel
- Language: PHP
- Homepage:
- Size: 13.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Invoices
Package for generate pdf invoice from order
[](https://escolalms.github.io/Invoices/)
[](https://codecov.io/gh/EscolaLMS/Invoices)
[](https://github.com/EscolaLMS/Invoices/actions/workflows/test.yml)
[](https://codeclimate.com/github/EscolaLMS/Invoices/maintainability)
[](https://codeclimate.com/github/EscolaLMS/Invoices/test_coverage)
[](https://packagist.org/packages/escolalms/invoices)
[](https://packagist.org/packages/escolalms/invoices)
[](https://packagist.org/packages/escolalms/invoices)
## What does it do
This package is adapter for EscolaLMS to create pdf invoice by [laraveldaily/laravel-invoices](https://github.com/LaravelDaily/laravel-invoices)
## Installing
- `composer require escolalms/invoices`
## Config
``` php
return [
'date' => [
/*
* Carbon date format
*/
'format' => 'd-m-Y',
/*
* Due date for payment since invoice's date.
*/
'pay_until_days' => 7,
],
'serial_number' => [
'series' => 'AA',
'sequence' => 1,
/*
* Sequence will be padded accordingly, for ex. 00001
*/
'sequence_padding' => 5,
'delimiter' => '.',
/*
* Supported tags {SERIES}, {DELIMITER}, {SEQUENCE}
* Example: AA.00001
*/
'format' => '{SERIES}{DELIMITER}{SEQUENCE}',
],
'currency' => [
'code' => 'PLN',
/*
* Usually cents
* Used when spelling out the amount and if your currency has decimals.
*
* Example: Amount in words: Eight hundred fifty thousand sixty-eight EUR and fifteen ct.
*/
'fraction' => 'gr',
'symbol' => 'zł',
/*
* Example: 19.00
*/
'decimals' => 2,
/*
* Example: 1.99
*/
'decimal_point' => ',',
/*
* By default empty.
* Example: 1,999.00
*/
'thousands_separator' => ' ',
/*
* Supported tags {VALUE}, {SYMBOL}, {CODE}
* Example: 1.99 €
*/
'format' => '{VALUE} {SYMBOL}',
],
'paper' => [
// A4 = 210 mm x 297 mm = 595 pt x 842 pt
'size' => 'a4',
'orientation' => 'portrait',
],
'disk' => 'local',
'logo' => 'vendor/invoices/sample-logo.png',
'seller' => [
/*
* Class used in templates via $invoice->seller
*
* Must implement LaravelDaily\Invoices\Contracts\PartyContract
* or extend LaravelDaily\Invoices\Classes\Party
*/
'class' => \LaravelDaily\Invoices\Classes\Seller::class,
/*
* Default attributes for Seller::class
*/
'attributes' => [
'name' => 'Escola',
'address' => 'Chłodna 22A, 00-891 Warszawa',
'code' => '00-891',
'vat' => '123456789',
'phone' => '123456789',
'custom_fields' => [
/*
* Custom attributes for Seller::class
*
* Used to display additional info on Seller section in invoice
* attribute => value
*/
'SWIFT' => 'BANK101',
],
],
],
];
```
## Example or Tutorial
## Endpoints
[](https://escolalms.github.io/Invoices/)
## Tests
Run `./vendor/bin/phpunit` to run tests. See [tests](https://github.com/EscolaLMS/Invoices/tree/main/tests) folder as it's quite good staring point as documentation appendix.
Test details [](https://codecov.io/gh/EscolaLMS/Invoices) [](https://github.com/EscolaLMS/Invoices/actions/workflows/test.yml)
## Events
This package does not dispatch any events.
## Listeners
This package does not listen for any events.
## Permissions
This package does not define new permissions but uses the `cart_order_list` permission from the [Cart](https://github.com/EscolaLMS/Cart) package.