ZUGFeRD

https://github.com/horstoeko/zugferd
Admin
ZUGFeRD is a PHP library for creating and reading European electronic invoices in multiple formats...
Tokens:240,688
Snippets:3,439
Trust Score:8.6
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### getYamlDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the assets are stored.

```APIDOC
## getYamlDirectory

### Description
Get the directory where all the assets are stored

### Method
static

### Returns
string
```

--------------------------------

### getRootDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get root directory.

```APIDOC
## getRootDirectory

### Description
Get root directory

### Method
static

### Returns
string
```

--------------------------------

### getAssetDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the assets are stored.

```APIDOC
## getAssetDirectory

### Description
Get the directory where all the assets are stored

### Method
static

### Returns
string
```

--------------------------------

### Running Validation

Source: https://github.com/horstoeko/zugferd/wiki/Validation

Provides examples of how to initiate the validation process using the `validate` method.

```APIDOC
## Run Validation

To start a validation, use the ``validate`` method

```php
$document = ZugferdDocumentPdfReader::readAndGuessFromFile(dirname(__FILE__) . "/invoice.pdf");

$kositValidator = new ZugferdKositValidator($document)
$kositValidator->validate();
```

or

```php
$document = ZugferdDocumentPdfReader::readAndGuessFromFile(dirname(__FILE__) . "/invoice.pdf");

$kositValidator = new ZugferdKositValidator()
$kositValidator->setDocument($document)->validate();
```
```

--------------------------------

### Install horstoeko/zugferd via Composer

Source: https://github.com/horstoeko/zugferd/wiki/Installation

Use this command to add the horstoeko/zugferd library to your project's dependencies.

```sh
composer require horstoeko/zugferd
```

--------------------------------

### getDocumentPositionReferencedProduct

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Get detailed information on included products.

