XRechnung30
extends AbstractProfile
in package
implements
DescribesEmbeddedXml, RequiresVatBreakdownRate, StructuredCashDiscountText, SupportsThirdPartyPayments
XRechnung 3.0 (German CIUS of EN 16931), syntax CII or UBL.
Embedded in a ZUGFeRD PDF it uses the file name xrechnung.xml and the conformance level XRECHNUNG.
Table of Contents
Interfaces
- DescribesEmbeddedXml
- For profiles whose XML is embedded in a PDF/A-3 with other XMP metadata than Factur-X ("Factur-X/ZUGFeRD Invoice", fx:Version "1.0"), e.g. XRechnung in ZUGFeRD.
- RequiresVatBreakdownRate
- Marker for profiles that require the VAT category rate (BT-119) in every VAT breakdown, including category "O" (written as 0). Example: XRechnung (BR-DE-14).
- StructuredCashDiscountText
- Marker for profiles that expect cash discounts as structured lines in BT-20, e.g. XRechnung: "#SKONTO#TAGE=14#PROZENT=2.00#".
- SupportsThirdPartyPayments
- Profiles whose UBL invoices transmit third party payments (BG-DEX-09 of the XRechnung extension) without contradicting BR-CO-16.
Constants
- SPECIFICATION_ID : string = 'urn:cen.eu:en16931:2017#compliant#urn:xeinkauf...
Methods
- 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.
- 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|null
- ConformanceLevel in the Factur-X XMP metadata, null if the profile is XML only.
- 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'
Methods
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|nullisEn16931Compliant()
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()
ConformanceLevel in the Factur-X XMP metadata, null if the profile is XML only.
public
xmpConformanceLevel() : string|null
Return values
string|nullxmpDescription()
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