update README.md

This commit is contained in:
Torsten Ueberschar
2024-09-17 14:09:26 +02:00
parent a6fb080c4f
commit b2a3f37458

View File

@@ -42,8 +42,8 @@ invoice -h
There are two yaml files describing your invoice:
- `invoice.yaml` contains the invoice data
- `envelope.yaml` contains the address data of the sender and the recipient
- [RG004211.yaml](test_data/RG004211.yaml) Contains the invoice data. The filename is takes as the invoice id-number.
- [envelope.yaml](test_data/envelope.yaml) contains the address data of the sender and the recipient
The invoice data is read from the `invoice.yaml` file and the address data is read from the `envelope.yaml` file. The
invoice data is then used to fill in the invoice template and the address data is used to fill in the address fields of
@@ -54,84 +54,11 @@ Some data are globaly available from the envelope template. Some of them can be
invoice.yaml - The Name of the invoice file is used as the invoice number but you are free to override it in the
invoice.yaml file.
```yaml
Id: RG004712 # overrides the file name as invlice Number
CustomerId: KD01234 # The customer id is used to identify the customer and is beeing looked up in the envelope.yaml file.
InvoiceDate: 2023-12-23 # The date of the invoice. If not set the current date is used.
Positions:
- Title: "Zuckerwatte fressen Ganz besonders langer Text"
SubTitle: "Leistungszeitraum: 11/2022"
PricePerUnit: 100 # The price per unit is taken from the envelope.yaml file using the customer id but can be overriden here.
Quantity: 100
- Title: "Aschlecken"
SubTitle: "Leistungszeitraum: 11/2022"
PricePerUnit: 99.99
Quantity: 12
- Title: "Aschkriechen"
SubTitle: "Leistungszeitraum: 10/2022"
PricePerUnit: 77.88
Quantity: 3
```
envelope.yaml
```yaml
AddressContent:
# AddressBoxSender is is used as the sender address in the letter head inside the address windows.
AddressBoxSender: "Abs.: Torsten Ueberschar - Pfarrweg 1 - 57439 Attendorn"
# The Content is a place to put your personal data. E.G. it is used in the footer of the invoice.
# you may put markdown in here.
Contents:
- Text: |
![logo](test_data/templates/images/logo.svg)
Torsten Ueberschar
Pfarrweg 1
57439 Attendorn
- Text: |
**Kontakt**
tu@uesome.de
+49 2734 4239271
- Text: |
**Steuern**
USt-IdNr.: DE313460724
- Text: |
**Bankverbindung**
Torsten Ueberschar
DE67 1001 1001 2626 8627 86
NTSBDEB1XXX
N26 Bank GmbH
# The Invoice field is used to put default values for the invoice. You may override them in the invoice.yaml file.
Invoice:
Vat: 19.0
Introduction: |
### Rechnung
*Sehr geehrte Damen und Herren*,
für folgende in Ihrem Auftrag ausgeführten Leistungen erlaube ich mir zu berechnen
Footer: |
Bitte überweisen Sie den Rechnungsbetrag unter Angabe der Rechnungsnummer auf mein Konto bis zum %%ZahlungsZiel%%.
Mit freundlichen Grüßen
*Torsten Uebeschar*
# Customers is a list of customers. The customer id is used to identify the customer and is beeing looked up in the invoice.yaml file.
Customers:
- CustomerId: KD01234
PricePerUnit: 88.88
DueDate: 30 # DueDate is the number of days the customer has to pay the invoice.
# The AddressField is used to fill in the address field window of the invoice.
AddressField: |
Klaus Peter Klausen
Am Klausenhof 1
04711 Klausenhausen
```
```bash
python src/main.py --help