Invoice generator as a service.
With go CLI:
go build -o faktur .
./faktur
With docker:
docker run \
--name faktur \
-p 8080:8080 \
-d \
docker.pkg.github.com/shellbear/faktur/faktur
Or download binary from the release page.
$ curl --header "Content-Type: application/json" \
--request POST \
--data-binary @data_example.json \
http://localhost:8080/
{
"title": "StoneCrete Flooring - Invoice",
"date": "2023-05-15T12:30:05.371Z",
"due_date": "2023-05-27T12:30:05.371Z",
"currency": "$",
"contractor": {
"logo": "https://type_your_link_here.com",
"business_name": "StoneCrete Inc,",
"phone": "(407)640-2333",
"email": "[email protected]",
"registration_number": "N/A",
"address": {
"address": "7901 4Th St N Ste 300",
"city": "St. Petersburg",
"state": "FL",
"zip_code": "33702"
}
},
"customer": {
"full_name": "Acme Inc,",
"phone": "(689)250-4444",
"email": "[email protected]",
"terms": "NET60",
"address": {
"address": "212 Ronnie St",
"city": "Somewhere",
"state": "FL",
"zip_code": "33233"
},
"amount_paid": "50.00",
"customer_notes": "Payments accepted: wire transfer, check, or credit card."
},
"items": [
{
"item_number": "2005",
"description": "Additional clear urethane top coat",
"rate": 200.41,
"quantity": 1.0,
"tax_rate": 0.07
},
{
"item_number": "4002",
"description": "Epoxy Metallic blue and clear urethane coat",
"rate": 1400.25,
"quantity": 2.0,
"tax_rate": 0.07
}
]
}
Faktur service host address. Defaults to 127.0.0.1
.
Faktur service port. Defaults to 8080
.
The number of workers (used to create invoices). Defaults to 4
.
The folder used to store invoices. Defaults to ./invoices
.
An optional directory which contains additional invoice templates. Empty by default.
The cache folder for wkhtmltopdf. Defaults to /tmp/cache-wk/
.
- Artwork by Ashley McNamara
- Inspired by Renee French
© shellbear, 2020time.Now
© StoneCrete, 2023time.Now
Released under the MIT License.