API reference

Quittio\Core\Mapping

quittio/core#

Quittio\Core\Mapping

• FieldDefinitionMetadata of one DTO field, read from its mapping attributes.
• FieldMatrixField metadata of all DTOs, derived from the mapping attributes (single source for profile validation, documentation and coverage reports).
• FieldReferenceGenerates docs/field-reference.md from the mapping attributes of the data model.

Quittio\Core\Mapping\Attributes

• BinaryBinary string; arrays and JSON carry it base64 encoded.
• BtBusiness term or business group identifier from EN 16931 (e.g. BT-1, BG-25).
• CardinalityCardinality according to EN 16931: 1, 0..1, 0..n or 1..n.
• CiiLocation of the field in UN/CEFACT CII, relative to the parent element (informative).
• ComputedThe value is set by the calculator and is not a user input.
• ExtendedOnlyThe value exists only in the Factur-X/ZUGFeRD EXTENDED profile.
• InputForMarks a user input that the calculator copies into the given business term.
• InternalPackage-internal value without an EN 16931 business term (not written to XML).
• LevelLowest Factur-X/ZUGFeRD profile level in which the field may be used. Fields without this attribute are available from level EN 16931 on.
• ListOfElement type of an array property, used for hydration and schema generation.
• MapOfValue type of an array property keyed by strings, e.g. line options keyed by line identifier; the hydrator keeps the keys.
• PdfOnlyThe value is used for the PDF only and never written to XML.
• RequiredInProfile keys in which an optional EN 16931 field becomes mandatory (e.g. "xrechnung").
• SinceThe field exists from the given version of EN 16931 on.
• TaxCurrencyMonetary value expressed in the VAT accounting currency (BT-6) instead of the invoice currency.
• UblLocation of the field in UBL 2.1, relative to the parent element (informative).
• UntilThe field exists up to and including the given version of EN 16931.
• XRechnungExtensionOnlyThe value exists only in the XRechnung extension.