Mapping
Table of Contents
Classes
- Address
- A postal address. Maps to the UBL <cac:PostalAddress> structure used in
both AccountingSupplierParty and AccountingCustomerParty.
- Attachment
- A binary attachment to be embedded as base64 in the XRechnung XML
(BG-24, EmbeddedDocumentBinaryObject).
- BillingReference
- Reference to a prior invoice. Required on credit notes per BR-DE-22 and on
deposit-cancellation documents. Maps to the UBL <cac:BillingReference>
structure carrying BG-3 / BT-25.
- Contact
- A point-of-contact at a Party. Maps to the UBL <cac:Contact> element.
- DocumentMeta
- Document-level header fields. Maps to the UBL <cbc:ID>, <cbc:IssueDate>,
<cbc:InvoiceTypeCode>, <cbc:DocumentCurrencyCode>, <cbc:DueDate>,
<cbc:BuyerReference>, and <cbc:Note> elements.
- DocumentPeriod
- A delivery / billing period. Maps to UBL <cac:InvoicePeriod> (BG-14 at the
document level, BG-26 at the line-item level).
- DocumentTotals
- Document-level monetary totals. Maps to UBL <cac:LegalMonetaryTotal>
and <cac:TaxTotal>.
- LineItem
- One line on the invoice. Maps to UBL <cac:InvoiceLine>.
- MappingData
- Root of the typed value-object graph that flows from the consumer's mapper
into the generator pipeline. Once constructed, MappingData is structurally
trusted; downstream stages (Builder, Generator, Validator, Writer) do not
re-validate the shape.
- Money
- A monetary amount paired with its ISO 4217 currency.
- Note
- A free-text note attached to the document. Maps to UBL <cbc:Note> (BT-22).
- Party
- A party on the invoice: seller (AccountingSupplierParty) or buyer
(AccountingCustomerParty). One VO covers both roles; the role-aware
named constructors enforce the role-specific invariants:
- PaymentMeans
- One payment-means record. Maps to the UBL <cac:PaymentMeans> structure
(BG-16). The named constructors enforce the per-code invariants:
- TaxBreakdown
- One row of the document-level tax subtotal. Maps to UBL
<cac:TaxSubtotal> inside <cac:TaxTotal>.
- TaxId
- A tax identifier: VAT registration number, local company-registration
number, or other scheme. Maps to the UBL <cac:PartyTaxScheme> structure.
Enums
- PaymentMeansCode
- UNTDID 4461 payment means codes the kit emits at v1.0. Subset chosen by
the architecture (section 5.1) to cover the cases real consumers ship: SEPA
(CT and DD), card payments (credit and bank), cash, and non-SEPA bank
transfers.