API reference / Quittio \ Core \ Profiles

Profile

interface in quittio/core

Quittio\Core\Profiles\Profile · Source

An e-invoice profile (CIUS or extension): which fields are allowed or mandatory, which identifier goes into BT-24 and which additional rules apply.

Methods#

Method	Description
`->afRelationship()`	AFRelationship of the embedded XML (Alternative or Data), null if the profile is XML only.
`->defaultBusinessProcess()`	Business process identifier (BT-23) set by default, if any.
`->embeddedFilename()`	File name of the embedded XML in a hybrid PDF, null if the profile is XML only.
`->isEn16931Compliant()`	Whether the profile produces an invoice compliant with EN 16931 (MINIMUM and BASIC WL do not).
`->key()`	Stable key, e.g. "en16931", "extended", "xrechnung", "peppol".
`->level()`	Factur-X/ZUGFeRD level used for the field matrix.
`->name()`	Display name, e.g. "EN 16931" or "XRechnung 3.0".
`->requiredBusinessTerms()`	Additional business terms that are mandatory in this profile (on top of EN 16931).
`->rules()`	Additional validation rules of the profile.
`->specificationId()`	Specification identifier written to BT-24.
`->supportsStandard()`
`->syntaxes()`
`->xmpConformanceLevel()`	ConformanceLevel in the Factur-X XMP metadata, null if the profile is XML only.

`afRelationship()`#

public function afRelationship(): ?string

AFRelationship of the embedded XML (Alternative or Data), null if the profile is XML only.

Returns: ?string

`defaultBusinessProcess()`#

public function defaultBusinessProcess(): ?string

Business process identifier (BT-23) set by default, if any.

Returns: ?string

`embeddedFilename()`#

public function embeddedFilename(): ?string

File name of the embedded XML in a hybrid PDF, null if the profile is XML only.

Returns: ?string

`isEn16931Compliant()`#

public function isEn16931Compliant(): bool

Whether the profile produces an invoice compliant with EN 16931 (MINIMUM and BASIC WL do not).

Returns: bool

`key()`#

public function key(): string

Stable key, e.g. "en16931", "extended", "xrechnung", "peppol".

Returns: string

`level()`#

public function level(): ProfileLevel

Factur-X/ZUGFeRD level used for the field matrix.

Returns: ProfileLevel

`name()`#

public function name(): string

Display name, e.g. "EN 16931" or "XRechnung 3.0".

Returns: string

`requiredBusinessTerms()`#

public function requiredBusinessTerms(): list<string>

Additional business terms that are mandatory in this profile (on top of EN 16931).

Returns: list<string>

`rules()`#

public function rules(): list<Rule>

Additional validation rules of the profile.

Returns: list<Rule>

`specificationId()`#

public function specificationId(
    StandardVersion $version = \Quittio\Core\Standards\StandardVersion::En16931_2017,
): string

Specification identifier written to BT-24.

Parameter	Type	Description
`$version`	`StandardVersion` = `\Quittio\Core\Standards\StandardVersion::En16931_2017`

Returns: string

`supportsStandard()`#

public function supportsStandard(StandardVersion $version): bool

Parameter	Type	Description
`$version`	`StandardVersion`

Returns: bool

`syntaxes()`#

public function syntaxes(): list<Syntax>

Returns: list<Syntax>

`xmpConformanceLevel()`#

public function xmpConformanceLevel(): ?string

ConformanceLevel in the Factur-X XMP metadata, null if the profile is XML only.

Returns: ?string

Profile

Methods#

afRelationship()#

defaultBusinessProcess()#

embeddedFilename()#

isEn16931Compliant()#

key()#

level()#

name()#

requiredBusinessTerms()#

rules()#

specificationId()#

supportsStandard()#

syntaxes()#

xmpConformanceLevel()#