getafix 0.1.0__tar.gz

getafix-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

getafix-0.1.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: getafix
+Version: 0.1.0
+Summary: Parse and create ZUGFerD files.
+Author-email: Tammo Ippen <tammo.ippen@posteo.de>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: tagic>=1.5.0
+Requires-Dist: lxml>=6.0.2 ; extra == "cli"
+Requires-Dist: rich>=13.0 ; extra == "cli"
+Requires-Dist: pypdf>=6.12.0 ; extra == "cli"
+Requires-Dist: lxml>=6.0.2 ; extra == "lxml"
+Requires-Dist: pypdf>=6.12.0 ; extra == "pdf"
+Requires-Dist: rich>=13.0 ; extra == "rich"
+Provides-Extra: cli
+Provides-Extra: lxml
+Provides-Extra: pdf
+Provides-Extra: rich
+
+# getafix
+
+[![CI](https://github.com/tammoippen/getafix/actions/workflows/CI.yml/badge.svg)](https://github.com/tammoippen/getafix/actions/workflows/CI.yml)
+[![PyPi version](https://img.shields.io/pypi/v/getafix.svg)](https://pypi.python.org/pypi/getafix)
+[![Downloads](https://pepy.tech/badge/getafix/month)](https://pepy.tech/project/getafix)
+[![PyPi license](https://img.shields.io/pypi/l/getafix.svg)](https://pypi.python.org/pypi/getafix)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+
+Build, parse and validate
+[**ZUGFeRD 2.x / Factur-X**](https://www.ferd-net.de/standards/zugferd)
+Cross-Industry-Invoice (CII) XML in Python. `getafix` provides a fully typed dataclass model for creating and parsed invoices - every field traceable to the EN 16931 business terms (`BT-…`) and groups (`BG-…`). Validation follows a broad, but selective set of business rules (`BR-…`). An accompanied cli tool `getafix` renders and validaes invoices in the terminal.
+
+[![minimum invoice](/imgs/minimum.png)](/imgs/minimum.png)
+
+## Why "getafix"?
+
+> "get a fix" — _get a Factur-X_
+
+The project's working title was `carthorse` - in the spirit of [drafthorse](https://github.com/pretix/python-drafthorse), [pycheval](https://github.com/zfutura/pycheval/tree/main), [mustang](https://github.com/ZUGFeRD/mustangproject), ... - but when I learned, that is already [taken](https://pypi.org/project/carthorse/), I wanted to break free from the horse naming.
+
+Getafix is the village druid in _Asterix_ — the one that brews the magic potion. I only knew the german name `Miraculix` and was hooked. The Gaulish `-ix` ending echoes the `-X` in Factur-**X**, and Factur-X is the French half of the standard: so the French druid it is!
+
+> **Status: pre-1.0.** Solid for the fields that are modelled across
+> MINIMUM / BASIC_WL / BASIC / COMFORT (EN 16931); broad EXTENDED
+> coverage. PDF/A-3 conformance for the host PDF is **out of scope** —
+> `getafix` attaches the embedded `factur-x.xml` but does not
+> upgrade the surrounding PDF to PDF/A-3.
+
+## License and attribution
+
+`getafix` is distributed under the **Apache License 2.0** — see [`LICENSE`](LICENSE).
+
+This project is an application of the **ZUGFeRD / Factur-X** publication issued by the _Forum elektronische Rechnung Deutschland_ (FeRD) at AWV e.V. The format incorporates **EN 16931**, reproduced by FeRD with the permission of **CEN** and **DIN**. _ZUGFeRD_ and _Factur-X_ are trademarks of FeRD / AWV e.V., used here only to identify the standard this library implements.
+
+The vendored test fixtures under [`tests/schemas/`](tests/schemas/) and [`tests/samples/`](tests/samples/) come from third parties and are redistributed under the Apache License 2.0:
+
+- **FeRD / AWV e.V.** — XML schemas, Schematron, and the `*_zf24_*`
+  example invoices from the official ZUGFeRD 2.4 / Factur-X 1.08
+  distribution.
+- **[ZUGFeRD/mustangproject](https://github.com/ZUGFeRD/mustangproject)**
+  — additional reference CII invoices from the Java implementation's
+  test resources.
+- **[ZUGFeRD/corpus](https://github.com/ZUGFeRD/corpus)** —
+  community-curated `XML-Rechnung/CII/` reference invoices.
+
+Original copyright remains with the respective upstream holders; per-file provenance is tracked in [`tests/samples/SOURCES.md`](tests/samples/SOURCES.md).
+
+> **Important:** It is the user's responsibility to ensure that
+> invoices generated or parsed with `getafix` meet all legal and
+> regulatory requirements applicable in their jurisdiction.
+> `getafix` does not guarantee compliance with any specific
+> national or sector-specific e-invoicing mandate.
+
+## Installation
+
+Requires **Python 3.12+**. We recommend [`uv`](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+pip install getafix
+```
+
+The base install lets you build / serialise / validate documents with the Python stdlib XML parser. The optional extras unlock more:
+
+| Extra           | Pulls in                | Enables                                                                                                                                                     |
+| --------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `getafix[lxml]` | `lxml`                  | Round-tripping XML produced by other tools (the stdlib parser is fine for most documents; `lxml` is faster and more tolerant of large / namespaced inputs). |
+| `getafix[pdf]`  | `pypdf`                 | Embedding / extracting `factur-x.xml` in a PDF (`getafix.pdf.attach_xml` and `extract_xml`).                                                                |
+| `getafix[rich]` | `rich`                  | Pretty-print an invoice using the rich library.                                                                                                             |
+| `getafix[cli]`  | `lxml`, `rich`, `pypdf` | The `getafix` console script — pretty-print an invoice and run the BR-\* validators against it.                                                             |
+
+Install several at once:
+
+```bash
+pip install 'getafix[lxml,pdf]'
+```
+
+## Quickstart — build an invoice
+
+```python
+from datetime import date
+from decimal import Decimal
+
+from getafix.schema.document import (
+    Context, Document, GuidelineDocument, Header
+)
+from getafix.schema.accounting import MonetarySummation, TaxTotal
+from getafix.schema.agreement import TradeAgreement
+from getafix.schema.delivery import TradeDelivery
+from getafix.schema.party import (
+    BuyerTradeParty, PostalTradeAddressExtended, SellerTradeParty,
+    SpecifiedTaxRegistration, TaxSchemeId,
+)
+from getafix.schema.settlement import TradeSettlement
+from getafix.schema.trade import Trade
+from getafix.schema.types import Country, Currency, Profile, TypeCode
+
+doc = Document(
+    context=Context(guideline=GuidelineDocument(id=Profile.MINIMUM)),
+    header=Header(
+        id="INV-2025-0001",
+        type_code=TypeCode.T_CommercialInvoice,  # 380
+        issue_date=date(2025, 11, 16),
+    ),
+    trade=Trade(
+        agreement=TradeAgreement(
+            seller=SellerTradeParty(
+                name="Acme GmbH",
+                address=PostalTradeAddressExtended(country_id=Country.DE),
+                tax_registrations=[
+                    SpecifiedTaxRegistration(
+                        id=TaxSchemeId(id="DE123456789", scheme_id="VA"),
+                    ),
+                ],
+            ),
+            buyer=BuyerTradeParty(
+                name="Beta AG",
+                address=PostalTradeAddressExtended(country_id=Country.DE),
+            ),
+        ),
+        delivery=TradeDelivery(),
+        settlement=TradeSettlement(
+            currency_code=Currency.EUR,
+            monetary_summation=MonetarySummation(
+                tax_basis_total=Decimal("100.00"),
+                tax_total=[TaxTotal(amount=Decimal("19.00"), currency_id=Currency.EUR)],
+                grand_total=Decimal("119.00"),
+                due_amount=Decimal("119.00"),
+            ),
+        ),
+    ),
+)
+
+xml = doc.to_xml().render(indent=True)   # str — ready to write to factur-x.xml
+doc.validate()                           # raises ValidationErrors on BR-* failures
+```
+
+`doc.to_xml()` picks the right profile from `Context.guideline.id`. Setting a field that requires a higher profile than the document raises `ProfileMismatch` at render time.
+
+## Quickstart — parse an invoice
+
+From XML bytes or a file:
+
+```python
+import xml.etree.ElementTree as ET
+from getafix.schema.document import Document
+
+tree = ET.parse("factur-x.xml")
+doc = Document.from_xml(tree.getroot())
+
+print(doc.header.id, doc.header.type_code, doc.header.issue_date)
+print(doc.trade.settlement.monetary_summation.grand_total)
+
+doc.validate()   # raises ValidationErrors with every violation
+```
+
+`lxml.etree` works the same way — pass the root element to `Document.from_xml`.
+
+From a Factur-X / ZUGFeRD PDF (`getafix[pdf]` extra):
+
+```python
+import xml.etree.ElementTree as ET
+from getafix.pdf import extract_xml
+from getafix.schema.document import Document
+
+payload = extract_xml(Path("invoice.pdf"))   # bytes or None
+if payload is None:
+    raise SystemExit("No factur-x.xml found in the PDF")
+doc = Document.from_xml(ET.fromstring(payload))
+```
+
+To embed an XML into an existing PDF:
+
+```python
+from pathlib import Path
+from getafix.pdf import attach_xml
+
+attach_xml(Path("invoice.pdf"), Path("factur-x.xml"))   # in-place
+attach_xml(Path("invoice.pdf"), Path("factur-x.xml"),
+           pdf_out=Path("invoice-with-xml.pdf"))
+```
+
+`attach_xml` produces a valid PDF with a generic embedded file; it does **not** upgrade the host PDF to PDF/A-3, which is the formal Factur-X compliance requirement. Pair with a dedicated PDF/A-3 converter for full conformance.
+
+## Validation
+
+```python
+from getafix.schema.element import ValidationErrors
+
+try:
+    doc.validate()
+except ValidationErrors as exc:
+    for err in exc.errors:
+        print(f"{err.code}: {err.message}")
+```
+
+`Document.validate()` walks the document tree once and collects every business-rule violation, raising a single `ValidationErrors` aggregate. Each `ValidationError` carries the rule's code (e.g. `BR-CO-15`) and a human-readable message.
+
+Every rule getafix enforces lives in `getafix.rules` — one module per schema topic (`accounting`, `line`, `party`, `settlement`, `trade`, `extended`), each wired onto the relevant element's `_validators`.
+
+## Command-line tool
+
+The `getafix[cli]` extra ships a console script that pretty-prints an invoice and runs the validators:
+
+```bash
+> getafix path/to/factur-x.xml
+> getafix path/to/invoice.pdf            # reads the embedded XML
+> getafix --no-validate path/to/file.xml # skip BR-* checks
+```
+
+Exit codes:
+
+- `0` — parsed cleanly and passed every validator.
+- `1` — parsed but at least one validation rule fired (or the document could not be parsed as a CII invoice, or no Factur-X XML was found in the supplied PDF).
+- `2` — usage / IO / missing dependency error.
+
+[![comfort invoice](/imgs/comfort.png)](/imgs/comfort.png)
+
+## Profiles
+
+ZUGFeRD / Factur-X defines five conformance profiles, ordered by
+completeness:
+
+| Profile    | URN                                                               | Carries line items       |
+| ---------- | ----------------------------------------------------------------- | ------------------------ |
+| `MINIMUM`  | `urn:factur-x.eu:1p0:minimum`                                     | ✗ (header totals only).  |
+| `BASIC_WL` | `urn:factur-x.eu:1p0:basicwl`                                     | ✗ (basic, without lines) |
+| `BASIC`    | `urn:cen.eu:en16931:2017#compliant#urn:factur-x.eu:1p0:basic`     | ✓                        |
+| `COMFORT`  | `urn:cen.eu:en16931:2017` _(a.k.a. EN 16931)_                     | ✓                        |
+| `EXTENDED` | `urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended` | ✓ + sub-lines            |
+
+The profile is set on the document via `Context(guideline=GuidelineDocument(id=Profile.X))`. Getafix enforces it at render time: setting a field that only exists at a higher profile raises `ProfileMismatch`.
+
+## Status and known gaps
+
+Getafix models every field that the MINIMUM, BASIC_WL, BASIC and EN 16931 (COMFORT) profiles permit. EXTENDED coverage is broad — sub-line hierarchy (`BT-X-7` / `BT-X-8` / `BT-X-304`), bundle composition (`BG-X-1` `IncludedReferencedProduct`), per-instance batch / serial details (`BG-X-84`), logistics service charges (`BG-X-42`), advance payments (`BG-X-45` with `BG-X-46` / `BG-X-85`), the EXTENDED-only deviating parties (sales agent, buyer agent, buyer / item-level seller / tax representative, invoicer, invoicee, payer, product end-user), the penalty / discount payment-term schedules (`BG-X-43` / `BG-X-44`), tax-currency exchange (`BG-X-41`), delivery terms (`BG-X-22`), quotation / ultimate-customer-order references, and the `PEPPOL`-flavoured rule overlay (`BR-FXEXT-*`) are all modelled.
+
+Every shipped sample re-renders **1:1** with its source XML (`tests/test_roundtrip_fidelity.py`) — getafix never silently drops a field it claims to model.
+
+The remaining EXTENDED gaps are optional leaf attributes and line-level twins the shipped samples don't exercise. Each one should be easy to add: declare the `field()` gated at `Profile.EXTENDED`, ensure XSD-sequence order - test will fail otherwise; getafix will accept a PR, or pick one up when there is a need for it:
+
+- **Party extras** — `RoleCode` (`BT-X-483`…`BT-X-575`) on every trade party; additional legal info (`Description`) on the Buyer (`BT-X-334`) and the line-level item seller (`BT-X-571`); contact `TypeCode` (`BT-X-315`…`BT-X-575`) on every `DefinedTradeContact` (BG-6 / BG-9).
+- **Line-level twins of header references** — on `LineTradeAgreement`: delivery terms (`BG-X-87`), contract (`BG-X-2`), seller order (`BG-X-81`), ultimate-customer order (`BG-X-5`); on `LineTradeDelivery`: the actual delivery event / date (`BT-X-85-000`), despatch (`BG-X-13`) and receiving (`BG-X-82`) advice; on `LineTradeSettlement`: the preceding-invoice reference (`BG-X-48`); line-note codes (`BT-X-9` / `BT-X-10`). _(The line-level delivery-note `BG-X-83` and additional-document `BG-X-3` twins **are** modelled.)_
+- **Line monetary totals** — `AllowanceTotalAmount` / `ChargeTotalAmount` / `TaxTotalAmount` / `GrandTotalAmount` (`BT-X-327`…`BT-X-330`); the line total and total-allowance-charge are modelled.
+- **Referenced-document leaves** — `FormattedIssueDateTime` on the header additional / contract references (`BT-X-33-00` / `BT-X-148-00` / `BT-X-149-00`); preceding-invoice `TypeCode` (`BT-X-555`); accounting reference `TypeCode` (`BT-X-99` / `BT-X-290`).
+- **Other shared leaves** — item characteristic `TypeCode` / `ValueMeasure` (`BT-X-11` / `BT-X-12`), invoicing-period `Description` (`BT-X-264`), allowance/charge `SequenceNumeric` / `BasisQuantity` (`BT-X-265` / `BT-X-266`), per-line product local `ID` (`BT-X-305`), net-price `IncludedTradeTax` (`BG-X-4`, B2C VAT in the unit price).
+
+PDF/A-3 packaging is out of scope; use [factur-x](https://github.com/akretion/factur-x), [Mustangproject](https://github.com/ZUGFeRD/mustangproject) or a dedicated converter for full Factur-X PDF conformance.
+
+## Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the developer guide — module layout, how the dataclass model works, how to add a new BT field or BR validator, and the test / lint workflow.
+
+## References
+
+Specification and validators:
+
+- [FeRD net — ZUGFeRD standard](https://www.ferd-net.de/standards/zugferd)
+- [Rechnung Fans — XRechnung / EN 16931 portal](https://portal3.gefeg.com/invoice/tthome/index/617afdc4-623f-44e0-a05b-5b878840e508)
+- [Service BW e-Rechnung Validator](https://erechnungsvalidator.service-bw.de/)
+- [Rechnung.fans validator](https://portal3.gefeg.com/invoice/validation)
+- [Invoice Portal validator](https://validator.invoice-portal.de/index.php)
+