XRechnung30Extension
extends XRechnung30
in package
implements
ExtendsCodeLists, SupportsExtensionFields, SupportsSubLines
XRechnung 3.0 extension: adds sub invoice lines (UBL only) and third party payments.
Choose it explicitly with ->profile('xrechnung-extension'): neither the automatic format choice nor the profile xrechnung switch to it when extension data is used; with xrechnung such data is reported as an error.
Table of Contents
Interfaces
- ExtendsCodeLists
- Profiles that accept additional codes on top of the EN 16931 code lists, e.g. the identifier schemes XR01 to XR03 of the XRechnung extension.
- SupportsExtensionFields
- Profiles that transmit the fields of extensions of EN 16931, e.g. "xrechnung" for the fields marked with Mapping\Attributes\XRechnungExtensionOnly.
- SupportsSubLines
- Profiles that transmit sub lines (BG-DEX-01 of the XRechnung extension, the line hierarchy of EXTENDED). Invoices with sub lines are not upgraded to EXTENDED when they use such a profile.
Constants
- SPECIFICATION_ID : string = 'urn:cen.eu:en16931:2017#compliant#urn:xeinkauf...
Methods
- additionalCodes() : array<int, string>
- The extension accepts the identifier schemes XR01 to XR03 (BR-DEX-04 to BR-DEX-08).
- afRelationship() : string|null
- AFRelationship of the embedded XML (Alternative or Data), null if the profile is XML only.
- defaultBusinessProcess() : string|null
- Business process identifier (BT-23) set by default, if any.
- embeddedFilename() : string|null
- File name of the embedded XML in a hybrid PDF, null if the profile is XML only.
- extensions() : array<int, string>
- The fields of the XRechnung extension (Mapping\Attributes\XRechnungExtensionOnly).
- isEn16931Compliant() : bool
- Whether the profile produces an invoice compliant with EN 16931 (MINIMUM and BASIC WL do not).
- key() : string
- Stable key, e.g. "en16931", "extended", "xrechnung", "peppol".
- level() : ProfileLevel
- Factur-X/ZUGFeRD level used for the field matrix.
- name() : string
- Display name, e.g. "EN 16931" or "XRechnung 3.0".
- requiredBusinessTerms() : array<int, string>
- Additional business terms that are mandatory in this profile (on top of EN 16931).
- rules() : array<int, Rule>
- Additional validation rules of the profile.
- specificationId() : string
- Specification identifier written to BT-24.
- supportsStandard() : bool
- supportsSyntax() : bool
- Whether the profile is an XML-only CIUS that is not embedded into PDFs by default.
- syntaxes() : array<int, Syntax>
- xmpConformanceLevel() : string
- ZUGFeRD 2.x names XRechnung documents, also with the extension, "XRECHNUNG".
- xmpDescription() : string
- Description of the embedded file, e.g. "XRechnung Invoice".
- xmpVersion() : string
- The XRechnung version as fx:Version, as ZUGFeRD 2.x prescribes for the level XRECHNUNG.
Constants
SPECIFICATION_ID
public
string
SPECIFICATION_ID
= 'urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0#conformant#urn:xeinkauf.de:kosit:extension:xrechnung_3.0'
Methods
additionalCodes()
The extension accepts the identifier schemes XR01 to XR03 (BR-DEX-04 to BR-DEX-08).
public
additionalCodes(string $codeList) : array<int, string>
Parameters
- $codeList : string
Return values
array<int, string>afRelationship()
AFRelationship of the embedded XML (Alternative or Data), null if the profile is XML only.
public
afRelationship() : string|null
Return values
string|nulldefaultBusinessProcess()
Business process identifier (BT-23) set by default, if any.
public
defaultBusinessProcess() : string|null
Return values
string|nullembeddedFilename()
File name of the embedded XML in a hybrid PDF, null if the profile is XML only.
public
embeddedFilename() : string|null
Return values
string|nullextensions()
The fields of the XRechnung extension (Mapping\Attributes\XRechnungExtensionOnly).
public
extensions() : array<int, string>
Return values
array<int, string>isEn16931Compliant()
Whether the profile produces an invoice compliant with EN 16931 (MINIMUM and BASIC WL do not).
public
isEn16931Compliant() : bool
Return values
boolkey()
Stable key, e.g. "en16931", "extended", "xrechnung", "peppol".
public
key() : string
Return values
stringlevel()
Factur-X/ZUGFeRD level used for the field matrix.
public
level() : ProfileLevel
Return values
ProfileLevelname()
Display name, e.g. "EN 16931" or "XRechnung 3.0".
public
name() : string
Return values
stringrequiredBusinessTerms()
Additional business terms that are mandatory in this profile (on top of EN 16931).
public
requiredBusinessTerms() : array<int, string>
Return values
array<int, string>rules()
Additional validation rules of the profile.
public
rules() : array<int, Rule>
Return values
array<int, Rule>specificationId()
Specification identifier written to BT-24.
public
specificationId([StandardVersion $version = StandardVersion::En16931_2017 ]) : string
Parameters
- $version : StandardVersion = StandardVersion::En16931_2017
Return values
stringsupportsStandard()
public
supportsStandard(StandardVersion $version) : bool
Parameters
- $version : StandardVersion
Return values
boolsupportsSyntax()
Whether the profile is an XML-only CIUS that is not embedded into PDFs by default.
public
supportsSyntax(Syntax $syntax) : bool
Parameters
- $syntax : Syntax
Return values
boolsyntaxes()
public
syntaxes() : array<int, Syntax>
Return values
array<int, Syntax>xmpConformanceLevel()
ZUGFeRD 2.x names XRechnung documents, also with the extension, "XRECHNUNG".
public
xmpConformanceLevel() : string
Return values
stringxmpDescription()
Description of the embedded file, e.g. "XRechnung Invoice".
public
xmpDescription() : string
Return values
stringxmpVersion()
The XRechnung version as fx:Version, as ZUGFeRD 2.x prescribes for the level XRECHNUNG.
public
xmpVersion() : string