```APIDOC
## public function getDocumentPositionReferencedProduct(?string $name, ?string $description, ?string $sellerAssignedID, ?string $buyerAssignedID, ?array $globalID, ?float $unitQuantity, ?string $unitCode, ?string $industryAssignedID): \ZugferdDocumentReader

### Description
Get detailed information on included products. This information relates to the product that has just been added.

### Parameters
- **name** (string) - Optional - BT-X-18, From EXTENDED Name of the referenced product.
- **description** (string) - Optional - BT-X-19, From EXTENDED Description of the included referenced product.
- **sellerAssignedID** (string) - Optional - BT-X-16, From EXTENDED ID assigned by the seller.
- **buyerAssignedID** (string) - Optional - BT-X-17, From EXTENDED ID assigned by the buyer.
- **globalID** (array) - Optional - BT-X-15, From EXTENDED Array of global ids.
- **unitQuantity** (float) - Optional - BT-X-20, From EXTENDED Quantity of the referenced product.
- **unitCode** (string) - Optional - BT-X-20-1, From EXTENDED Unit code of quantity.
- **industryAssignedID** (string) - Optional - BT-X-309, From EXTENDED ID assigned by the industry.

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### Get Product End User Address

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the full address details for the product end user.

```php
public function getDocumentProductEndUserAddress(
  ?string $lineOne,
  ?string $lineTwo,
  ?string $lineThree,
  ?string $postCode,
  ?string $city,
  ?string $country,
  ?array $subDivision,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Product End User Information

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves general information about the product end user, including name, identifiers, and description.

```php
public function getDocumentProductEndUser(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Root Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the root directory of the project.

```php
public static function getRootDirectory(): string
{
}

```

--------------------------------

### Get Source Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all source files are stored.

```php
public static function getSourceDirectory(): string
{
}

```

--------------------------------

### getFullXmpMetaDataFilename

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the full filename containing the XNP information to use.

```APIDOC
## getFullXmpMetaDataFilename

### Description
Get the full filename containg the XNP information to user

### Method
static

### Returns
string
```

--------------------------------

### Get product end-user contact details

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves detailed information for the current product end-user contact person.

```php
public function getDocumentProductEndUserContact(
  ?string $contactPersonName,
  ?string $contactDepartmentName,
  ?string $contactPhoneNo,
  ?string $contactFaxNo,
  ?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Retrieve buyer information

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Use this method to get the buyer's name, identifiers, and legal description.

```php
public function getDocumentBuyer(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get product end-user legal organization

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the legal organization details for the product end user.

```php
public function getDocumentProductEndUserLegalOrganisation(
  ?string $legalOrgId,
  ?string $legalOrgType,
  ?string $legalOrgName,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Example: Set Additional Creator Tool and Generate Document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfBuilder

Demonstrates how to set an additional creator tool, generate the document, and save it. The creator information in the PDF will reflect both the library and the specified ERP solution.

```php
// Before calling this method the creator of the PDF is identified as 'Factur-X library 1.x.x by HorstOeko'.
// After calling this method you get 'MyERPSolution 1.0 / Factur-X PHP library 1.x.x by HorstOeko' as the creator

$zugferdDocumentPdfBuilder = ZugferdDocumentPdfBuilder::fromPdfFile($zugferdDocumentBuilder, '/tmp/existingprintlayout.pdf');
$zugferdDocumentPdfBuilder->setAdditionalCreatorTool('MyERPSolution 1.0');
$zugferdDocumentPdfBuilder->generateDocument();
$zugferdDocumentPdfBuilder->saveDocument('/tmp/merged.pdf');

```

--------------------------------

### Retrieve document billing period

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Gets detailed information regarding the start and end dates of the billing period.

```php
public function getDocumentBillingPeriod(?DateTime $startDate, ?DateTime $endDate): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get XMP Meta Data Filename (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the configured filename for XMP meta data. Call this to get the current XMP filename.

```php
public static function getXmpMetaDataFilename(): string
{
}
```

--------------------------------

### Initialize new document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Initializes a new document using the configured profile settings.

```php
public function initNewDocument(): \ZugferdDocumentBuilder
{
}
```

--------------------------------

### Instantiating ZugferdDocumentPdfMerger

Source: https://github.com/horstoeko/zugferd/wiki/Merging-XML-and-PDF-Documents

Demonstrates how to instantiate the ZugferdDocumentPdfMerger class with various combinations of file paths and data streams for XML and PDF.

```APIDOC
## Instantiating ZugferdDocumentPdfMerger

### Description
Instantiate the `ZugferdDocumentPdfMerger` class by providing either file paths or data streams for the XML and PDF inputs.

### Constructor Parameters
- **xml**: (string) A fully-qualified path to a valid XML file or the XML data stream.
- **pdf**: (string) A fully-qualified path to a PDF file or a PDF data stream.

### Examples

#### Using file paths:
```php
$xmlFilename = '/path/to/existing/xml.xml';
$pdfFilename = '/path/to/existing/pdf.pdf';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlFilename, $pdfFilename);
```

#### Using XML data stream and PDF file path:
```php
$xmlData = '<xml>....</xml>';
$pdfFilename = '/path/to/existing/pdf.pdf';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlData, $pdfFilename);
```

#### Using XML file path and PDF data stream:
```php
$xmlFilename = '/path/to/existing/xml.xml';
$pdData = '%PDF-1.5.......';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlFilename, $pdfData);
```

#### Using XML data stream and PDF data stream:
```php
$xmlData = '<xml>....</xml>';
$pdData = '%PDF-1.5.......';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlData, $pdfData);
```
```

--------------------------------

### Constructor (__construct)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfMerger

Initializes the ZugferdDocumentPdfMerger with XML data and a PDF file or data.

```APIDOC
## __construct

### Summary

_Constructor_

### Signature

```php
public function __construct(string $xmlDataOrFilename, string $pdfData): void
{
}
```

### Parameters

| Name | Type | Allows Null | Description
| :------ | :------ | :-----: | :------
| xmlDataOrFilename | string | :x: | <br/>The XML data as a string or the full qualified path to an XML-File<br/>containing the XML-data
| pdfData | string | :x: | <br/>The full filename or a string containing the binary pdf data. This<br/>is the original PDF (e.g. created by a ERP system)
```

--------------------------------

### XML Invoice Structure Example

Source: https://github.com/horstoeko/zugferd/wiki/Creating-XML-Documents

This snippet shows a basic XML structure for an invoice, including seller details, tax information, and currency.

```xml
<ram:LineOne>Lieferantenstraße 20</ram:LineOne>
          <ram:CityName>München</ram:CityName>
          <ram:CountryID>DE</ram:CountryID>
        </ram:PostalTradeAddress>
        <ram:SpecifiedTaxRegistration>
          <ram:ID schemeID="FC">201/113/40209</ram:ID>
        </ram:SpecifiedTaxRegistration>
        <ram:SpecifiedTaxRegistration>
          <ram:ID schemeID="VA">DE123456789</ram:ID>
        </ram:SpecifiedTaxRegistration>
      </ram:SellerTradeParty>
    </ram:ApplicableHeaderTradeAgreement>
    <ram:ApplicableHeaderTradeDelivery/>
    <ram:ApplicableHeaderTradeSettlement>
      <ram:InvoiceCurrencyCode>EUR</ram:InvoiceCurrencyCode>
    </ram:ApplicableHeaderTradeSettlement>
  </rsm:SupplyChainTradeTransaction>
</rsm:CrossIndustryInvoice>
```

--------------------------------

### Navigate Referenced Products in PHP

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Methods to iterate through document position referenced products.

```php
public function firstDocumentPositionReferencedProduct(): bool
{
}
```

```php
public function nextDocumentPositionReferencedProduct(): bool
{
}
```

--------------------------------

### getSourceDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the sources are stored.

```APIDOC
## getSourceDirectory

### Description
Get the directory where all the sources are stored

### Method
static

### Returns
string
```

--------------------------------

### Navigate Product Classifications in PHP

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Methods to iterate through document position product classifications.

```php
public function firstDocumentPositionProductClassification(): bool
{
}
```

```php
public function nextDocumentPositionProductClassification(): bool
{
}
```

--------------------------------

### Get Product End User Tax Registration

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves tax registration details for the product end user.

```php
public function getDocumentProductEndUserTaxRegistration(?array $taxReg): \ZugferdDocumentReader
{
}
```

--------------------------------

### getDocumentPositionProductClassification

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Get detailed information on product classification.

```APIDOC
## public function getDocumentPositionProductClassification(?string $classCode, ?string $className, ?string $listID, ?string $listVersionID): \ZugferdDocumentReader

### Description
Get detailed information on product classification.

### Parameters
- **classCode** (string) - Optional - BT-158, From EN 16931 Item classification identifier.
- **className** (string) - Optional - BT-X-138, From EXTENDED Name with which an article can be classified.
- **listID** (string) - Optional - BT-158-1, From EN 16931 The identifier for the identification scheme.
- **listVersionID** (string) - Optional - BT-158-2, From EN 16931 The version of the identification scheme.

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### Create new document builder instance

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Static factory method to initialize a builder with a specific profile ID.

```php
public static function createNew(int $profileId): \ZugferdDocumentBuilder
{
}
```

--------------------------------

### Create Validator from File

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdPdfValidator

Instantiates a ZugferdPdfValidator from an existing PDF file. Requires a JAVA running setup.

```php
public static function fromFile(string $pdfFilename): \ZugferdPdfValidator
{
}
```

--------------------------------

### getDocumentPositionProductDetails

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Get information about the goods and services billed.

```APIDOC
## getDocumentPositionProductDetails

### Description
Get information about the goods and services billed.

### Signature
`public function getDocumentPositionProductDetails(?string $name, ?string $description, ?string $sellerAssignedID, ?string $buyerAssignedID, ?string $globalIDType, ?string $globalID): \ZugferdDocumentReader`

### Parameters
- **name** (string) - Optional - BT-153, From BASIC: A name of the item
- **description** (string) - Optional - BT-154, From EN 16931: A description of the item
- **sellerAssignedID** (string) - Optional - BT-155, From EN 16931: An identifier assigned to the item by the seller
- **buyerAssignedID** (string) - Optional - BT-156, From EN 16931: An identifier assigned to the item by the buyer
- **globalIDType** (string) - Optional - BT-157-1, From BASIC: The scheme for globalID
- **globalID** (string) - Optional - BT-157, From BASIC: Identification of an article according to the registered scheme

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### Initialize ZugferdDocumentBuilder for XRECHNUNG 3 Profile

Source: https://github.com/horstoeko/zugferd/wiki/Example-ZugferdDocumentBuilder-in-XRECHNUNG3-profile

This snippet shows how to create a new document builder instance specifically configured for the XRECHNUNG 3 profile. Ensure the vendor autoloader is included.

```php
use horstoeko\zugferd\codelists\ZugferdCountryCodes;
use horstoeko\zugferd\codelists\ZugferdCurrencyCodes;
use horstoeko\zugferd\codelists\ZugferdElectronicAddressScheme;
use horstoeko\zugferd\codelists\ZugferdInvoiceType;
use horstoeko\zugferd\codelists\ZugferdReferenceCodeQualifiers;
use horstoeko\zugferd\codelists\ZugferdUnitCodes;
use horstoeko\zugferd\codelists\ZugferdVatCategoryCodes;
use horstoeko\zugferd\codelists\ZugferdVatTypeCodes;
use horstoeko\zugferd\ZugferdDocumentBuilder;
use horstoeko\zugferd\ZugferdProfiles;

require __DIR__ . "/../vendor/autoload.php";

$documentBuilder = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_XRECHNUNG_3);
```

--------------------------------

### Initialize ZugferdDocumentBuilder

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfBuilder

Initializes a new ZugferdDocumentBuilder instance with a specified profile and sets basic document information.

```php
use horstoeko\zugferd\codelists\ZugferdCurrencyCodes;
use horstoeko\zugferd\codelists\ZugferdInvoiceType;
use horstoeko\zugferd\ZugferdDocumentBuilder;
use horstoeko\zugferd\ZugferdProfiles;

// Build the XML using ZugferdDocumentBuilder

$zugferdDocumentBuilder = ZugferdDocumentBuilder::CreateNew(ZugferdProfiles::PROFILE_EN16931);
$zugferdDocumentBuilder
    ->setDocumentInformation('R-2024/00001', ZugferdInvoiceType::INVOICE, DateTime::createFromFormat('Ymd', '20241231'), ZugferdCurrencyCodes::EURO)
    ->......
```

--------------------------------

### getDocumentPositionGenerals

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Get general information of the current position.

```APIDOC
## getDocumentPositionGenerals

### Description
Get general information of the current position.

### Signature
`public function getDocumentPositionGenerals(?string $lineId, ?string $lineStatusCode, ?string $lineStatusReasonCode): \ZugferdDocumentReader`

### Parameters
- **lineId** (string) - Optional - BT-126, From BASIC: Identification of the invoice item
- **lineStatusCode** (string) - Optional - 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) - Optional - BT-X-8, From EXTENDED: Adds the type to specify whether the invoice line is.

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### getValidationDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the validation files are located.

```APIDOC
## getValidationDirectory

### Description
Get the directory where all the validation files are located

### Method
static

### Returns
string
```

--------------------------------

### Get document seller information

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves detailed information about the seller, including name, identifiers, and legal descriptions.

```php
public function getDocumentSeller(?string $name, ?array $id, ?string $description): \ZugferdDocumentReader
{
}
```

--------------------------------

### getDocumentPositionAdditionalReferencedObjDocument

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Gets additional document reference information on a position.

```APIDOC
## getDocumentPositionAdditionalReferencedObjDocument

### Description
Get additional Document reference on a position (Object detection).

### Signature
`public function getDocumentPositionAdditionalReferencedObjDocument(?string $issuerAssignedId, ?string $typeCode, ?string $refTypeCode): \ZugferdDocumentReader`

### Parameters
- **issuerAssignedId** (string) - Optional - BT-128, From EN 16931: The identifier of the tender or lot to which the invoice relates.
- **typeCode** (string) - Optional - BT-128-0, From EN 16931: Type of referenced document (See codelist UNTDID 1001)
- **refTypeCode** (string) - Optional - BT-128-1, From EN 16931: The identifier for the identification scheme of the identifier of the item invoiced.

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### Set Document Ship-From Details

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Sets the name, ID, and description for the deviating consignor party.

```php
public function setDocumentShipFrom(
  ?string $name = null,
  ?string $id = null,
  ?string $description = null,
): \ZugferdDocumentBuilder
{
}
```

--------------------------------

### getDocumentPositionNote

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Get detailed information on the free text on the position.

```APIDOC
## getDocumentPositionNote

### Description
Get detailed information on the free text on the position.

### Signature
`public function getDocumentPositionNote(?string $content, ?string $contentCode, ?string $subjectCode): \ZugferdDocumentReader`

### Parameters
- **content** (string) - Optional - BT-127, From BASIC: A free text that contains unstructured information that is relevant to the invoice item
- **contentCode** (string) - Optional - BT-X-9, From EXTENDED: A code to classify the content of the free text of the invoice.
- **subjectCode** (string) - Optional - BT-X-10, From EXTENDED: Code for qualifying the free text for the invoice item (Codelist UNTDID 4451)

### Returns
- **\ZugferdDocumentReader** - Returns the reader instance.
```

--------------------------------

### Instantiate ZugferdDocumentPdfMerger with XML file and PDF file

Source: https://github.com/horstoeko/zugferd/wiki/Merging-XML-and-PDF-Documents

Use this constructor when you have the XML and PDF as separate files on the filesystem. Ensure the paths are fully qualified.

```php
$xmlFilename = '/path/to/existing/xml.xml';
$pdfFilename = '/path/to/existing/pdf.pdf';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlFilename, $pdfFilename)
```

--------------------------------

### getFullIccProfileFilename

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the full filename of the ICC profile to use.

```APIDOC
## getFullIccProfileFilename

