-
Notifications
You must be signed in to change notification settings - Fork 40
Class ZugferdDocumentReader
Class representing the document reader for incoming XML-Documents with
XML data in BASIC-, EN16931- and EXTENDED profile
Guess the profile type of a xml file
public static function readAndGuessFromFile(string $xmlFilename): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| xmlFilename | string | ❌ |
Returns a value of type \ZugferdDocumentReader
Guess the profile type of the readden xml document
public static function readAndGuessFromContent(string $xmlContent): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| xmlContent | string | ❌ | The XML content as a string to read the invoice data from |
Returns a value of type \ZugferdDocumentReader
Set the directory where the attached binary data from
additional referenced documents are temporary stored
public function setBinaryDataDirectory(string $binaryDataDirectory): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| binaryDataDirectory | string | ❌ |
Returns a value of type \ZugferdDocumentReader
Read general information about the document
public function getDocumentInformation(
?string $documentNo,
?string $documentTypeCode,
?DateTime $documentDate,
?string $invoiceCurrency,
?string $taxCurrency,
?string $documentName,
?string $documentLanguage,
?DateTime $effectiveSpecifiedPeriod,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| documentNo | string | ✔️ | BT-1, From MINIMUM The document no issued by the seller |
| documentTypeCode | string | ✔️ | BT-3, From MINIMUM The type of the document, See \horstoeko\codelists\ZugferdInvoiceType for details |
| documentDate | DateTime | ✔️ | BT-2, From MINIMUM Date of invoice. The date when the document was issued by the seller |
| invoiceCurrency | string | ✔️ | BT-5, From MINIMUM Code for the invoice currency |
| taxCurrency | string | ✔️ | BT-6, From BASIC WL Code for the currency of the VAT entry |
| documentName | string | ✔️ | BT-X-2, From EXTENDED Document Type. The documenttype (free text) |
| documentLanguage | string | ✔️ | BT-X-4, From EXTENDED Language indicator. The language code in which the document was written |
| effectiveSpecifiedPeriod | DateTime | ✔️ | BT-X-6-000, From EXTENDED The contractual due date of the invoice |
Returns a value of type \ZugferdDocumentReader
Read general payment information
public function getDocumentGeneralPaymentInformation(
?string $creditorReferenceID,
?string $paymentReference,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| creditorReferenceID | string | ✔️ | BT-90, From BASIC WL Identifier of the creditor |
| paymentReference | string | ✔️ | BT-83, From BASIC WL Intended use for payment |
Returns a value of type \ZugferdDocumentReader
Read copy indicator
public function getIsDocumentCopy(?bool $copyIndicator): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| copyIndicator | bool | ✔️ | BT-X-3-00, BT-X-3, From EXTENDED Returns true if this document is a copy from the original document |
Returns a value of type \ZugferdDocumentReader
Read a test document indicator
public function getIsTestDocument(?bool $testDocumentIndicator): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| testDocumentIndicator | bool | ✔️ | Returns true if this document is only for test purposes |
Returns a value of type \ZugferdDocumentReader
Read Document money summation
public function getDocumentSummation(
?float $grandTotalAmount,
?float $duePayableAmount,
?float $lineTotalAmount,
?float $chargeTotalAmount,
?float $allowanceTotalAmount,
?float $taxBasisTotalAmount,
?float $taxTotalAmount,
?float $roundingAmount,
?float $totalPrepaidAmount,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| grandTotalAmount | float | ✔️ | BT-112, From MINIMUM Total invoice amount including sales tax |
| duePayableAmount | float | ✔️ | BT-115, From MINIMUM Payment amount due |
| lineTotalAmount | float | ✔️ | BT-106, From BASIC WL Sum of the net amounts of all invoice items |
| chargeTotalAmount | float | ✔️ | BT-108, From BASIC WL Sum of the surcharges at document level |
| allowanceTotalAmount | float | ✔️ | BT-107, From BASIC WL Sum of the discounts at document level |
| taxBasisTotalAmount | float | ✔️ | BT-109, From MINIMUM Total invoice amount excluding sales tax |
| taxTotalAmount | float | ✔️ | BT-110/111, From MINIMUM/BASIC WL if BT-6 is not null $taxTotalAmount = BT-111. Total amount of the invoice sales tax, Total tax amount in the booking currency |
| roundingAmount | float | ✔️ | BT-114, From EN 16931 Rounding amount |
| totalPrepaidAmount | float | ✔️ | BT-113, From BASIC WL Prepayment amount |
Returns a value of type \ZugferdDocumentReader
Retrieve document notes
public function getDocumentNotes(?array $notes): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| notes | array | ✔️ | BT-22, From BASIC WL, BT-X-5, From EXTENDED, BT-21, From BASIC WL Returns an array with all document notes. Each array element contains an assiociative array containing the following keys: contentcode, subjectcode and content |
Returns a value of type \ZugferdDocumentReader
Get the identifier assigned by the buyer and used for internal routing.
Note: The reference is specified by the buyer (e.g. contact details, department, office ID, project code),
but stated by the seller on the invoice.
Note: The route ID must be specified in the Buyer Reference (BT-10) in the XRechnung. According to the XRechnung
standard, two syntaxes are permitted for displaying electronic invoices: Universal Business Language (UBL) and UN/CEFACT
Cross Industry Invoice (CII).
public function getDocumentBuyerReference(?string $buyerReference): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| buyerReference | string | ✔️ | BT-10, From MINIMUM An identifier assigned by the buyer and used for internal routing |
Returns a value of type \ZugferdDocumentReader
Get detailed information about the seller (=service provider)
public function getDocumentSeller(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-27, From MINIMUM The full formal name under which the seller is registered in the National Register of Legal Entities, Taxable Person or otherwise acting as person(s) |
| id | array | ✔️ | BT-29, From BASIC WL An array of identifiers of the seller. In many systems, seller identification is key information. Multiple seller IDs can be assigned or specified. They can be differentiated by using different identification schemes. If no scheme is given, it should be known to the buyer and seller, e.g. a previously exchanged, buyer-assigned identifier of the seller |
| description | string | ✔️ | BT-33, From EN 16931 Further legal information that is relevant for the seller |
Returns a value of type \ZugferdDocumentReader
Get global identifiers of the seller.
public function getDocumentSellerGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-29/BT-29-0/BT-29-1, From BASIC WL Array of the sellers global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the seller's tax information.
public function getDocumentSellerTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-31/32, From MINIMUM/EN 16931_ Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get the address of seller trade party
public function getDocumentSellerAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-35, From BASIC WL The main line in the sellers address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-36, From BASIC WL Line 2 of the seller's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-162, From BASIC WL Line 3 of the seller's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-38, From BASIC WL Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-37, From BASIC WL Usual name of the city or municipality in which the seller's address is located |
| country | string | ✔️ | BT-40, From MINIMUM Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-39, From BASIC WL The sellers state |
Returns a value of type \ZugferdDocumentReader
Get the legal organisation of seller trade party
public function getDocumentSellerLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-30, From MINIMUM An identifier issued by an official registrar that identifies the seller as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer and seller |
| legalOrgType | string | ✔️ | BT-30-1, From MINIMUM The identifier for the identification scheme of the legal registration of the seller. If the identification scheme is used, it must be selected from ISO/IEC 6523 list |
| legalOrgName | string | ✔️ | BT-28, From BASIC WL A name by which the seller is known, if different from the seller's name (also known as the company name). Note: This may be used if different from the seller's name. |
Returns a value of type \ZugferdDocumentReader
Seek to the first seller contact of the document. Returns true if a first seller contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentSellerContact
public function firstDocumentSellerContact(): bool
{
}Returns a value of type bool
Seek to the next available seller contact of the document. Returns true if another seller contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentSellerContact
public function nextDocumentSellerContact(): bool
{
}Returns a value of type bool
Get detailed information on the seller's contact person
public function getDocumentSellerContact(
?string $contactPersonname,
?string $contactDepartmentname,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonname | string | ✔️ | BT-41, From EN 16931 Such as personal name, name of contact person or department or office |
| contactDepartmentname | string | ✔️ | BT-41-0, From EN 16931 If a contact person is specified, either the name or the department must be transmitted. |
| contactPhoneNo | string | ✔️ | BT-42, From EN 16931 A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-107, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-43, From EN 16931 An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the seller's electronic communication information
public function getDocumentSellerCommunication(?string $uriScheme, ?string $uri): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| uriScheme | string | ✔️ | BT-34-1, From BASIC WL The identifier for the identification scheme of the seller's electronic address |
| uri | string | ✔️ | BT-34, From BASIC WL Specifies the electronic address of the seller to which the response to the invoice can be sent at application level |
Returns a value of type \ZugferdDocumentReader
Get detailed information about the buyer (service recipient)
public function getDocumentBuyer(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-44, From MINIMUM The full name of the buyer |
| id | array | ✔️ | BT-46, From BASIC WL An identifier of the buyer. In many systems, buyer identification is key information. Multiple buyer IDs can be assigned or specified. They can be differentiated by using different identification schemes. If no scheme is given, it should be known to the buyer and buyer, e.g. a previously exchanged, seller-assigned identifier of the buyer |
| description | string | ✔️ | BT-X-334, From EXTENDED Further legal information about the buyer |
Returns a value of type \ZugferdDocumentReader
Get global identifiers of the buyer.
public function getDocumentBuyerGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-46-0, BT-46-1, From BASIC WL Array of the buyers global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the buyer's tax information.
public function getDocumentBuyerTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-48, From MINIMUM/EN 16931_ Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get the address of buyer trade party
public function getDocumentBuyerAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-50, From BASIC WL The main line in the buyers address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-51, From BASIC WL Line 2 of the buyers address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-163, From BASIC WL Line 3 of the buyers address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-53, From BASIC WL Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-52, From BASIC WL Usual name of the city or municipality in which the buyers address is located |
| country | string | ✔️ | BT-55, From BASIC WL Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-54, From BASIC WL The buyers state |
Returns a value of type \ZugferdDocumentReader
Get the legal organisation of buyer trade party
public function getDocumentBuyerLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-47, From MINIMUM An identifier issued by an official registrar that identifies the buyer as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer and buyer |
| legalOrgType | string | ✔️ | BT-47-1, From MINIMUM The identifier for the identification scheme of the legal registration of the buyer. If the identification scheme is used, it must be selected from ISO/IEC 6523 list |
| legalOrgName | string | ✔️ | BT-45, From EN 16931 A name by which the buyer is known, if different from the buyers name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first buyer contact of the document. Returns true if a first buyer contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentBuyerContact
public function firstDocumentBuyerContact(): bool
{
}Returns a value of type bool
Seek to the next available Buyer contact of the document. Returns true if another Buyer contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentBuyerContact
public function nextDocumentBuyerContact(): bool
{
}Returns a value of type bool
Get contact information of buyer trade party
public function getDocumentBuyerContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-56, From EN 16931 Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-56-0, From EN 16931 Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-57, From EN 16931 A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-115, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-58, From EN 16931 An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the seller's electronic communication information
public function getDocumentBuyerCommunication(?string $uriScheme, ?string $uri): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| uriScheme | string | ✔️ | BT-49-1, From BASIC WL The identifier for the identification scheme of the buyer's electronic address |
| uri | string | ✔️ | BT-49, From BASIC WL Specifies the buyer's electronic address to which the invoice is sent |
Returns a value of type \ZugferdDocumentReader
Get detailed information about the seller's tax agent
public function getDocumentSellerTaxRepresentative(
?string $name,
?array $id,
?string $description,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-62, From BASIC WL The full name of the seller's tax agent |
| id | array | ✔️ | BT-X-116, From EXTENDED An array of identifiers of the sellers tax agent. |
| description | string | ✔️ | Further legal information that is relevant for the sellers tax agent |
Returns a value of type \ZugferdDocumentReader
Get document seller tax agent global ids
public function getDocumentSellerTaxRepresentativeGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-117/BT-X-117-1, From EXTENDED Returns an array of the seller's tax agent identifiers indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the seller's tax agent tax information.
public function getDocumentSellerTaxRepresentativeTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-63/BT-63-0, From BASIC WL Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get the address of sellers tax agent
public function getDocumentSellerTaxRepresentativeAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-64, From BASIC WL The main line in the sellers tax agent address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-65, From BASIC WL Line 2 of the sellers tax agent address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-164, From BASIC WL Line 3 of the sellers tax agent address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-67, From BASIC WL Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-66, From BASIC WL Usual name of the city or municipality in which the sellers tax agent address is located |
| country | string | ✔️ | BT-69, From BASIC WL Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-68, From BASIC WL The sellers tax agent state |
Returns a value of type \ZugferdDocumentReader
Get the legal organisation of sellers tax agent
public function getDocumentSellerTaxRepresentativeLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | An identifier issued by an official registrar that identifies the seller tax agent as a legal entity or legal person. |
| legalOrgType | string | ✔️ | The identifier for the identification scheme of the legal registration of the sellers tax agent. If the identification scheme is used, it must be selected from ISO/IEC 6523 list |
| legalOrgName | string | ✔️ | A name by which the sellers tax agent is known, if different from the sellers tax agent name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first seller tax representative contact of the document. Returns true if a first Seller Tax Representative contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentSellerTaxRepresentativeContact
public function firstDocumentSellerTaxRepresentativeContact(): bool
{
}Returns a value of type bool
Seek to the next available seller tax representative contact of the document. Returns true if another seller contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentSellerContact
public function nextDocumentSellerTaxRepresentativeContact(): bool
{
}Returns a value of type bool
Get contact information of sellers tax agent
public function getDocumentSellerTaxRepresentativeContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-120, From EXTENDED Such as personal name, name of contact person or department or office |
| contactDepartmentName | string | ✔️ | BT-X-121, From EXTENDED If a contact person is specified, either the name or the department must be transmitted. |
| contactPhoneNo | string | ✔️ | BT-X-122, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-123, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-124, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the product end user (general information)
public function getDocumentProductEndUser(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-128, From EXTENDED Name/company name of the end user |
| id | array | ✔️ | BT-X-126, From EXTENDED An array of identifiers of the product end user |
| description | string | ✔️ | Further legal information that is relevant for the product end user |
Returns a value of type \ZugferdDocumentReader
Get global identifier of the product end user.
public function getDocumentProductEndUserGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-127/BT-X-127-0, From EXTENDED Array of the product end users global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the tax number of the product end user
public function getDocumentProductEndUserTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get the address of product end user
public function getDocumentProductEndUserAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-397, From EXTENDED The main line in the product end users address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-X-398, From EXTENDED Line 2 of the product end users address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-399, From EXTENDED Line 3 of the product end users address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-396, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-400, From EXTENDED Usual name of the city or municipality in which the product end users address is located |
| country | string | ✔️ |
BT-X-401, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-402, From EXTENDED The product end users state |
Returns a value of type \ZugferdDocumentReader
Get the legal organisation of product end user
public function getDocumentProductEndUserLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-X-129, From EXTENDED An identifier issued by an official registrar that identifies the product end user as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to all trade parties |
| legalOrgType | string | ✔️ | __BT-X-129-0, From EXTENDED__The identifier for the identification scheme of the legal registration of the product end user. If the identification scheme is used, it must be selected from ISO/IEC 6523 list |
| legalOrgName | string | ✔️ | BT-X-130, From EXTENDED A name by which the product end user is known, if different from the product end users name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first product end-user contact of the document. Returns true if a first product end-user contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentProductEndUserContact
public function firstDocumentProductEndUserContactContact(): bool
{
}Returns a value of type bool
Seek to the next available product end-user contact of the document. Returns true if another product end-user contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentProductEndUserContact
public function nextDocumentProductEndUserContactContact(): bool
{
}Returns a value of type bool
Get detailed information on the product end user's contact person
public function getDocumentProductEndUserContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-131, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-132, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-133, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-134, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-135, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the Ship-To party
public function getDocumentShipTo(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-70, From BASIC WL The name of the party to whom the goods are being delivered or for whom the services are being performed. Must be used if the recipient of the goods or services is not the same as the buyer. |
| id | array | ✔️ | BT-71, From BASIC WL An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the party |
Returns a value of type \ZugferdDocumentReader
Get global identifier for the Ship-To party
public function getDocumentShipToGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-71-0/BT-71-1, From BASIC WL Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the Ship-To party
public function getDocumentShipToTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-X-161/BT-X-161-0, From EXTENDED Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get the postal address of the Ship-To party
public function getDocumentShipToAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-75, From BASIC WL The main line in the party's address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-76, From BASIC WL Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-165, From BASIC WL Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-78, From BASIC WL Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-77, From BASIC WL Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ | BT-80, From BASIC WL Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-79, From BASIC WL The party's state |
Returns a value of type \ZugferdDocumentReader
Legal organisation of Ship-To trade party
public function getDocumentShipToLegalOrganisation(
?string $legalOrgid,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgid | string | ✔️ | BT-X-153, From EXTENDED An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-X-153-0, From EXTENDED The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-154, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first Ship-To contact of the document. Returns true if a first ship-to contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentShipToContact
public function firstDocumentShipToContact(): bool
{
}Returns a value of type bool
Seek to the next available first ship-to contact of the document. Returns true if another ship-to contact is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentShipToContact
public function nextDocumentShipToContact(): bool
{
}Returns a value of type bool
Get detailed information on the contact person of the goods recipient
public function getDocumentShipToContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-155, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-156, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-157, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-158, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-159, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the different end recipient
public function getDocumentUltimateShipTo(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-164, From EXTENDED Name or company name of the different end recipient |
| id | array | ✔️ | BT-X-162, From EXTENDED An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the different end recipient |
Returns a value of type \ZugferdDocumentReader
Get global identifiers of the different end recipient party
public function getDocumentUltimateShipToGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-163/BT-X-163-0, From EXTENDED Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the different end recipient party
public function getDocumentUltimateShipToTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-X-180/BT-X-180-0, From EXTENDED Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the address of the different end recipient party
public function getDocumentUltimateShipToAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-173, From EXTENDED The main line in the party's address. This is usually the street name and house number or the post office box. For major customer addresses, this field must be filled with "-". |
| lineTwo | string | ✔️ | BT-X-174, From EXTENDED Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-175, From EXTENDED Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-172, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-176, From EXTENDED Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ | BT-X-177, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-178, From EXTENDED The party's state |
Returns a value of type \ZugferdDocumentReader
Get detailed information about the Legal organisation of the different end recipient party
public function getDocumentUltimateShipToLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-X-165, From EXTENDED An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-X-165-0, From EXTENDED The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-166, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first contact person of the different end recipient party. Returns true if a first contact person of the different end recipient party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentUltimateShipToContact
public function firstDocumentUltimateShipToContact(): bool
{
}Returns a value of type bool
Seek to the next available contact person of the different end recipient party. Returns true if another contact person of the different end recipient party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentUltimateShipToContact
public function nextDocumentUltimateShipToContact(): bool
{
}Returns a value of type bool
Get detailed information on the contact person of the different end recipient party
public function getDocumentUltimateShipToContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-167, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-168, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-169, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-170, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-171, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information of the deviating consignor party
public function getDocumentShipFrom(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-183, From EXTENDED The name of the party |
| id | array | ✔️ | BT-X-181, From EXTENDED An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the party |
Returns a value of type \ZugferdDocumentReader
Get global identifier of the deviating consignor party
public function getDocumentShipFromGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-182/BT-X-182-0, From EXTENDED Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the deviating consignor party
public function getDocumentShipFromTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get Detailed information on the address of the deviating consignor party
public function getDocumentShipFromAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-192, From EXTENDED The main line in the party's address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-X-193, From EXTENDED Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-194, From EXTENDED Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-191, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-195, From EXTENDED Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ |
BT-X-196, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-197, From EXTENDED The party's state |
Returns a value of type \ZugferdDocumentReader
Get information about the legal organisation of the deviating consignor party
public function getDocumentShipFromLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-X-184, From EXTENDED An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-X-184-0, From EXTENDED The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-185, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first contact information of the deviating consignor party of the document. Returns true if a first contact information of the deviating consignor party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentShipFromContact
public function firstDocumentShipFromContact(): bool
{
}Returns a value of type bool
Seek to the next available first contact information of the deviating consignor party of the document. Returns true if another contact information of the deviating consignor party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentShipFromContact
public function nextDocumentShipFromContact(): bool
{
}Returns a value of type bool
Get contact information of the deviating consignor party
public function getDocumentShipFromContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-186, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-187, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-188, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-189, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-190, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information of the invoicer party
public function getDocumentInvoicer(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-207, From EXTENDED The name of the party |
| id | array | ✔️ | BT-X-205, From EXTENDED An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the party |
Returns a value of type \ZugferdDocumentReader
Get global identifier of the invoicer party
public function getDocumentInvoicerGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-206/BT-X-206-0, From EXTENDED Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the invoicer party
public function getDocumentInvoicerTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get Detailed information on the address of the invoicer party
public function getDocumentInvoicerAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-216, From EXTENDED The main line in the party's address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-X-217, From EXTENDED Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-218, From EXTENDED Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-215, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-219, From EXTENDED Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ | BT-X-220, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-221, From EXTENDED The party's state |
Returns a value of type \ZugferdDocumentReader
Get information about the legal organisation of the invoicer party
public function getDocumentInvoicerLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-X-208, From EXTENDED An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-X-208-0, From EXTENDED The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN,* 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-209, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first contact information of the invoicer party of the document. Returns true if a first contact information of the invoicer party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentInvoicerContact
public function firstDocumentInvoicerContact(): bool
{
}Returns a value of type bool
Seek to the next available contact information of the invoicer party of the document. Returns true if another contact information of the invoicer party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentInvoicerContact
public function nextDocumentInvoicerContact(): bool
{
}Returns a value of type bool
Get contact information of the invoicer party
public function getDocumentInvoicerContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-210, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-211, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-212, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-213, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-214, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the different invoice recipient party
public function getDocumentInvoicee(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-226, From EXTENDED The name of the party |
| id | array | ✔️ | BT-X-224, From EXTENDED An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the party |
Returns a value of type \ZugferdDocumentReader
Get global identifier of the different invoice recipient party
public function getDocumentInvoiceeGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-X-225/BT-X-225-0, From EXTENDED Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the different invoice recipient party
public function getDocumentInvoiceeTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-X-242/BT-X-242-0, From EXTENDED Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get Detailed information on the address of the different invoice recipient party
public function getDocumentInvoiceeAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-235, From EXTENDED The main line in the party's address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-X-236, From EXTENDED Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-237, From EXTENDED Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-234, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-238, From EXTENDED Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ |
BT-X-239, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-240, From EXTENDED The party's state |
Returns a value of type \ZugferdDocumentReader
Get information about the legal organisation of the different invoice recipient party
public function getDocumentInvoiceeLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-X-227, From EXTENDED An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-X-227-0, From EXTENDED The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-228, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first contact information of the different invoice recipient party of the document. Returns true if a first contact information of the different invoice recipient party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentInvoiceeContact
public function firstDocumentInvoiceeContact(): bool
{
}Returns a value of type bool
Seek to the next available first contact information of the different invoice recipient party of the document. Returns true if another contact information of the different invoice recipient party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentInvoiceeContact
public function nextDocumentInvoiceeContact(): bool
{
}Returns a value of type bool
Get contact information of the different invoice recipient party
public function getDocumentInvoiceeContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-229, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-230, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-231, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-232, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-233, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information about the payee, i.e. about the place that receives the payment.
The role of the payee may also be performed by a party other than the seller, e.g. by a factoring service.
public function getDocumentPayee(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-59, From BASIC WL The name of the party. Must be used if the payee is not the same as the seller. However, the name of the payee may match the name of the seller. |
| id | array | ✔️ | BT-60, From BASIC WL An array of identifiers |
| description | string | ✔️ | Further legal information that is relevant for the party |
Returns a value of type \ZugferdDocumentReader
Get global identifier of the payee party
public function getDocumentPayeeGlobalId(?array $globalID): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| globalID | array | ✔️ | BT-60-0/BT-60-1, From BASIC WL Array of global ids indexed by the identification scheme. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on tax details of the payee party
public function getDocumentPayeeTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| taxReg | array | ✔️ | BT-X-257/BT-X-257-0, From EXTENDED Array of tax numbers indexed by the schemeid (VA, FC, etc.) |
Returns a value of type \ZugferdDocumentReader
Get Detailed information on the address of the payee party
public function getDocumentPayeeAddress(
?string $lineOne,
?string $lineTwo,
?string $lineThree,
?string $postCode,
?string $city,
?string $country,
?array $subDivision,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineOne | string | ✔️ | BT-X-250, From EXTENDED The main line in the party's address. This is usually the street name and house number or the post office box |
| lineTwo | string | ✔️ | BT-X-251, From EXTENDED Line 2 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| lineThree | string | ✔️ | BT-X-252, From EXTENDED Line 3 of the party's address. This is an additional address line in an address that can be used to provide additional details in addition to the main line |
| postCode | string | ✔️ | BT-X-249, From EXTENDED Identifier for a group of properties, such as a zip code |
| city | string | ✔️ | BT-X-253, From EXTENDED Usual name of the city or municipality in which the party's address is located |
| country | string | ✔️ |
BT-X-254, From EXTENDED Code used to identify the country. If no tax agent is specified, this is the country in which the sales tax is due. The lists of approved countries are maintained by the EN ISO 3166-1 Maintenance Agency “Codes for the representation of names of countries and their subdivisions” |
| subDivision | array | ✔️ | BT-X-255, From EXTENDED The party's state |
Returns a value of type \ZugferdDocumentReader
Get information about the legal organisation of the payee party
public function getDocumentPayeeLegalOrganisation(
?string $legalOrgId,
?string $legalOrgType,
?string $legalOrgName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| legalOrgId | string | ✔️ | BT-61, From BASIC WL An identifier issued by an official registrar that identifies the party as a legal entity or legal person. If no identification scheme ($legalorgtype) is provided, it should be known to the buyer or seller party |
| legalOrgType | string | ✔️ | BT-61-1, From BASIC WL The identifier for the identification scheme of the legal registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE |
| legalOrgName | string | ✔️ | BT-X-243, From EXTENDED A name by which the party is known, if different from the party's name (also known as the company name) |
Returns a value of type \ZugferdDocumentReader
Seek to the first contact information of the payee party of the document. Returns true if a first contact information of the payee party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPayeeContact
public function firstDocumentPayeeContact(): bool
{
}Returns a value of type bool
Seek to the next available first contact information of the payee party of the document. Returns true if another contact information of the payee party is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPayeeContact
public function nextDocumentPayeeContact(): bool
{
}Returns a value of type bool
Get contact information of the payee party
public function getDocumentPayeeContact(
?string $contactPersonName,
?string $contactDepartmentName,
?string $contactPhoneNo,
?string $contactFaxNo,
?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| contactPersonName | string | ✔️ | BT-X-244, From EXTENDED Contact point for a legal entity, such as a personal name of the contact person |
| contactDepartmentName | string | ✔️ | BT-X-245, From EXTENDED Contact point for a legal entity, such as a name of the department or office |
| contactPhoneNo | string | ✔️ | BT-X-246, From EXTENDED A telephone number for the contact point |
| contactFaxNo | string | ✔️ | BT-X-247, From EXTENDED A fax number of the contact point |
| contactEmailAddress | string | ✔️ | BT-X-248, From EXTENDED An e-mail address of the contact point |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the delivery conditions
public function getDocumentDeliveryTerms(?string $code): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| code | string | ✔️ | BT-X-145, From EXTENDED The code indicating the type of delivery for these commercial delivery terms. To be selected from the entries in the list UNTDID 4053 + INCOTERMS |
Returns a value of type \ZugferdDocumentReader
Get details of the associated order confirmation
public function getDocumentSellerOrderReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-14, From EN 16931 An identifier issued by the seller for a referenced sales order (Order confirmation number) |
| issueDate | DateTime | ✔️ | BT-X-146, From EXTENDED Order confirmation date |
Returns a value of type \ZugferdDocumentReader
Get details of the related buyer order
public function getDocumentBuyerOrderReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-13, From MINIMUM An identifier issued by the buyer for a referenced order (order number) |
| issueDate | DateTime | ✔️ | BT-X-147, From EXTENDED Date of order |
Returns a value of type \ZugferdDocumentReader
Get details of the associated offer
public function getDocumentQuotationReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-403, From EXTENDED Offer number |
| issueDate | DateTime | ✔️ | BT-X-404, From EXTENDED Date of offer |
Returns a value of type \ZugferdDocumentReader
Get details of the associated contract
public function getDocumentContractReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-12, From BASIC WL The contract reference should be assigned once in the context of the specific trade relationship and for a defined period of time (contract number) |
| issueDate | DateTime | ✔️ | BT-X-26, From EXTENDED Contract date |
Returns a value of type \ZugferdDocumentReader
Get first additional referenced document for the document. Returns true if an additional referenced document is available, otherwise false
Use with getDocumentAdditionalReferencedDocument
public function firstDocumentAdditionalReferencedDocument(): bool
{
}Returns a value of type bool
Get next additional referenced document for the document. Returns true when another additional referenced document is available, otherwise false
Use with getDocumentAdditionalReferencedDocument
public function nextDocumentAdditionalReferencedDocument(): bool
{
}Returns a value of type bool
Get information about billing documents that provide evidence of claims made in the bill
Notes
- The documents justifying the invoice can be used to reference a document number, which should be
known to the recipient, as well as an external document (referenced by a URL) or an embedded document (such
as a timesheet as a PDF file). The option of linking to an external document is e.g. required when it comes
to large attachments and / or sensitive information, e.g. for personal services, which must be separated
from the bill
- Use ZugferdDocumentReader::firstDocumentAdditionalReferencedDocument and
ZugferdDocumentReader::nextDocumentAdditionalReferencedDocument to seek between multiple additional referenced
documents
public function getDocumentAdditionalReferencedDocument(
?string $issuerAssignedId,
?string $typeCode,
?string $uriId = null,
?array $name = null,
?string $refTypeCode = null,
?DateTime $issueDate = null,
?string $binaryDataFilename = null,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-122, From EN 16931 The identifier of the tender or lot to which the invoice relates, or an identifier specified by the seller for an object on which the invoice is based, or an identifier of the document on which the invoice is based. |
| typeCode | string | ✔️ |
BT-122-0, From EN 16931 Type of referenced document (See codelist UNTDID 1001) - Code 916 "reference paper" is used to reference the identification of the document on which the invoice is based - Code 50 "Price / sales catalog response" is used to reference the tender or the lot - Code 130 "invoice data sheet" is used to reference an identifier for an object specified by the seller. |
| uriId | string | ✔️ |
BT-124, From EN 16931 A means of locating the resource, including the primary access method intended for it, e.g. http:// or ftp://. The storage location of the external document must be used if the buyer requires further information as supporting documents for the invoiced amounts. External documents are not part of the invoice. Invoice processing should be possible without access to external documents. Access to external documents can entail certain risks. |
| name | array | ✔️ | BT-123, From EN 16931 A description of the document, e.g. Hourly billing, usage or consumption report, etc. |
| refTypeCode | string | ✔️ | The identifier for the identification scheme of the identifier of the item invoiced. If it is not clear to the recipient which scheme is used for the identifier, an identifier of the scheme should be used, which must be selected from UNTDID 1153 in accordance with the code list entries. |
| issueDate | DateTime | ✔️ | BT-X-149, From EXTENDED Document date |
| binaryDataFilename | string | ✔️ | BT-125, From EN 16931 Contains a file name of an attachment document embedded as a binary object |
Returns a value of type \ZugferdDocumentReader
Get all additional referenced documents
public function getDocumentAdditionalReferencedDocuments(?array $refDocs): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| refDocs | array | ✔️ |
Array contains all additional referenced documents, but without extracting attached binary objects. If you want to access attached binary objects you have to use ZugferdDocumentReader::getDocumentAdditionalReferencedDocument |
Returns a value of type \ZugferdDocumentReader
Get first reference to the previous invoice. Returns true if an invoice reference document is available, otherwise false
public function firstDocumentInvoiceReferencedDocument(): bool
{
}Returns a value of type bool
Get next reference to the previous invoice Returns true when another invoice reference document is available, otherwise false
public function nextDocumentInvoiceReferencedDocument(): bool
{
}Returns a value of type bool
Get reference to the previous invoice
public function getDocumentInvoiceReferencedDocument(
?string $issuerAssignedId,
?string $typeCode,
?DateTime $issueDate = null,
): void
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-25, From BASIC WL The identification of an invoice previously sent by the seller |
| typeCode | string | ✔️ | BT-X-555, From EXTENDED Type of previous invoice (code) |
| issueDate | DateTime | ✔️ | BT-26, From BASIC WL Date of the previous invoice |
Get all references to the previous invoice
public function getDocumentInvoiceReferencedDocuments(?array $invoiceRefDocs): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| invoiceRefDocs | array | ✔️ |
Array contains all invoice referenced documents, but without extracting attached binary objects. If you want to access attached binary objects you have to use ZugferdDocumentReader::getDocumentInvoiceReferencedDocument |
Returns a value of type \ZugferdDocumentReader
Get Details of a project reference
public function getDocumentProcuringProject(?string $id, ?string $name): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| id | string | ✔️ | BT-11, From EN 16931 The identifier of the project to which the invoice relates |
| name | string | ✔️ | BT-11-0, From EN 16931 The name of the project to which the invoice relates |
Returns a value of type \ZugferdDocumentReader
Get first additional referenced document for the document. Returns true if the first position is available, otherwise false
public function firstDocumentUltimateCustomerOrderReferencedDocument(): bool
{
}Returns a value of type bool
Get next additional referenced document for the document. Returns true if the first position is available, otherwise false
public function nextDocumentUltimateCustomerOrderReferencedDocument(): bool
{
}Returns a value of type bool
Get details of the ultimate customer order
public function getDocumentUltimateCustomerOrderReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-150, From EXTENDED Order number of the end customer |
| issueDate | DateTime | ✔️ | BT-X-151, From EXTENDED Date of the order issued by the end customer |
Returns a value of type \ZugferdDocumentReader
Details of the ultimate customer order
public function getDocumentUltimateCustomerOrderReferencedDocuments(): \ZugferdDocumentReader
{
}Returns a value of type \ZugferdDocumentReader
Get detailed information on the actual delivery
public function getDocumentSupplyChainEvent(?DateTime $date): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| date | DateTime | ✔️ | BT-72, From BASIC WL Actual delivery time |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the associated shipping notification
public function getDocumentDespatchAdviceReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-16, From BASIC WL Shipping notification reference |
| issueDate | DateTime | ✔️ | BT-X-200, From EXTENDED Shipping notification date |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the associated goods receipt notification
public function getDocumentReceivingAdviceReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-15, From EN 16931 An identifier for a referenced goods receipt notification (Goods receipt number) |
| issueDate | DateTime | ✔️ | BT-X-201, From EXTENDED Goods receipt date |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the associated delivery note
public function getDocumentDeliveryNoteReferencedDocument(
?string $issuerAssignedId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-202, From EXTENDED Delivery slip number |
| issueDate | DateTime | ✔️ | BT-X-203, From EXTENDED Delivery slip date |
Returns a value of type \ZugferdDocumentReader
Seek to the first payment means of the document. Returns true if a first payment mean is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPaymentMeans
public function firstGetDocumentPaymentMeans(): bool
{
}Returns a value of type bool
Seek to the next payment means of the document. Returns true if another payment mean is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPaymentMeans
public function nextGetDocumentPaymentMeans(): bool
{
}Returns a value of type bool
Get detailed information on the payment method
public function getDocumentPaymentMeans(
?string $typeCode,
?string $information,
?string $cardType,
?string $cardId,
?string $cardHolderName,
?string $buyerIban,
?string $payeeIban,
?string $payeeAccountName,
?string $payeePropId,
?string $payeeBic,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| typeCode | string | ✔️ |
BT-81, From BASIC WL The expected or used means of payment, expressed as a code. The entries from the UNTDID 4461 code list must be used. A distinction should be made between SEPA and non-SEPA payments as well as between credit payments, direct debits, card payments and other means of payment In particular, the following codes can be used: - 10: cash - 20: check - 30: transfer - 42: Payment to bank account - 48: Card payment - 49: direct debit - 57: Standing order - 58: SEPA Credit Transfer - 59: SEPA Direct Debit - 97: Report |
| information | string | ✔️ | BT-82, From EN 16931 The expected or used means of payment expressed in text form, e.g. cash, bank transfer, direct debit, credit card, etc. |
| cardType | string | ✔️ | The type of the card |
| cardId | string | ✔️ | BT-87, From EN 16931 The primary account number (PAN) to which the card used for payment belongs. In accordance with card payment security standards, an invoice should never contain a full payment card master account number. The following specification of the PCI Security Standards Council currently applies: The first 6 and last 4 digits at most are to be displayed |
| cardHolderName | string | ✔️ | BT-88, From EN 16931 Name of the payment card holder |
| buyerIban | string | ✔️ | BT-91, From BASIC WL The account to be debited by the direct debit |
| payeeIban | string | ✔️ | BT-84, From BASIC WL A unique identifier for the financial account held with a payment service provider to which the payment should be made |
| payeeAccountName | string | ✔️ | BT-85, From BASIC WL The name of the payment account held with a payment service provider to which the payment should be made |
| payeePropId | string | ✔️ | BT-84-0, From BASIC WL National account number (not for SEPA) |
| payeeBic | string | ✔️ | BT-86, From EN 16931 An identifier for the payment service provider with which the payment account is held |
Returns a value of type \ZugferdDocumentReader
Seek to the first document tax. Returns true if a first tax (at document level) is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentTax
public function firstDocumentTax(): bool
{
}Returns a value of type bool
Seek to the next document tax. Returns true if another tax (at document level) is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentTax
public function nextDocumentTax(): bool
{
}Returns a value of type bool
Get current VAT breakdown (at document level)
public function getDocumentTax(
?string $categoryCode,
?string $typeCode,
?float $basisAmount,
?float $calculatedAmount,
?float $rateApplicablePercent,
?string $exemptionReason,
?string $exemptionReasonCode,
?float $lineTotalBasisAmount,
?float $allowanceChargeBasisAmount,
?DateTime $taxPointDate,
?string $dueDateTypeCode,
): void
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| categoryCode | string | ✔️ | BT-118, From BASIC WL Coded description of a sales tax category |
| typeCode | string | ✔️ | BT-118-0, From BASIC WL Coded description of a sales tax category. Note: Fixed value = "VAT" |
| basisAmount | float | ✔️ | BT-116, From BASIC WL Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. |
| calculatedAmount | float | ✔️ | BT-117, From BASIC WL The total amount to be paid for the relevant VAT category. Note: Calculated by multiplying the amount to be taxed according to the sales tax category by the sales tax rate applicable for the sales tax category concerned |
| rateApplicablePercent | float | ✔️ | BT-119, From BASIC WL The sales tax rate, expressed as the percentage applicable to the sales tax category in question. Note: The code of the sales tax category and the category-specific sales tax rate must correspond to one another. The value to be given is the percentage. For example, the value 20 is given for 20% (and not 0.2) |
| exemptionReason | string | ✔️ | BT-120, From BASIC WL Reason for tax exemption (free text) |
| exemptionReasonCode | string | ✔️ | BT-121, From BASIC WL Reason given in code form for the exemption of the amount from VAT. Note: Code list issued and maintained by the Connecting Europe Facility. |
| lineTotalBasisAmount | float | ✔️ | BT-X-262, From EXTENDED An amount used as the basis for calculating sales tax, duty or customs duty |
| allowanceChargeBasisAmount | float | ✔️ | BT-X-263, From EXTENDED Total amount Additions and deductions to the tax rate at document level |
| taxPointDate | DateTime | ✔️ | BT-7-00, From EN 16931 Date on which tax is due. This is not used in Germany. Instead, the delivery and service date must be specified. |
| dueDateTypeCode | string | ✔️ | BT-8, From BASIC WL The code for the date on which the VAT becomes relevant for settlement for the seller and for the buyer |
Get detailed information on the billing period
public function getDocumentBillingPeriod(?DateTime $startDate, ?DateTime $endDate): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| startDate | DateTime | ✔️ | BT-73, From BASIC WL Start of the billing period |
| endDate | DateTime | ✔️ | BT-74, From BASIC WL End of the billing period |
Returns a value of type \ZugferdDocumentReader
Get information about surcharges and charges applicable to the bill as a whole, Deductions, such as for
withheld taxes may also be specified in this group
public function getDocumentAllowanceCharges(?array $allowanceCharge): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| allowanceCharge | array | ✔️ |
Returns a value of type \ZugferdDocumentReader
Seek to the first documents allowance charge. Returns true if the first position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentAllowanceCharge
public function firstDocumentAllowanceCharge(): bool
{
}Returns a value of type bool
Seek to the next documents allowance charge. Returns true if a other position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentAllowanceCharge
public function nextDocumentAllowanceCharge(): bool
{
}Returns a value of type bool
Get information about the currently seeked surcharges and charges applicable to the
bill as a whole, Deductions, such as for withheld taxes may also be specified in this group
public function getDocumentAllowanceCharge(
?float $actualAmount,
?bool $isCharge,
?string $taxCategoryCode,
?string $taxTypeCode,
?float $rateApplicablePercent,
?float $sequence,
?float $calculationPercent,
?float $basisAmount,
?float $basisQuantity,
?string $basisQuantityUnitCode,
?string $reasonCode,
?string $reason,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| actualAmount | float | ✔️ | BT-92/BT-99, From BASIC WL Amount of the surcharge or discount at document level |
| isCharge | bool | ✔️ | BT-20-1/BT-21-1, From BASIC WL Switch that indicates whether the following data refer to an surcharge or a discount, true means that this an charge |
| taxCategoryCode | string | ✔️ | BT-95/BT-102, From BASIC WL A coded indication of which sales tax category applies to the surcharge or deduction at document level |
| taxTypeCode | string | ✔️ | BT-95-0/BT-102-0, From BASIC WL Code for the VAT category of the surcharge or charge at document level. Note: Fixed value = "VAT" |
| rateApplicablePercent | float | ✔️ | BT-96/BT-103, From BASIC WL VAT rate for the surcharge or discount on document level. Note: The code of the sales tax category and the category-specific sales tax rate must correspond to one another. The value to be given is the percentage. For example, the value 20 is given for 20% (and not 0.2) |
| sequence | float | ✔️ | BT-X-265, From EXTENDED Calculation order |
| calculationPercent | float | ✔️ | BT-94/BT-101, From BASIC WL Percentage surcharge or discount at document level |
| basisAmount | float | ✔️ | BT-93/BT-100, From BASIC WL The base amount that may be used in conjunction with the percentage of the surcharge or discount at document level to calculate the amount of the discount at document level |
| basisQuantity | float | ✔️ | BT-X-266, From EXTENDED Base quantity of the discount |
| basisQuantityUnitCode | string | ✔️ | BT-X-267, From EXTENDED Unit of the price base quantity |
| reasonCode | string | ✔️ | BT-98/BT-105, From BASIC WL The reason given as a code for the surcharge or discount at document level. Note: Use entries from the UNTDID 5189 code list. The code of the reason for the surcharge or discount at document level and the reason for the surcharge or discount at document level must correspond to each other |
| reason | string | ✔️ | BT-97/BT-104, From BASIC WL The reason given in text form for the surcharge or discount at document level |
Returns a value of type \ZugferdDocumentReader
Seek to the first documents service charge position. Returns true if the first position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentLogisticsServiceCharge
public function firstDocumentLogisticsServiceCharge(): bool
{
}Returns a value of type bool
Seek to the next documents service charge position. Returns true if a other position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentLogisticsServiceCharge
public function nextDocumentLogisticsServiceCharge(): bool
{
}Returns a value of type bool
Get currently seeked logistical service fees (On document level)
public function getDocumentLogisticsServiceCharge(
?string $description,
?float $appliedAmount,
?array $taxTypeCodes = null,
?array $taxCategoryCodes = null,
?array $rateApplicablePercents = null,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| description | string | ✔️ | BT-X-271, From EXTENDED Identification of the service fee |
| appliedAmount | float | ✔️ | BT-X-272, From EXTENDED Amount of the service fee |
| taxTypeCodes | array | ✔️ | BT-X-273-0, From EXTENDED Code of the Tax type. Note: Fixed value = "VAT" |
| taxCategoryCodes | array | ✔️ | BT-X-273, From EXTENDED Code of the VAT category |
| rateApplicablePercents | array | ✔️ | BT-X-274, From EXTENDED The sales tax rate, expressed as the percentage applicable to the sales tax category in question. Note: The code of the sales tax category and the category-specific sales tax rate must correspond to one another. The value to be given is the percentage. For example, the value 20 is given for 20% (and not 0.2) |
Returns a value of type \ZugferdDocumentReader
Get all documents payment terms
public function getDocumentPaymentTerms(?array $paymentTerms): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| paymentTerms | array | ✔️ |
Returns a value of type \ZugferdDocumentReader
Seek to the first documents payment terms position. Returns true if the first position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPaymentTerm
public function firstDocumentPaymentTerms(): bool
{
}Returns a value of type bool
Seek to the next documents payment terms position. Returns true if a other position is available, otherwise false
You may use this together with ZugferdDocumentReader::getDocumentPaymentTerm
public function nextDocumentPaymentTerms(): bool
{
}Returns a value of type bool
Get currently seeked payment term
This controlled by firstDocumentPaymentTerms and nextDocumentPaymentTerms methods
public function getDocumentPaymentTerm(
?string $description,
?DateTime $dueDate,
?string $directDebitMandateID,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| description | string | ✔️ | _BT-20, From BASIC WL A text description of the payment terms that apply to the payment amount due (including a description of possible penalties). Note: This element can contain multiple lines and multiple conditions. |
| dueDate | DateTime | ✔️ | BT-9, From BASIC WL The date by which payment is due Note: The payment due date reflects the net payment due date. In the case of partial payments, this indicates the first due date of a net payment. The corresponding description of more complex payment terms can be given in BT-20. |
| directDebitMandateID | string | ✔️ | BT-89, From BASIC WL Unique identifier assigned by the payee to reference the direct debit authorization. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on payment discounts
public function getDiscountTermsFromPaymentTerm(
?float $calculationPercent,
?DateTime $basisDateTime,
?float $basisPeriodMeasureValue,
?string $basisPeriodMeasureUnitCode,
?float $basisAmount,
?float $actualDiscountAmount,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| calculationPercent | float | ✔️ | BT-X-286, From EXTENDED Percentage of the down payment |
| basisDateTime | DateTime | ✔️ | BT-X-282, From EXTENDED Due date reference date |
| basisPeriodMeasureValue | float | ✔️ | BT-X-284, From EXTENDED Maturity period (basis) |
| basisPeriodMeasureUnitCode | string | ✔️ | BT-X-284, From EXTENDED Maturity period (unit) |
| basisAmount | float | ✔️ | BT-X-284, From EXTENDED Base amount of the payment discount |
| actualDiscountAmount | float | ✔️ | BT-X-287, From EXTENDED Amount of the payment discount |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionGenerals
public function firstDocumentPosition(): bool
{
}Returns a value of type bool
Seek to the next document position. Returns true if another position is available, otherwise false
You may use it together with getDocumentPositionGenerals
public function nextDocumentPosition(): bool
{
}Returns a value of type bool
Get general information of the current position
public function getDocumentPositionGenerals(
?string $lineId,
?string $lineStatusCode,
?string $lineStatusReasonCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineId | string | ✔️ | BT-126, From BASIC Identification of the invoice item |
| lineStatusCode | string | ✔️ | BT-X-7, From EXTENDED Indicates whether the invoice item contains prices that must be taken into account when calculating the invoice amount or whether only information is included. |
| lineStatusReasonCode | string | ✔️ | BT-X-8, From EXTENDED Adds the type to specify whether the invoice line is: |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionNote
public function firstDocumentPositionNote(): bool
{
}Returns a value of type bool
Seek to the next document position. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionNote
public function nextDocumentPositionNote(): bool
{
}Returns a value of type bool
Get detailed information on the free text on the position
public function getDocumentPositionNote(
?string $content,
?string $contentCode,
?string $subjectCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| content | string | ✔️ | BT-127, From BASIC A free text that contains unstructured information that is relevant to the invoice item |
| contentCode | string | ✔️ | BT-X-9, From EXTENDED A code to classify the content of the free text of the invoice. The code is agreed bilaterally and must have the same meaning as BT-127. |
| subjectCode | string | ✔️ | BT-X-10, From EXTENDED Code for qualifying the free text for the invoice item (Codelist UNTDID 4451) |
Returns a value of type \ZugferdDocumentReader
Get information about the goods and services billed
public function getDocumentPositionProductDetails(
?string $name,
?string $description,
?string $sellerAssignedID,
?string $buyerAssignedID,
?string $globalIDType,
?string $globalID,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-153, From BASIC A name of the item (item name) |
| description | string | ✔️ | BT-154, From EN 16931 A description of the item, the item description makes it possible to describe the item and its properties in more detail than is possible with the item name. |
| sellerAssignedID | string | ✔️ | BT-155, From EN 16931 An identifier assigned to the item by the seller |
| buyerAssignedID | string | ✔️ | BT-156, From EN 16931 An identifier assigned to the item by the buyer. The article number of the buyer is a clear, bilaterally agreed identification of the product. It can, for example, be the customer article number or the article number assigned by the manufacturer. |
| globalIDType | string | ✔️ | BT-157-1, From BASIC The scheme for $globalID |
| globalID | string | ✔️ | BT-157, From BASIC Identification of an article according to the registered scheme (Global identifier of the product, GTIN, ...) |
Returns a value of type \ZugferdDocumentReader
Get information about the goods and services billed (Enhanced, with Model, Brand, etc.)
public function getDocumentPositionProductDetailsExt(
?string $name,
?string $description,
?string $sellerAssignedID,
?string $buyerAssignedID,
?string $globalIDType,
?string $globalID,
?string $industryAssignedID,
?string $modelID,
?string $batchID,
?string $brandName,
?string $modelName,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-153, From BASIC A name of the item (item name) |
| description | string | ✔️ | BT-154, From EN 16931 A description of the item, the item description makes it possible to describe the item and its properties in more detail than is possible with the item name. |
| sellerAssignedID | string | ✔️ | BT-155, From EN 16931 An identifier assigned to the item by the seller |
| buyerAssignedID | string | ✔️ | BT-156, From EN 16931 An identifier assigned to the item by the buyer. The article number of the buyer is a clear, bilaterally agreed identification of the product. It can, for example, be the customer article number or the article number assigned by the manufacturer. |
| globalIDType | string | ✔️ | BT-157-1, From BASIC The scheme for $globalID |
| globalID | string | ✔️ | BT-157, From BASIC Identification of an article according to the registered scheme (Global identifier of the product, GTIN, ...) |
| industryAssignedID | string | ✔️ | BT-X-309, From EXTENDED ID assigned by the industry to the contained referenced product |
| modelID | string | ✔️ | BT-X-533, From EXTENDED A unique model identifier for this product |
| batchID | string | ✔️ | BT-X-534. From EXTENDED Identification of the batch (lot) of the product |
| brandName | string | ✔️ | BT-X-535. From EXTENDED The brand name, expressed as text, for this product |
| modelName | string | ✔️ | BT-X-536. From EXTENDED Model designation of the product |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position's product characteristic. Returns true if the first position propduct characteristic is available, otherwise false
You may use it together with getDocumentPositionProductCharacteristic
public function firstDocumentPositionProductCharacteristic(): bool
{
}Returns a value of type bool
Seek to the next document position's product characteristic. Returns true if more position propduct characteristics are available, otherwise false
You may use it together with getDocumentPositionProductCharacteristic
public function nextDocumentPositionProductCharacteristic(): bool
{
}Returns a value of type bool
Get extra characteristics to the formerly added product.
Contains information about the characteristics of the goods and services invoiced
public function getDocumentPositionProductCharacteristic(
?string $description,
?string $value,
?string $typeCode,
?float $valueMeasure,
?string $valueMeasureUnitCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| description | string | ✔️ | BT-160, From EN 16931 The name of the attribute or property of the product such as "Colour" |
| value | string | ✔️ | BT-161, From EN 16931 The value of the attribute or property of the product such as "Red" |
| typeCode | string | ✔️ | BT-X-11, From EXTENDED Type of product characteristic (code). The codes must be taken from the UNTDID 6313 codelist. |
| valueMeasure | float | ✔️ | BT-X-12, From EXTENDED Value of the product property (numerical measured variable) |
| valueMeasureUnitCode | string | ✔️ | BT-X-12-0, From EXTENDED Unit of measurement code |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position's product classification. Returns true if the first position propduct classification is available, otherwise false
You may use it together with getDocumentPositionProductClassification
public function firstDocumentPositionProductClassification(): bool
{
}Returns a value of type bool
Seek to the next document position's product classification. Returns true if more position propduct classifications are available, otherwise false
You may use it together with getDocumentPositionProductClassification
public function nextDocumentPositionProductClassification(): bool
{
}Returns a value of type bool
Get detailed information on product classification
public function getDocumentPositionProductClassification(
?string $classCode,
?string $className,
?string $listID,
?string $listVersionID,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| classCode | string | ✔️ | BT-158, From EN 16931 Item classification identifier. Classification codes are used for grouping similar items that can serve different purposes, such as public procurement (according to the Common Procurement Vocabulary ([CPV]), e-commerce (UNSPSC), etc. |
| className | string | ✔️ | BT-X-138, From EXTENDED Name with which an article can be classified according to type or quality. |
| listID | string | ✔️ | BT-158-1, From EN 16931 The identifier for the identification scheme of the item classification identifier. The identification scheme must be selected from the entries in UNTDID 7143 [6]. |
| listVersionID | string | ✔️ | BT-158-2, From EN 16931 The version of the identification scheme |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position's referenced product. Returns true if the first position referenced product is available, otherwise false
You may use it together with getDocumentPositionReferencedProduct
public function firstDocumentPositionReferencedProduct(): bool
{
}Returns a value of type bool
Seek to the next document position's referenced product. Returns true if more position referenced products are available, otherwise false
You may use it together with getDocumentPositionReferencedProduct
public function nextDocumentPositionReferencedProduct(): bool
{
}Returns a value of type bool
Get detailed information on included products. This information relates to the product that has just been added
public function getDocumentPositionReferencedProduct(
?string $name,
?string $description,
?string $sellerAssignedID,
?string $buyerAssignedID,
?array $globalID,
?float $unitQuantity,
?string $unitCode,
?string $industryAssignedID,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| name | string | ✔️ | BT-X-18, From EXTENDED Name of the referenced product contained |
| description | string | ✔️ | BT-X-19, From EXTENDED Description of the included referenced product |
| sellerAssignedID | string | ✔️ | BT-X-16, From EXTENDED ID assigned by the seller of the contained referenced product |
| buyerAssignedID | string | ✔️ | BT-X-17, From EXTENDED ID of the referenced product assigned by the buyer |
| globalID | array | ✔️ | BT-X-15, From EXTENDED Array of global ids of the referenced product indexed by the identification scheme. |
| unitQuantity | float | ✔️ | BT-X-20, From EXTENDED Quantity of the referenced product contained |
| unitCode | string | ✔️ | BT-X-20-1, From EXTENDED Unit code of Quantity of the referenced product contained |
| industryAssignedID | string | ✔️ | BT-X-309, From EXTENDED ID of the referenced product contained assigned by the industry |
Returns a value of type \ZugferdDocumentReader
Get details of a related sales order reference
public function getDocumentPositionSellerOrderReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-537, From EXTENDED Document number of a sales order reference |
| lineId | string | ✔️ | BT-X-538, From EXTENDED An identifier for a position within a sales order. |
| issueDate | DateTime | ✔️ | BT-X-539, From EXTENDED Date of sales order |
Returns a value of type \ZugferdDocumentReader
Get details of the related buyer order position
public function getDocumentPositionBuyerOrderReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-21, From EXTENDED An identifier issued by the buyer for a referenced order (order number) |
| lineId | string | ✔️ | BT-132, From EN 16931 An identifier for a position within an order placed by the buyer. Note: Reference is made to the order reference at the document level. |
| issueDate | DateTime | ✔️ | BT-X-22, From EXTENDED Date of order |
Returns a value of type \ZugferdDocumentReader
Get details of the associated offer position
public function getDocumentPositionQuotationReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-310, From EXTENDED Offer number |
| lineId | string | ✔️ | BT-X-311, From EXTENDED Position identifier within the offer |
| issueDate | DateTime | ✔️ | BT-X-312, From EXTENDED Date of offder |
Returns a value of type \ZugferdDocumentReader
Get details of the related contract position
public function getDocumentPositionContractReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-24, From EXTENDED The contract reference should be assigned once in the context of the specific trade relationship and for a defined period of time (contract number) |
| lineId | string | ✔️ | BT-X-25, From EXTENDED Identifier of the according contract position |
| issueDate | DateTime | ✔️ | BT-X-26, From EXTENDED Contract date |
Returns a value of type \ZugferdDocumentReader
Seek to the first documents position additional referenced document. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionAdditionalReferencedDocument
public function firstDocumentPositionAdditionalReferencedDocument(): bool
{
}Returns a value of type bool
Seek to the next documents position additional referenced document. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionAdditionalReferencedDocument
public function nextDocumentPositionAdditionalReferencedDocument(): bool
{
}Returns a value of type bool
Details of an additional Document reference (on position level)
- The documents justifying the invoice can be used to reference a document number, which should be
known to the recipient, as well as an external document (referenced by a URL) or an embedded document (such
as a timesheet as a PDF file). The option of linking to an external document is e.g. required when it comes
to large attachments and / or sensitive information, e.g. for personal services, which must be separated
from the bill
- Use ZugferdDocumentReader::firstDocumentAdditionalReferencedDocument and
ZugferdDocumentReader::nextDocumentAdditionalReferencedDocument to seek between multiple additional referenced
documents
public function getDocumentPositionAdditionalReferencedDocument(
?string $issuerAssignedId,
?string $typeCode,
?string $uriId,
?string $lineId,
?array $name,
?string $refTypeCode,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-27, From EXTENDED The identifier of the tender or lot to which the invoice relates, or an identifier specified by the seller for an object on which the invoice is based, or an identifier of the document on which the invoice is based. |
| typeCode | string | ✔️ | BT-X-30, From EXTENDED Type of referenced document (See codelist UNTDID 1001) |
| uriId | string | ✔️ | BT-X-28, From EXTENDED The Uniform Resource Locator (URL) at which the external document is available. A means of finding the resource including the primary access method intended for it, e.g. http: // or ftp: //. The location of the external document must be used if the buyer needs additional information to support the amounts billed. External documents are not part of the invoice. Access to external documents can involve certain risks. |
| lineId | string | ✔️ | BT-X-29, From EXTENDED The referenced position identifier in the additional document |
| name | array | ✔️ | BT-X-299, From EXTENDED A description of the document, e.g. Hourly billing, usage or consumption report, etc. |
| refTypeCode | string | ✔️ | BT-X-32, From EXTENDED The identifier for the identification scheme of the identifier of the item invoiced. If it is not clear to the recipient which scheme is used for the identifier, an identifier of the scheme should be used, which must be selected from UNTDID 1153 in accordance with the code list entries. |
| issueDate | DateTime | ✔️ | BT-X-33, From EXTENDED Document date |
Returns a value of type \ZugferdDocumentReader
Get the unit price excluding sales tax before deduction of the discount on the item price.
public function getDocumentPositionGrossPrice(
?float $amount,
?float $basisQuantity,
?string $basisQuantityUnitCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| amount | float | ✔️ | BT-148, From BASIC The unit price excluding sales tax before deduction of the discount on the item price. If the price is shown according to the net calculation, the price must also be shown according to the gross calculation. |
| basisQuantity | float | ✔️ | BT-149-1, From BASIC The number of item units for which the price applies (price base quantity) |
| basisQuantityUnitCode | string | ✔️ | BT-150-1, From BASIC The unit code of the number of item units for which the price applies (price base quantity) |
Returns a value of type \ZugferdDocumentReader
Seek to the first documents position gross price allowance charge position. Returns true if the first position is available, otherwise false
You may use it together with getDocumentPositionGrossPriceAllowanceCharge
public function firstDocumentPositionGrossPriceAllowanceCharge(): bool
{
}Returns a value of type bool
Seek to the next documents position gross price allowance charge position. Returns true if a other position is available, otherwise false
You may use it together with getDocumentPositionGrossPriceAllowanceCharge
public function nextDocumentPositionGrossPriceAllowanceCharge(): bool
{
}Returns a value of type bool
Get Detailed information on surcharges and discounts on item gross price
public function getDocumentPositionGrossPriceAllowanceCharge(
?float $actualAmount,
?bool $isCharge,
?float $calculationPercent,
?float $basisAmount,
?string $reason,
?string $taxTypeCode,
?string $taxCategoryCode,
?float $rateApplicablePercent,
?float $sequence,
?float $basisQuantity,
?string $basisQuantityUnitCode,
?string $reasonCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| actualAmount | float | ✔️ | BT-147, From BASIC Discount on the item price. The total discount subtracted from the gross price to calculate the net price. Note: Only applies if the discount is given per unit and is not included in the gross price. |
| isCharge | bool | ✔️ | BT-147-02, From BASIC Switch for surcharge/discount, if true then its an charge |
| calculationPercent | float | ✔️ | __BT-X-34, From EXTENDED__Discount/surcharge in percent. Up to level EN16931, only the final result of the discount (ActualAmount) is transferred |
| basisAmount | float | ✔️ | BT-X-35, From EXTENDED Base amount of the discount/surcharge |
| reason | string | ✔️ | BT-X-36, From EXTENDED Reason for surcharge/discount (free text) |
| taxTypeCode | string | ✔️ | BT-??, From BASIC |
| taxCategoryCode | string | ✔️ | BT-??, From BASIC |
| rateApplicablePercent | float | ✔️ | BT-??, From BASIC |
| sequence | float | ✔️ | BT-??, From BASIC |
| basisQuantity | float | ✔️ | BT-??, From BASIC |
| basisQuantityUnitCode | string | ✔️ | BT-??, From BASIC |
| reasonCode | string | ✔️ | BT-X-313, From EXTENDED Reason code for surcharge/discount |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the net price of the item
public function getDocumentPositionNetPrice(
?float $amount,
?float $basisQuantity,
?string $basisQuantityUnitCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| amount | float | ✔️ | BT-146, From BASIC Net price of the item |
| basisQuantity | float | ✔️ | BT-149, From BASIC Base quantity at the item price |
| basisQuantityUnitCode | string | ✔️ | BT-150, From BASIC Code of the unit of measurement of the base quantity at the item price |
Returns a value of type \ZugferdDocumentReader
Tax included for B2C on position level
public function getDocumentPositionNetPriceTax(
?string $categoryCode,
?string $typeCode,
?float $rateApplicablePercent,
?float $calculatedAmount,
?string $exemptionReason,
?string $exemptionReasonCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| categoryCode | string | ✔️ | Coded description of a sales tax category |
| typeCode | string | ✔️ | Coded description of a sales tax category. Note: Fixed value = "VAT" |
| rateApplicablePercent | float | ✔️ | The sales tax rate, expressed as the percentage applicable to the sales tax category in question. Note: The code of the sales tax category and the category-specific sales tax rate must correspond to one another. The value to be given is the percentage. For example, the value 20 is given for 20% (and not 0.2) |
| calculatedAmount | float | ✔️ | The total amount to be paid for the relevant VAT category. Note: Calculated by multiplying the amount to be taxed according to the sales tax category by the sales tax rate applicable for the sales tax category concerned |
| exemptionReason | string | ✔️ | Reason for tax exemption (free text) |
| exemptionReasonCode | string | ✔️ | Reason given in code form for the exemption of the amount from VAT. Note: Code list issued and maintained by the Connecting Europe Facility. |
Returns a value of type \ZugferdDocumentReader
Get the position Quantity
public function getDocumentPositionQuantity(
?float $billedQuantity,
?string $billedQuantityUnitCode,
?float $chargeFreeQuantity,
?string $chargeFreeQuantityUnitCpde,
?float $packageQuantity,
?string $packageQuantityUnitCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| billedQuantity | float | ✔️ | BT-129, From BASIC The quantity of individual items (goods or services) billed in the relevant line |
| billedQuantityUnitCode | string | ✔️ | BT-130, From BASIC The unit of measure applicable to the amount billed |
| chargeFreeQuantity | float | ✔️ | BT-X-46, From EXTENDED Quantity, free of charge |
| chargeFreeQuantityUnitCpde | string | ✔️ | BT-X-46-0, From EXTENDED Unit of measure code for the quantity free of charge |
| packageQuantity | float | ✔️ | BT-X-47, From EXTENDED Number of packages |
| packageQuantityUnitCode | string | ✔️ | BT-X-47-0, From EXTENDED Unit of measure code for number of packages |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the actual delivery (on position level)
public function getDocumentPositionSupplyChainEvent(?DateTime $date): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| date | DateTime | ✔️ | BT-X-85, From EXTENDED Actual delivery date |
Returns a value of type \ZugferdDocumentReader
Get detailed information on the associated shipping notification (on position level)
public function getDocumentPositionDespatchAdviceReferencedDocument(
?string $issuerAssignedId,
?string $lineId = null,
?DateTime $issueDate = null,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-86, From EXTENDED Shipping notification number |
| lineId | string | ✔️ | BT-X-87, From EXTENDED Shipping notification position |
| issueDate | DateTime | ✔️ | BT-X-88, From EXTENDED Date of Shipping notification number |
Returns a value of type \ZugferdDocumentReader
Detailed information on the associated shipping notification (on position level)
public function getDocumentPositionReceivingAdviceReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-89, From EXTENDED Goods receipt number |
| lineId | string | ✔️ | BT-X-90, From EXTENDED Goods receipt position |
| issueDate | DateTime | ✔️ | BT-X-91, From EXTENDED Date of Goods receipt |
Returns a value of type \ZugferdDocumentReader
Detailed information on the associated delivery note on position level
public function getDocumentPositionDeliveryNoteReferencedDocument(
?string $issuerAssignedId,
?string $lineId,
?DateTime $issueDate,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| issuerAssignedId | string | ✔️ | BT-X-92, From EXTENDED Delivery note number |
| lineId | string | ✔️ | BT-X-93, From EXTENDED Delivery note position |
| issueDate | DateTime | ✔️ | BT-X-94, From EXTENDED Date of Delivery note |
Returns a value of type \ZugferdDocumentReader
Seek to the first document position tax. Returns true if the first tax position is available, otherwise false
You may use it together with ZugferdDocumentReader::getDocumentPositionTax
public function firstDocumentPositionTax(): bool
{
}Returns a value of type bool
Seek to the next document position tax. Returns true if another tax position is available, otherwise false
You may use it together with ZugferdDocumentReader::getDocumentPositionTax
public function nextDocumentPositionTax(): bool
{
}Returns a value of type bool
Get information about the sales tax that applies to the goods and services invoiced
in the relevant invoice line
public function getDocumentPositionTax(
?string $categoryCode,
?string $typeCode,
?float $rateApplicablePercent,
?float $calculatedAmount,
?string $exemptionReason,
?string $exemptionReasonCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| categoryCode | string | ✔️ | BT-151, From BASIC Coded description of a sales tax category |
| typeCode | string | ✔️ | BT-151-0, From BASIC In EN 16931 only the tax type “sales tax” with the code “VAT” is supported. Should other types of tax be specified, such as an insurance tax or a mineral oil tax the EXTENDED profile must be used. The code for the tax type must then be taken from the code list UNTDID 5153. |
| rateApplicablePercent | float | ✔️ | BT-152, From BASIC The VAT rate applicable to the item invoiced and expressed as a percentage. Note: The code of the sales tax category and the category-specific sales tax rate must correspond to one another. The value to be given is the percentage. For example, the value 20 is given for 20% (and not 0.2) |
| calculatedAmount | float | ✔️ | Tax amount. Information only for taxes that are not VAT (Obsolete) |
| exemptionReason | string | ✔️ | Reason for tax exemption (free text) (Obsolete) |
| exemptionReasonCode | string | ✔️ | Reason given in code form for the exemption of the amount from VAT. Note: Code list issued and maintained by the Connecting Europe Facility. (Obsolete) |
Returns a value of type \ZugferdDocumentReader
Get information about the period relevant for the invoice item.
Note: Also known as the invoice line delivery period.
public function getDocumentPositionBillingPeriod(?DateTime $startDate, ?DateTime $endDate): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| startDate | DateTime | ✔️ | BT-134, From BASIC Start of the billing period |
| endDate | DateTime | ✔️ | BT-135, From BASIC End of the billing period |
Returns a value of type \ZugferdDocumentReader
Seek to the first allowance charge (on position level). Returns true if the first position is available, otherwise false
You may use it together with ZugferdDocumentReader::getDocumentPositionAllowanceCharge
public function firstDocumentPositionAllowanceCharge(): bool
{
}Returns a value of type bool
Seek to the next allowance charge (on position level). Returns true if another position is available, otherwise false
You may use it together with ZugferdDocumentReader::getDocumentPositionAllowanceCharge
public function nextDocumentPositionAllowanceCharge(): bool
{
}Returns a value of type bool
Detailed information on currentley seeked surcharges and discounts on position level
public function getDocumentPositionAllowanceCharge(
?float $actualAmount,
?bool $isCharge,
?float $calculationPercent,
?float $basisAmount,
?string $reason,
?string $taxTypeCode,
?string $taxCategoryCode,
?float $rateApplicablePercent,
?float $sequence,
?float $basisQuantity,
?string $basisQuantityUnitCode,
?string $reasonCode,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| actualAmount | float | ✔️ | BT-136/BT-141, From BASIC The surcharge/discount amount excluding sales tax |
| isCharge | bool | ✔️ | BT-27-1/BT-28-1, From BASIC (true for BT-/ and false for /BT-) Switch that indicates whether the following data refer to an allowance or a discount, true means that it is a surcharge |
| calculationPercent | float | ✔️ | BT-138, From BASIC The percentage that may be used in conjunction with the base invoice line discount amount to calculate the invoice line discount amount |
| basisAmount | float | ✔️ | BT-137, From EN 16931 The base amount that may be used in conjunction with the invoice line discount percentage to calculate the invoice line discount amount |
| reason | string | ✔️ | BT-139/BT-144, From BASIC The reason given in text form for the invoice item discount/surcharge |
| taxTypeCode | string | ✔️ | |
| taxCategoryCode | string | ✔️ | |
| rateApplicablePercent | float | ✔️ | |
| sequence | float | ✔️ | |
| basisQuantity | float | ✔️ | |
| basisQuantityUnitCode | string | ✔️ | |
| reasonCode | string | ✔️ | BT-140/BT-145, From BASIC The reason given as a code for the invoice line discount |
Returns a value of type \ZugferdDocumentReader
Detailed information on surcharges and discounts on position level (on a simple way)
This is the simplified version of ZugferdDocumentReader::getDocumentPositionAllowanceCharge
public function getDocumentPositionAllowanceCharge2(
?float $actualAmount,
?bool $isCharge,
?float $calculationPercent,
?float $basisAmount,
?string $reasonCode,
?string $reason,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| actualAmount | float | ✔️ | BT-136/BT-141, From BASIC The surcharge/discount amount excluding sales tax |
| isCharge | bool | ✔️ | BT-27-1/BT-28-1, From BASIC (true for BT-/ and false for /BT-) Switch that indicates whether the following data refer to an allowance or a discount, true means that it is a surcharge |
| calculationPercent | float | ✔️ | BT-138, From BASIC The percentage that may be used in conjunction with the base invoice line discount amount to calculate the invoice line discount amount |
| basisAmount | float | ✔️ | BT-137, From EN 16931 The base amount that may be used in conjunction with the invoice line discount percentage to calculate the invoice line discount amount |
| reasonCode | string | ✔️ | BT-140/BT-145, From BASIC The reason given as a code for the invoice line discount |
| reason | string | ✔️ | BT-139/BT-144, From BASIC The reason given in text form for the invoice item discount/surcharge |
Returns a value of type \ZugferdDocumentReader
Caution
Deprecated 1.0.88
Get detailed information on item totals
public function getDocumentPositionLineSummation(
?float $lineTotalAmount,
?float $totalAllowanceChargeAmount,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineTotalAmount | float | ✔️ | BT-131, From BASIC The total amount of the invoice item. |
| totalAllowanceChargeAmount | float | ✔️ | Total amount of item surcharges and discounts |
Returns a value of type \ZugferdDocumentReader
Get detailed information on item totals
public function getDocumentPositionLineSummationSimple(?float $lineTotalAmount): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineTotalAmount | float | ✔️ | BT-131, From BASIC The total amount of the invoice item. |
Returns a value of type \ZugferdDocumentReader
Get detailed information on item totals (with support for EXTENDED profile)
public function getDocumentPositionLineSummationExt(
?float $lineTotalAmount,
?float $chargeTotalAmount,
?float $allowanceTotalAmount,
?float $taxTotalAmount,
?float $grandTotalAmount,
?float $totalAllowanceChargeAmount,
): \ZugferdDocumentReader
{
}| Name | Type | Allows Null | Description |
|---|---|---|---|
| lineTotalAmount | float | ✔️ | BT-131, From BASIC The total amount of the invoice item |
| chargeTotalAmount | float | ✔️ | BT-X-327, From EXTENDED Total amount of item surcharges |
| allowanceTotalAmount | float | ✔️ | BT-X-328, From EXTENDED Total amount of item discounts |
| taxTotalAmount | float | ✔️ | BT-X-329, From EXTENDED Total amount of item taxes |
| grandTotalAmount | float | ✔️ | BT-X-330, From EXTENDED Total gross amount of the item |
| totalAllowanceChargeAmount | float | ✔️ | BT-X-98, From EXTENDED Total amount of item surcharges and discounts |
Returns a value of type \ZugferdDocumentReader