API reference

Quittio\Core\Data

quittio/core#

Quittio\Core\Data

• IdentifierIdentifier with an optional scheme (ISO/IEC 6523 ICD or another code list depending on the field).
• InvoiceDataRoot of the semantic invoice model (EN 16931, superset of the 2017 and 2026 versions).
• MetaPackage-internal metadata: locale, time zone, exchange rate, free data for templates and flags for country packs.
• NoteInvoice note (BG-1).

Quittio\Core\Data\AllowanceCharge

• DocumentAllowanceDocument level allowance (BG-20). An allowance has exactly one VAT category and rate.
• DocumentAllowanceChargeCommon structure of document level allowances (BG-20) and charges (BG-21).
• DocumentChargeDocument level charge (BG-21).
• LineAllowanceInvoice line allowance (BG-27).
• LineAllowanceChargeCommon structure of invoice line allowances (BG-27) and charges (BG-28). Line allowances and charges have no VAT category of their own; they inherit the line's category.
• LineChargeInvoice line charge (BG-28).

Quittio\Core\Data\Attachments

• AttachmentAdditional supporting document (BG-24).

Quittio\Core\Data\Concerns

• Immutable traitGeneric copy-on-write helper for readonly DTOs whose properties are all promoted constructor parameters.

Quittio\Core\Data\Delivery

• DeliveryDelivery information (BG-13).
• PeriodInvoicing period (BG-14: BT-73, BT-74) or invoice line period (BG-26: BT-134, BT-135). At least one of start or end must be set; the end must not lie before the start.

Quittio\Core\Data\Extensions

• ExtendedDataDocument level data that exists only in the Factur-X/ZUGFeRD EXTENDED profile. The selection covers the practically relevant elements.
• ExtendedPartyAdditional trade party of profile EXTENDED (invoicer, invoicee, ultimate customer, ship-from, line ship-to).
• IncludedProductComponent of a set or bundle (profile EXTENDED).
• InstallmentOne of several payment terms with its own due date (profile EXTENDED), e.g. instalments.
• LineExtendedDataLine level data that exists only in the Factur-X/ZUGFeRD EXTENDED profile.
• ThirdPartyPaymentAmount collected on behalf of a third party (XRechnung extension, group BG-DEX-09). It is added to the amount due (BR-DEX-09).
• XRechnungExtensionDataData of the XRechnung extension. Sub invoice lines are modelled via InvoiceLine::$subLines.

Quittio\Core\Data\Lines

• ClassificationItem classification identifier (BT-158) with scheme (BT-158-1) and scheme version (BT-158-2), e.g. eCl@ss, UNSPSC, CPV or customs tariff numbers.
• InvoiceLineInvoice line (BG-25).
• ItemItem information (BG-31).
• ItemAttributeItem attribute (BG-32), e.g. colour, size, vehicle identification number.
• LineVatLine VAT information (BG-30).
• PricePrice details (BG-29). Prices may have more than two decimals.

Quittio\Core\Data\Party

• AddressPostal address (BG-5 seller, BG-8 buyer, BG-12 tax representative, BG-15 deliver to).
• BuyerPartyBuyer (BG-7).
• ContactContact (BG-6 seller: BT-41/42/43, BG-9 buyer: BT-56/57/58).
• ElectronicAddressElectronic address (BT-34 seller, BT-49 buyer) with its EAS scheme. For Peppol, the electronic address is also the participant identifier.
• PayeePartyPayee (BG-10), only when different from the seller (factoring, collection, group company).
• SellerPartySeller (BG-4).
• TaxRepresentativePartySeller tax representative (BG-11).

Quittio\Core\Data\Payment

• CashDiscountCash discount ("Skonto") granted for payment within $days days.
• CreditTransferCredit transfer (BG-17).
• DirectDebitDirect debit (BG-19).
• PaymentCardPayment card information (BG-18). Only the last 4 to 6 digits of the card number may be stored.
• PaymentInstructionsPayment instructions (BG-16).
• PaymentTermsStructured payment terms. Serialised into BT-20 text (and structured elements where the profile allows).
• PenaltyTermsLate payment terms. Structured only in profile EXTENDED, otherwise rendered as text.

Quittio\Core\Data\Presentation

• ColorsColours used by the PDF template.
• LineGroupGroup of invoice lines with an optional subtotal. Presentation only.
• LinePresentationPDF-only presentation hints for an invoice line. Never written to XML.
• PresentationData used only for the PDF. Never written to XML.

Quittio\Core\Data\References

• DocumentReferenceReference to a related document on line level or as additional reference (profile EXTENDED), e.g. delivery note, order, contract or receiving advice.
• PrecedingInvoiceReferencePreceding invoice reference (BG-3), used for cancellations, corrections and final invoices.
• ProjectReferenceProject reference (BT-11). CII requires a name in addition to the identifier.

Quittio\Core\Data\Totals

• TotalsDocument totals (BG-22), calculated by the calculator.
• VatBreakdownVAT breakdown (BG-23), one entry per combination of VAT category and rate.