### Description
Get the full filename of the ICC profile to use

### Method
static

### Returns
string
```

--------------------------------

### Create New Invoice in XRECHNUNG-Profile (Version 3.x)

Source: https://github.com/horstoeko/zugferd/wiki/Example-ZugferdDocumentBuilder-in-XRECHNUNG3-profile

Initialize a new ZugferdDocumentBuilder instance for the XRECHNUNG 3 profile.

```php
$documentBuilder = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_XRECHNUNG_3);
```

--------------------------------

### getXsltDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the stylesheets (XSLT) files are located.

```APIDOC
## getXsltDirectory

### Description
Get the directory where all the stylesheets (XSLT) files are located

### Method
static

### Returns
string
```

--------------------------------

### Create New Invoice

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Initializes a new invoice document with essential details like invoice number, date, and currency. An optional reference number can be provided.

```php
public function doCreateInvoice(
  string $invoiceNo,
  DateTime $invoiceDate,
  string $currency,
  ?string $invoiceNoReference = null,
): \ZugferdQuickDescriptor
{
}

```

--------------------------------

### getSchematronDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the stylesheets (XSLT) files are located.

```APIDOC
## getSchematronDirectory

### Description
Get the directory where all the stylesheets (XSLT) files are located

### Method
static

### Returns
string
```

--------------------------------

### getSchemaDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Get the directory where all the schema (XSD) files are located.

```APIDOC
## getSchemaDirectory

### Description
Get the directory where all the schema (XSD) files are located

### Method
static

### Returns
string
```

--------------------------------

### Get Full XMP Metadata Filename (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the full filename containing the XMP metadata information to be used.

```php
public static function getFullXmpMetaDataFilename(): string
{
}

```

--------------------------------

### Download PDF as String

Source: https://github.com/horstoeko/zugferd/blob/master/make/md/ZugferdDocumentPdfBuilder.md

Generates a PDF document and returns its binary content as a string, allowing for direct download or further processing.

```php
$zugferdDocumentPdfBuilder = ZugferdDocumentPdfBuilder::fromPdfFile($zugferdDocumentBuilder, '/tmp/existingprintlayout.pdf');
$zugferdDocumentPdfBuilder->generateDocument();
$pdfBinaryString = $zugferdDocumentPdfBuilder->generateDocument()->downloadString();
```

--------------------------------

### Get document summation

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Reads the monetary summation values for the document.

```php
public function getDocumentSummation(
  ?float $grandTotalAmount,
  ?float $duePayableAmount,
  ?float $lineTotalAmount,
  ?float $chargeTotalAmount,
  ?float $allowanceTotalAmount,
  ?float $taxBasisTotalAmount,
  ?float $taxTotalAmount,
  ?float $roundingAmount,
  ?float $totalPrepaidAmount,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get document copy indicator

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Checks if the document is a copy of the original.

```php
public function getIsDocumentCopy(?bool $copyIndicator): \ZugferdDocumentReader
{
}
```

--------------------------------

### Set Document Buyer Details

Source: https://github.com/horstoeko/zugferd/wiki/Example-ZugferdDocumentBuilder-in-EN16391-profile

Configure the buyer's information including name, ID, address, contact person, and electronic communication details.

```php
$documentBuilder->setDocumentBuyer('Kunden AG Mitte', 'GE2020211');
$documentBuilder->setDocumentBuyerAddress('Kundenstraße 15', '', '', '69876', 'Frankfurt', ZugferdCountryCodes::GERMANY);
$documentBuilder->setDocumentBuyerContact('H. Meier', 'Einkauf', '+49-333-4444444', '+49-333-5555555', 'hm@kunde.de');
$documentBuilder->setDocumentBuyerCommunication(ZugferdElectronicAddressScheme::UNECE3155_EM, 'purchase@kunde.de');
```

--------------------------------

### Seek to first ultimate customer order referenced document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Initializes the pointer to the first ultimate customer order referenced document at the position level.

```php
public function firstDocumentPositionUltimateCustomerOrderReferencedDocument(): bool
{
}
```

--------------------------------

### Instantiate ZugferdDocumentPdfMerger with XML data and PDF file

Source: https://github.com/horstoeko/zugferd/wiki/Merging-XML-and-PDF-Documents

Use this constructor when you have the XML content as a string and the PDF as a file. The XML data should be a valid XML string.

```php
$xmlData = '<xml>....</xml>';
$pdfFilename = '/path/to/existing/pdf.pdf';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlData, $pdfFilename)
```

--------------------------------

### Get Validation Information

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdKositValidator

Returns an array containing all validation information.

```php
public function getValidationInformation(): array
{
}
```

--------------------------------

### Set Buyer Information - PHP

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Set detailed information about the buyer, including name, address, and optional references or IDs. All address fields are mandatory.

```php
public function doSetBuyer(
  string $name,
  string $postcode,
  string $city,
  string $street,
  string $country,
  ?string $buyerReference = null,
  ?string $id = null,
  ?string $globalID = null,
  ?string $globalIDscheme = null,
): 
ZugferdQuickDescriptor
{
}
```

--------------------------------

### Adding Seller Information in Correct Order

Source: https://github.com/horstoeko/zugferd/wiki/Creating-XML-Documents

This example shows the correct order of operations, calling `setDocumentSeller` before `addDocumentSellerGlobalId`. This ensures that the seller's details, including their ID, name, address, and contact information, are properly included in the generated XML.

```php
$document = ZugferdDocumentBuilder::CreateNew(ZugferdProfiles::PROFILE_EN16931);
$document
    ->setDocumentInformation("471102", "380", \DateTime::createFromFormat("Ymd", "20180305"), "EUR")
    ->setDocumentSeller("Lieferant GmbH", "549910")
    ->addDocumentSellerGlobalId("4000001123452", "0088")
    ->addDocumentSellerTaxRegistration("FC", "201/113/40209")
    ->addDocumentSellerTaxRegistration("VA", "DE123456789")
    ->setDocumentSellerAddress("Lieferantenstraße 20", "", "", "80333", "München", "DE")
    ->setDocumentSellerContact("Heinz Mükker", "Buchhaltung", "+49-111-2222222", "+49-111-3333333","info@lieferant.de")
    ->writeFile(dirname(__FILE__) . "/factur-x.xml");
```

```xml
<rsm:CrossIndustryInvoice xmlns:rsm="urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100" xmlns:a="urn:un:unece:uncefact:data:standard:QualifiedDataType:100" xmlns:qdt="urn:un:unece:uncefact:data:standard:QualifiedDataType:10" xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:udt="urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <rsm:ExchangedDocumentContext>
    <ram:GuidelineSpecifiedDocumentContextParameter>
      <ram:ID>urn:cen.eu:en16931:2017</ram:ID>
    </ram:GuidelineSpecifiedDocumentContextParameter>
  </rsm:ExchangedDocumentContext>
  <rsm:ExchangedDocument>
    <ram:ID>471102</ram:ID>
    <ram:TypeCode>380</ram:TypeCode>
    <ram:IssueDateTime>
      <udt:DateTimeString format="102">20180305</udt:DateTimeString>
    </ram:IssueDateTime>
  </rsm:ExchangedDocument>
  <rsm:SupplyChainTradeTransaction>
    <ram:ApplicableHeaderTradeAgreement>
      <ram:SellerTradeParty>
        <ram:ID>549910</ram:ID>
        <ram:GlobalID schemeID="0088">4000001123452</ram:GlobalID>
        <ram:Name>Lieferant GmbH</ram:Name>
        <ram:DefinedTradeContact>
          <ram:PersonName>Heinz Mükker</ram:PersonName>
          <ram:DepartmentName>Buchhaltung</ram:DepartmentName>
          <ram:TelephoneUniversalCommunication>
            <ram:CompleteNumber>+49-111-2222222</ram:CompleteNumber>
          </ram:TelephoneUniversalCommunication>
          <ram:EmailURIUniversalCommunication>
            <ram:URIID>info@lieferant.de</ram:URIID>
          </ram:EmailURIUniversalCommunication>
        </ram:DefinedTradeContact>
        <ram:PostalTradeAddress>
          <ram:PostcodeCode>80333</ram:PostcodeCode>

```

--------------------------------

### Get document content as string

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Writes the CrossIndustryInvoice object content to a string.

```php
public function getContent(): string
{
}
```

--------------------------------

### Get contract referenced document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves details of the related contract position.

```php
public function getDocumentPositionContractReferencedDocument(
  ?string $issuerAssignedId,
  ?string $lineId,
  ?DateTime $issueDate,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Navigate to the first allowance charge

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Initializes the pointer to the first allowance charge at the position level, returning a boolean status.

```php
public function firstDocumentPositionAllowanceCharge(): bool
{
}
```

--------------------------------

### Run Validation with Document Instance

Source: https://github.com/horstoeko/zugferd/wiki/Validation

Initiate the validation process by providing a ZugferdDocument instance directly to the validate method. This is an alternative to setting the document beforehand.

```php
$document = ZugferdDocumentPdfReader::readAndGuessFromFile(dirname(__FILE__) . "/invoice.pdf");

$kositValidator = new ZugferdKositValidator($document)
$kositValidator->validate();
```

--------------------------------

### Get quotation referenced document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves details of the associated offer position.

```php
public function getDocumentPositionQuotationReferencedDocument(
  ?string $issuerAssignedId,
  ?string $lineId,
  ?DateTime $issueDate,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Ship-To Address

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the postal address components for the Ship-To party.

```php
public function getDocumentShipToAddress(
  ?string $lineOne,
  ?string $lineTwo,
  ?string $lineThree,
  ?string $postCode,
  ?string $city,
  ?string $country,
  ?array $subDivision,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Configure Payment Means and Terms

Source: https://github.com/horstoeko/zugferd/wiki/Example-ZugferdDocumentBuilder-in-EN16391-profile

Sets up payment details, including direct debit information with mandate references and specific payment terms with due dates. This ensures correct payment processing and reconciliation.

```php
$documentBuilder->addDocumentPaymentMeanToDirectDebit('DE12500105170648489890', 'R-2024/00001');
$documentBuilder->addDocumentPaymentTerm('Wird von Konto DE12500105170648489890 abgebucht', DateTime::createFromFormat('Ymd', '20250131'), 'MANDATE-2024/000001');
```

--------------------------------

### doCreateNew

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Creates a new ZugferdDocumentBuilder instance with the EN16931 profile.

```APIDOC
## doCreateNew

### Description
Creates a new ZugferdDocumentBuilder with profile EN16931.

### Method
`static`

### Returns
Returns a value of type `\ZugferdQuickDescriptor`
```

--------------------------------

### Get Ship-To global identifier

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the global identifier for the Ship-To party.

```php
public function getDocumentShipToGlobalId(?array $globalID): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Buyer Address

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the address details of the buyer trade party.

```php
public function getDocumentBuyerAddress(
  ?string $lineOne,
  ?string $lineTwo,
  ?string $lineThree,
  ?string $postCode,
  ?string $city,
  ?string $country,
  ?array $subDivision,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Create ZugferdDocumentPdfBuilder from PDF File

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfBuilder

Initializes a ZugferdDocumentPdfBuilder instance using an existing PDF file as a base. This is a static method.

```php
public static function fromPdfFile(
  horstoeko\zugferd\ZugferdDocumentBuilder $documentBuilder,
  string $pdfFileName,
): void
{
}
```

--------------------------------

### Seek to first product end-user contact

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Moves the internal pointer to the first contact person of the product end user.

```php
public function firstDocumentProductEndUserContactContact(): bool
{
}
```

--------------------------------

### Get Document Seller Global ID

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the global identifiers of the seller.

```php
public function getDocumentSellerGlobalId(?array $globalID): \ZugferdDocumentReader
{
}
```

--------------------------------

### Download PDF as String

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfBuilder

Generates the PDF invoice and returns its binary content as a string, suitable for direct download or further processing.

```php
use horstoeko\zugferd\ZugferdDocumentPdfBuilder;

// Alternatively, you can also return the merged output as a content stream (string)

$zugferdDocumentPdfBuilder = ZugferdDocumentPdfBuilder::fromPdfFile($zugferdDocumentBuilder, '/tmp/existingprintlayout.pdf');
$zugferdDocumentPdfBuilder->generateDocument();
$pdfBinaryString = $zugferdDocumentPdfBuilder->generateDocument()->downloadString();
```

--------------------------------

### Get test document indicator

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Checks if the document is intended for test purposes only.

```php
public function getIsTestDocument(?bool $testDocumentIndicator): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Validation Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all validation files are located.

```php
public static function getValidationDirectory(): string
{
}

```

--------------------------------

### Create New Credit Memo

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Initializes a new credit memo document with its number, date, currency, and an optional reference number for the refund.

```php
public function doCreateCreditMemo(
  string $creditMemoNo,
  DateTime $invoiceDate,
  string $currency,
  string $creditMemoNoReference = '',
): \ZugferdQuickDescriptor
{
}

```

--------------------------------

### Get Asset Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all asset files are stored.

```php
public static function getAssetDirectory(): string
{
}

```

--------------------------------

### Instantiate ZugferdDocumentPdfMerger with XML file and PDF data

Source: https://github.com/horstoeko/zugferd/wiki/Merging-XML-and-PDF-Documents

Use this constructor when you have the XML as a file and the PDF content as a string. The PDF data should be a valid PDF string.

```php
$xmlFilename = '/path/to/existing/xml.xml';
$pdData = '%PDF-1.5.......';
$pdfMerger = new ZugferdDocumentPdfMerger($xmlFilename, $pdData)
```

--------------------------------

### Create PDF with Existing Binary Content

Source: https://github.com/horstoeko/zugferd/wiki/Creating-PDF-Documents

Instantiate ZugferdDocumentPdfBuilder with the binary content of an existing PDF. This allows attaching XML to PDFs loaded from memory.

```php
$pdfContent = file_get_contents('/path/to/existing/pdf.pdf');
$pdfDocument = new ZugferdDocumentPdfBuilder($document, $pdfContent);
```

--------------------------------

### Set Specified Procuring Project in PHP

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Sets details of a project reference. Requires a project ID and name as strings.

```php
public function doSetSpecifiedProcuringProject(string $id, string $name): 
ZugferdQuickDescriptor
{
}
```

--------------------------------

### Get Remote Mode URL

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdKositValidator

Returns the full remote mode URL.

```php
public function getRemoteModeUrl(): string
{
}
```

--------------------------------

### Get document content as DOMXPath

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Writes the invoice object content to a DOMXpath instance.

```php
public function getContentAsDomXPath(): \DOMXpath
{
}
```

--------------------------------

### Get document content as DOMDocument

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Writes the invoice object content to a DOMDocument instance.

```php
public function getContentAsDomDocument(): \DOMDocument
{
}
```

--------------------------------

### Merge Existing PDF with XML String

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfMerger

This example demonstrates merging an existing PDF file with XML data provided as a string. It requires the PDF file to exist.

```php
use horstoeko\zugferd\ZugferdDocumentPdfMerger;

$xmlString= "<xml>...</xml>";
$existingPdfFile = "/tmp/emptypdf.pdf";
$mergeToPdf = "/tmp/fullpdf.pdf";

if (!file_exists($existingPdfFile)) {
    throw new \Exception("XML and/or PDF does not exist");
}

(new ZugferdDocumentPdfMerger($xmlString, $existingPdfFile))
    ->generateDocument()
    ->saveDocument($mergeToPdf);
```

--------------------------------

### Retrieve Specific Payment Term

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Gets the currently seeked payment term details.

```php
public function getDocumentPaymentTerm(
  ?string $description,
  ?DateTime $dueDate,
  ?string $directDebitMandateID,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Merge PDF String with XML String

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfMerger

This example shows how to merge a PDF provided as a string with XML data also provided as a string. No file existence checks are needed for this combination.

```php
use horstoeko\zugferd\ZugferdDocumentPdfMerger;

$xmlString= "<xml>...</xml>";
$pdfString = "%PDF-1.4.....";
$mergeToPdf = "/tmp/fullpdf.pdf";

(new ZugferdDocumentPdfMerger($xmlString, $pdfString))
    ->generateDocument()
    ->saveDocument($mergeToPdf);
```

--------------------------------

### Get Buyer Contact Information

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves contact information for the buyer trade party.

```php
public function getDocumentBuyerContact(
  ?string $contactPersonName,
  ?string $contactDepartmentName,
  ?string $contactPhoneNo,
  ?string $contactFaxNo,
  ?string $contactEmailAddress,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Document Seller Address

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the address details of the seller trade party.

```php
public function getDocumentSellerAddress(
  ?string $lineOne,
  ?string $lineTwo,
  ?string $lineThree,
  ?string $postCode,
  ?string $city,
  ?string $country,
  ?array $subDivision,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### setBaseDirectory

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdPdfValidator

Sets the base directory where files will be downloaded and created.

```APIDOC
## setBaseDirectory

### Description
Setup the base directory. In the base directory all files will be downloaded and created.

### Method
`public function setBaseDirectory(string $newBaseDirectory): 
ZugferdPdfValidator`

### Parameters
#### Path Parameters
- **newBaseDirectory** (string) - Required - The path to the base directory.
```

--------------------------------

### Get document buyer reference

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the identifier assigned by the buyer for internal routing.

```php
public function getDocumentBuyerReference(?string $buyerReference): \ZugferdDocumentReader
{
}
```

--------------------------------

### Navigate document position notes

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Methods to seek the first or next document position note. Returns true if a note is available.

```php
public function firstDocumentPositionNote(): bool
{
}
```

```php
public function nextDocumentPositionNote(): bool
{
}
```

--------------------------------

### Get document business process

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Extracts the business process context identifier from the document.

```php
public function getDocumentBusinessProcess(?string $businessProcess): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get XSLT Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all XSLT stylesheet files are located.

```php
public static function getXsltDirectory(): string
{
}

```

--------------------------------

### Create PDF from Existing File

Source: https://github.com/horstoeko/zugferd/blob/master/make/md/ZugferdDocumentPdfBuilder.md

Generates a PDF document by merging Zugferd XML data with an existing PDF template file. The merged PDF is then saved to a specified path.

```php
use horstoeko\zugferd\codelists\ZugferdCurrencyCodes;
use horstoeko\zugferd\codelists\ZugferdInvoiceType;
use horstoeko\zugferd\ZugferdDocumentBuilder;
use horstoeko\zugferd\ZugferdDocumentPdfBuilderAbstract;
use horstoeko\zugferd\ZugferdDocumentPdfBuilder;
use horstoeko\zugferd\ZugferdProfiles;

// Build the XML using ZugferdDocumentBuilder

$zugferdDocumentBuilder = ZugferdDocumentBuilder::CreateNew(ZugferdProfiles::PROFILE_EN16931);
$zugferdDocumentBuilder
    ->setDocumentInformation('R-2024/00001', ZugferdInvoiceType::INVOICE, DateTime::createFromFormat('Ymd', '20241231'), ZugferdCurrencyCodes::EURO)
    ->......

// Create a PDF using the XML content from ZugferdDocumentBuilder and an existing print-output file

$zugferdDocumentPdfBuilder = ZugferdDocumentPdfBuilder::fromPdfFile($zugferdDocumentBuilder, '/tmp/existingprintlayout.pdf');
$zugferdDocumentPdfBuilder->generateDocument();
$zugferdDocumentPdfBuilder->saveDocument('/tmp/merged.pdf');
```

--------------------------------

### Get Schematron Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all Schematron stylesheet files are located.

```php
public static function getSchematronDirectory(): string
{
}

```

--------------------------------

### Get Schema Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all schema (XSD) files are located.

```php
public static function getSchemaDirectory(): string
{
}

```

--------------------------------

### Get YAML Directory (PHP)

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdSettings

Retrieves the directory where all YAML configuration files are stored.

```php
public static function getYamlDirectory(): string
{
}

```

--------------------------------

### readAndGuessFromFile

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentPdfReader

Tries to load a PDF file (ZUGFeRD/Factur-X) and return a ZugferdDocumentReader object.

```APIDOC
## readAndGuessFromFile

### Description
Tries to load a PDF file (ZUGFeRD/Factur-X) and return a ZugferdDocumentReader.

### Method
static

### Parameters
#### Path Parameters
- **pdfFilename** (string) - Required - The filename of the PDF file to read.

### Returns
- **ZugferdDocumentReader** - The parsed ZugferdDocumentReader object.
```

--------------------------------

### Set Document Seller Details

Source: https://github.com/horstoeko/zugferd/wiki/Example-ZugferdDocumentBuilder-in-EN16391-profile

Configure the seller's information including name, global ID, tax number, VAT registration number, address, contact person, and electronic communication details.

```php
$documentBuilder->setDocumentSeller('Lieferant GmbH', '549910');
$documentBuilder->addDocumentSellerGlobalId('4000001123452', '0088');
$documentBuilder->addDocumentSellerTaxNumber('201/113/40209');
$documentBuilder->addDocumentSellerVATRegistrationNumber('DE123456789');
$documentBuilder->setDocumentSellerAddress('Lieferantenstraße 20', '', '', '80333', 'München', ZugferdCountryCodes::GERMANY);
$documentBuilder->setDocumentSellerContact('H. Müller', 'Verkauf', '+49-111-2222222', '+49-111-3333333', 'hm@lieferant.de');
$documentBuilder->setDocumentSellerCommunication(ZugferdElectronicAddressScheme::UNECE3155_EM, 'sales@lieferant.de');
```

--------------------------------

### Get Validation Warnings

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdPdfValidator

Retrieves an array containing all validation warnings found during the process.

```php
public function getValidationWarnings(): array
{
}
```

--------------------------------

### Set Document Seller

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentBuilder

Configures the primary seller information including name, optional ID, and description.

```php
public function setDocumentSeller(
  string $name,
  ?string $id = null,
  ?string $description = null,
): \ZugferdDocumentBuilder
{
}
```

--------------------------------

### Get Validation Errors

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdPdfValidator

Retrieves an array containing all validation errors found during the process.

```php
public function getValidationErrors(): array
{
}
```

--------------------------------

### Set Seller Information - PHP

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdQuickDescriptor

Sets detailed information about the seller, including name, address, and optional identifiers. Ensure all required address fields are provided.

```php
public function doSetSeller(
  string $name,
  string $postcode,
  string $city,
  string $street,
  string $country,
  ?string $id = null,
  ?string $globalID = null,
  ?string $globalIDscheme = null,
): \ZugferdQuickDescriptor
{
}
```

--------------------------------

### Get buyer order referenced document

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves details of the related buyer order position.

```php
public function getDocumentPositionBuyerOrderReferencedDocument(
  ?string $issuerAssignedId,
  ?string $lineId,
  ?DateTime $issueDate,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get document trade accounting account

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves information about the booking reference at the document level.

```php
public function getDocumentReceivableSpecifiedTradeAccountingAccount(
  ?string $id,
  ?string $typeCode,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Seek to next product end-user contact

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Moves the internal pointer to the next available contact person of the product end user.

```php
public function nextDocumentProductEndUserContactContact(): bool
{
}
```

--------------------------------

### Get Ship-To Legal Organisation

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves legal organization details for the Ship-To trade party.

```php
public function getDocumentShipToLegalOrganisation(
  ?string $legalOrgid,
  ?string $legalOrgType,
  ?string $legalOrgName,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Buyer Legal Organisation

Source: https://github.com/horstoeko/zugferd/wiki/Class-ZugferdDocumentReader

Retrieves the legal organization details of the buyer trade party.

```php
public function getDocumentBuyerLegalOrganisation(
  ?string $legalOrgId,
  ?string $legalOrgType,
  ?string $legalOrgName,
): \ZugferdDocumentReader
{
}
```

--------------------------------

### Get Decimal Separator Character

Source: https://github.com/horstoeko/zugferd/wiki/Configuration

Retrieves the character used as the decimal separator. Defaults to a dot (.).

```php
public static function getDecimalSeparator(): string
```
Tokens:
Raw