From 7c5f06042a1607fda21cf927233a01c8dccc58e6 Mon Sep 17 00:00:00 2001 From: HorstOeko Date: Fri, 27 Dec 2024 10:59:39 +0100 Subject: [PATCH] [CS] Fix codestyle issues --- build/phprectorconfig.php | 3 +- src/ZugferdDocumentBuilder.php | 779 +++++++++++----------- src/ZugferdDocumentReader.php | 387 +++++------ src/quick/ZugferdQuickDescriptor.php | 270 ++++---- tests/testcases/PdfBuilderEn16931Test.php | 55 +- 5 files changed, 757 insertions(+), 737 deletions(-) diff --git a/build/phprectorconfig.php b/build/phprectorconfig.php index 33b1c63f..d81b223b 100644 --- a/build/phprectorconfig.php +++ b/build/phprectorconfig.php @@ -2,6 +2,7 @@ declare(strict_types=1); +use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector; use Rector\Config\RectorConfig; use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector; use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector; @@ -27,7 +28,7 @@ SetList::CODING_STYLE, ]) ->withParallel(60 * 5, 12, 16) - ->withConfiguredRule(\Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector::class, [ + ->withConfiguredRule(EncapsedStringsToSprintfRector::class, [ 'always' => true, ]) ->withRules([ diff --git a/src/ZugferdDocumentBuilder.php b/src/ZugferdDocumentBuilder.php index 42c441f5..b2f15680 100644 --- a/src/ZugferdDocumentBuilder.php +++ b/src/ZugferdDocumentBuilder.php @@ -688,8 +688,8 @@ public function setDocumentSellerTaxRepresentativeTradeParty(string $name, ?stri /** * Add a global id for the seller's Tax representative party * - * @param string|null $globalID __BT-X-117, From EXTENDED__ The seller's tax agent identifier identification scheme is an identifier uniquely assigned to a seller by a global registration organization. - * @param string|null $globalIDType __BT-X-117-1, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string|null $globalID __BT-X-117, From EXTENDED__ The seller's tax agent identifier identification scheme is an identifier uniquely assigned to a seller by a global registration organization. + * @param string|null $globalIDType __BT-X-117-1, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdDocumentBuilder */ public function addDocumentSellerTaxRepresentativeGlobalId(?string $globalID = null, ?string $globalIDType = null): ZugferdDocumentBuilder @@ -737,9 +737,9 @@ public function setDocumentSellerTaxRepresentativeAddress(?string $lineOne = nul /** * Set legal organisation of the seller's tax representative party * - * @param string|null $legalOrgId __BT-, From __ An identifier issued by an official registrar that identifies the seller tax agent as a legal entity or legal person. - * @param string|null $legalOrgType __BT-, From __ 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 - * @param string|null $legalOrgName __BT-, From __ A name by which the sellers tax agent is known, if different from the sellers tax agent name (also known as the company name) + * @param string|null $legalOrgId __BT-, From __ An identifier issued by an official registrar that identifies the seller tax agent as a legal entity or legal person. + * @param string|null $legalOrgType __BT-, From __ 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 + * @param string|null $legalOrgName __BT-, From __ A name by which the sellers tax agent is known, if different from the sellers tax agent name (also known as the company name) * @return ZugferdDocumentBuilder */ public function setDocumentSellerTaxRepresentativeLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -753,11 +753,11 @@ public function setDocumentSellerTaxRepresentativeLegalOrganisation(?string $leg /** * Set detailed information on the seller's tax representative party contact person * - * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office - * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. - * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office + * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. + * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentSellerTaxRepresentativeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -771,11 +771,11 @@ public function setDocumentSellerTaxRepresentativeContact(?string $contactPerson /** * Add an (additional) contact to the seller's tax representative party (EXTENDED Profile only) * - * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office - * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. - * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office + * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. + * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentSellerTaxRepresentativeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -789,9 +789,9 @@ public function addDocumentSellerTaxRepresentativeContact(?string $contactPerson /** * Detailed information on the deviating end user (general informaton) * - * @param string $name __BT-X-128, From EXTENDED__ Name/company name of the end user - * @param string|null $id __BT-X-126, From EXTENDED__ An identifier of the product end user - * @param string|null $description __BT-, From __ Further legal information that is relevant for the product end user + * @param string $name __BT-X-128, From EXTENDED__ Name/company name of the end user + * @param string|null $id __BT-X-126, From EXTENDED__ An identifier of the product end user + * @param string|null $description __BT-, From __ Further legal information that is relevant for the product end user * @return ZugferdDocumentBuilder */ public function setDocumentProductEndUser(string $name, ?string $id = null, ?string $description = null): ZugferdDocumentBuilder @@ -804,8 +804,8 @@ public function setDocumentProductEndUser(string $name, ?string $id = null, ?str /** * Add a Global identifier of the deviating end user * - * @param string|null $globalID __BT-X-127, From EXTENDED__ The identifier is uniquely assigned to a party by a global registration organization. - * @param string|null $globalIDType __BT-X-127-0, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string|null $globalID __BT-X-127, From EXTENDED__ The identifier is uniquely assigned to a party by a global registration organization. + * @param string|null $globalIDType __BT-X-127-0, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdDocumentBuilder */ public function addDocumentProductEndUserGlobalId(?string $globalID = null, ?string $globalIDType = null): ZugferdDocumentBuilder @@ -818,8 +818,8 @@ public function addDocumentProductEndUserGlobalId(?string $globalID = null, ?str /** * Add Tax registration to the deviating end user * - * @param string|null $taxRegType __BT-, From __ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string|null $taxRegId __BT-, From __ Tax number or sales tax identification number + * @param string|null $taxRegType __BT-, From __ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string|null $taxRegId __BT-, From __ Tax number or sales tax identification number * @return ZugferdDocumentBuilder */ public function addDocumentProductEndUserTaxRegistration(?string $taxRegType = null, ?string $taxRegId = null): ZugferdDocumentBuilder @@ -833,13 +833,14 @@ public function addDocumentProductEndUserTaxRegistration(?string $taxRegType = n /** * Sets the postal address of the Product Enduser party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-396, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-400, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located - * @param string|null $country __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” - * @param string|null $subDivision __BT-X-402, From EXTENDED__ The product end users state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-396, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-400, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located + * @param string|null $country __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” + * @param string|null $subDivision __BT-X-402, From EXTENDED__ The product end users state * @return ZugferdDocumentBuilder */ public function setDocumentProductEndUserAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -853,9 +854,9 @@ public function setDocumentProductEndUserAddress(?string $lineOne = null, ?strin /** * Set legal organisation of the Product Enduser party * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentBuilder */ public function setDocumentProductEndUserLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -869,11 +870,11 @@ public function setDocumentProductEndUserLegalOrganisation(?string $legalOrgId, /** * Set contact of the Product Enduser party * - * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentProductEndUserContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -887,11 +888,11 @@ public function setDocumentProductEndUserContact(?string $contactPersonName, ?st /** * Add an (additional) contact to the Product Enduser party (EXTENDED Profile only) * - * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentProductEndUserContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1049,7 +1050,7 @@ public function setDocumentUltimateShipTo(?string $name = null, ?string $id = nu /** * Add an id to the different end recipient * - * @param string $id __BT-X-162, From EXTENDED__ Identification of the different end recipient. Multiple IDs can be assigned or specified. They can be differentiated by using different identification schemes. + * @param string $id __BT-X-162, From EXTENDED__ Identification of the different end recipient. Multiple IDs can be assigned or specified. They can be differentiated by using different identification schemes. * @return ZugferdDocumentBuilder */ public function addDocumentUltimateShipToId(string $id): ZugferdDocumentBuilder @@ -1076,8 +1077,8 @@ public function addDocumentUltimateShipToGlobalId(?string $globalID = null, ?str /** * Add Tax registration to the different end recipient * - * @param string|null $taxRegType __BT-X-180-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string|null $taxRegId __BT-X-180, From EXTENDED__ Tax number or sales tax identification number + * @param string|null $taxRegType __BT-X-180-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string|null $taxRegId __BT-X-180, From EXTENDED__ Tax number or sales tax identification number * @return ZugferdDocumentBuilder */ public function addDocumentUltimateShipToTaxRegistration(?string $taxRegType = null, ?string $taxRegId = null): ZugferdDocumentBuilder @@ -1127,11 +1128,11 @@ public function setDocumentUltimateShipToLegalOrganisation(?string $legalOrgId, /** * Set contact of the different end recipient * - * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentUltimateShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1145,11 +1146,11 @@ public function setDocumentUltimateShipToContact(?string $contactPersonName, ?st /** * Add an (additional) contact to the different end recipient. * - * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentUltimateShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1220,13 +1221,14 @@ public function addDocumentShipFromTaxRegistration(?string $taxRegType = null, ? /** * Sets the postal address of the deviating consignor party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-191, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-195, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param string|null $subDivision __BT-X-197, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-191, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-195, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param string|null $subDivision __BT-X-197, From EXTENDED__ The party's state * @return ZugferdDocumentBuilder */ public function setDocumentShipFromAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -1240,9 +1242,9 @@ public function setDocumentShipFromAddress(?string $lineOne = null, ?string $lin /** * Set legal organisation of the deviating consignor party * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentBuilder */ public function setDocumentShipFromLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -1256,11 +1258,11 @@ public function setDocumentShipFromLegalOrganisation(?string $legalOrgId, ?strin /** * Set contact of the deviating consignor party * - * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentShipFromContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1274,11 +1276,11 @@ public function setDocumentShipFromContact(?string $contactPersonName, ?string $ /** * Add an (additional) contact to the deviating consignor party * - * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentShipFromContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1292,9 +1294,9 @@ public function addDocumentShipFromContact(?string $contactPersonName, ?string $ /** * Detailed information about the Invoicer Party * - * @param string $name __BT-X-207, From EXTENDED__ The name of the party - * @param string|null $id __BT-X-205, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party + * @param string $name __BT-X-207, From EXTENDED__ The name of the party + * @param string|null $id __BT-X-205, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party * @return ZugferdDocumentBuilder */ public function setDocumentInvoicer(string $name, ?string $id = null, ?string $description = null): ZugferdDocumentBuilder @@ -1385,11 +1387,11 @@ public function setDocumentInvoicerLegalOrganisation(?string $legalOrgId, ?strin /** * Set contact of the Invoicer Party * - * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentInvoicerContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1403,11 +1405,11 @@ public function setDocumentInvoicerContact(?string $contactPersonName, ?string $ /** * Add an (additional) contact to the Invoicer Party * - * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentInvoicerContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1421,9 +1423,9 @@ public function addDocumentInvoicerContact(?string $contactPersonName, ?string $ /** * Set detailed information on the different invoice recipient * - * @param string $name __BT-X-226, From EXTENDED__ The name of the party - * @param string|null $id __BT-X-224, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party + * @param string $name __BT-X-226, From EXTENDED__ The name of the party + * @param string|null $id __BT-X-224, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party * @return ZugferdDocumentBuilder */ public function setDocumentInvoicee(string $name, ?string $id = null, ?string $description = null): ZugferdDocumentBuilder @@ -1436,7 +1438,7 @@ public function setDocumentInvoicee(string $name, ?string $id = null, ?string $d /** * Add an id to the Invoicee Party * - * @param string $id __BT-X-224, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. + * @param string $id __BT-X-224, From EXTENDED__ An identifier for the party. Multiple 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 identifier assigned by the buyer or seller. * @return ZugferdDocumentBuilder */ public function addDocumentInvoiceeId(string $id): ZugferdDocumentBuilder @@ -1449,8 +1451,8 @@ public function addDocumentInvoiceeId(string $id): ZugferdDocumentBuilder /** * Add a global id for the Invoicee Party * - * @param string|null $globalID __BT-X-225, From EXTENDED__ Global identification number - * @param string|null $globalIDType __BT-X-225-0, From EXTENDED__ Type of global identification number, must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string|null $globalID __BT-X-225, From EXTENDED__ Global identification number + * @param string|null $globalIDType __BT-X-225-0, From EXTENDED__ Type of global identification number, must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdDocumentBuilder */ public function addDocumentInvoiceeGlobalId(?string $globalID = null, ?string $globalIDType = null): ZugferdDocumentBuilder @@ -1463,8 +1465,8 @@ public function addDocumentInvoiceeGlobalId(?string $globalID = null, ?string $g /** * Add Tax registration to the Invoicee Party * - * @param string|null $taxRegType __BT-X-242-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string|null $taxRegId __BT-X-242, From EXTENDED__ Tax number or sales tax identification number + * @param string|null $taxRegType __BT-X-242-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string|null $taxRegId __BT-X-242, From EXTENDED__ Tax number or sales tax identification number * @return ZugferdDocumentBuilder */ public function addDocumentInvoiceeTaxRegistration(?string $taxRegType = null, ?string $taxRegId = null): ZugferdDocumentBuilder @@ -1478,13 +1480,14 @@ public function addDocumentInvoiceeTaxRegistration(?string $taxRegType = null, ? /** * Sets the postal address of the Invoicee Party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-234, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-238, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param string|null $subDivision __BT-X-240, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-234, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-238, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param string|null $subDivision __BT-X-240, From EXTENDED__ The party's state * @return ZugferdDocumentBuilder */ public function setDocumentInvoiceeAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -1498,9 +1501,9 @@ public function setDocumentInvoiceeAddress(?string $lineOne = null, ?string $lin /** * Set legal organisation of the Invoicee Party * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentBuilder */ public function setDocumentInvoiceeLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -1514,11 +1517,11 @@ public function setDocumentInvoiceeLegalOrganisation(?string $legalOrgId, ?strin /** * Set contact of the Invoicee Party * - * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentInvoiceeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1532,11 +1535,11 @@ public function setDocumentInvoiceeContact(?string $contactPersonName, ?string $ /** * Add an (additional) contact to the Invoicee Party * - * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentInvoiceeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1579,8 +1582,8 @@ public function addDocumentPayeeId(string $id): ZugferdDocumentBuilder /** * Add a global id for the payee trade party * - * @param string|null $globalID __BT-60-0, From BASIC WL__ Global identification number - * @param string|null $globalIDType __BT-60-1, From BASIC WL__ Type of global identification number, must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string|null $globalID __BT-60-0, From BASIC WL__ Global identification number + * @param string|null $globalIDType __BT-60-1, From BASIC WL__ Type of global identification number, must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdDocumentBuilder */ public function addDocumentPayeeGlobalId(?string $globalID = null, ?string $globalIDType = null): ZugferdDocumentBuilder @@ -1608,13 +1611,14 @@ public function addDocumentPayeeTaxRegistration(?string $taxRegType = null, ?str /** * Sets the postal address of the payee trade party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-249, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-253, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param string|null $subDivision __BT-X-255, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-249, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-253, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param string|null $subDivision __BT-X-255, From EXTENDED__ The party's state * @return ZugferdDocumentBuilder */ public function setDocumentPayeeAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -1644,11 +1648,11 @@ public function setDocumentPayeeLegalOrganisation(?string $legalOrgId, ?string $ /** * Set contact of the payee trade party * - * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function setDocumentPayeeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1662,11 +1666,11 @@ public function setDocumentPayeeContact(?string $contactPersonName, ?string $con /** * Add an (additional) contact to the payee trade party * - * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentBuilder */ public function addDocumentPayeeContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -1756,17 +1760,18 @@ public function setDocumentContractReferencedDocument(?string $issuerAssignedId, * to large attachments and / or sensitive information, e.g. for personal services, which must be separated * from the bill * - * @param string $issuerAssignedId __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. - * @param string $typeCode __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. - * @param string|null $uriId __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. - * @param string|array|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. - * @param string|null $refTypeCode __BT-, From __ 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. - * @param DateTime|null $issueDate __BT-X-149, From EXTENDED__ Document date - * @param string|null $binaryDataFilename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object + * @param string $issuerAssignedId __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. + * @param string $typeCode __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. + * @param string|null $uriId __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. + * @param string|array|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. + * @param string|null $refTypeCode __BT-, From __ 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. + * @param DateTime|null $issueDate __BT-X-149, From EXTENDED__ Document date + * @param string|null $binaryDataFilename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object * @return ZugferdDocumentBuilder */ public function addDocumentAdditionalReferencedDocument(string $issuerAssignedId, string $typeCode, ?string $uriId = null, $name = null, ?string $refTypeCode = null, ?DateTime $issueDate = null, ?string $binaryDataFilename = null): ZugferdDocumentBuilder @@ -1833,8 +1838,8 @@ public function setDocumentProcuringProject(string $id, string $name = "Project /** * Details of the associated end customer order * - * @param string $issuerAssignedId __BT-X-150, From EXTENDED__ Order number of the end customer - * @param DateTime|null $issueDate __BT-X-151, From EXTENDED__ Date of the order issued by the end customer + * @param string $issuerAssignedId __BT-X-150, From EXTENDED__ Order number of the end customer + * @param DateTime|null $issueDate __BT-X-151, From EXTENDED__ Date of the order issued by the end customer * @return ZugferdDocumentBuilder */ public function addDocumentUltimateCustomerOrderReferencedDocument(string $issuerAssignedId, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -1875,7 +1880,7 @@ public function setDocumentDespatchAdviceReferencedDocument(?string $issuerAssig * Set detailed information on the associated goods receipt notification * * @param string $issuerAssignedId __BT-15, From EN 16931__ An identifier for a referenced goods receipt notification (Goods receipt number) - * @param DateTime|null $issueDate __BT-X-201, From EXTENDED__ Goods receipt date + * @param DateTime|null $issueDate __BT-X-201, From EXTENDED__ Goods receipt date * @return ZugferdDocumentBuilder */ public function setDocumentReceivingAdviceReferencedDocument(string $issuerAssignedId, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -1888,7 +1893,7 @@ public function setDocumentReceivingAdviceReferencedDocument(string $issuerAssig /** * Set detailed information on the associated delivery bill * - * @param string $issuerAssignedId __BT-X-202, From EXTENDED__ Delivery slip number + * @param string $issuerAssignedId __BT-X-202, From EXTENDED__ Delivery slip number * @param DateTime|null $issueDate __BT-X-203, From EXTENDED__ Delivery slip date * @return ZugferdDocumentBuilder */ @@ -1923,17 +1928,17 @@ public function setDocumentGeneralPaymentInformation(?string $creditorReferenceI * element must therefore not differ in the repetitions. The elements ApplicableTradeSettlementFinancialCard * and PayerPartyDebtorFinancialAccount must not be specified for bank transfers. * - * @param string $typeCode __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 + * @param string $typeCode __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 * @param string|null $information __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. * @param string|null $cardType __BT-, From __ The type of the card * @param string|null $cardId __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 @@ -1966,7 +1971,7 @@ public function addDocumentPaymentMean(string $typeCode, ?string $information = /** * Sets the document payment means to _SEPA Credit Transfer_ * - * @param string $payeeIban __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 + * @param string $payeeIban __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 * @param string|null $payeeAccountName __BT-85, From BASIC WL__ The name of the payment account held with a payment service provider to which the payment should be made * @param string|null $payeePropId __BT-BT-84-0, From BASIC WL__ National account number (not for SEPA) * @param string|null $payeeBic __BT-86, From EN 16931__ An identifier for the payment service provider with which the payment account is held @@ -1994,7 +1999,7 @@ public function addDocumentPaymentMeanToCreditTransfer(string $payeeIban, ?strin /** * Sets the document payment means to _Non-SEPA Credit Transfer_ * - * @param string $payeeIban __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 + * @param string $payeeIban __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 * @param string|null $payeeAccountName __BT-85, From BASIC WL__ The name of the payment account held with a payment service provider to which the payment should be made * @param string|null $payeePropId __BT-BT-84-0, From BASIC WL__ National account number (not for SEPA) * @param string|null $payeeBic __BT-86, From EN 16931__ An identifier for the payment service provider with which the payment account is held @@ -2022,8 +2027,8 @@ public function addDocumentPaymentMeanToCreditTransferNonSepa(string $payeeIban, /** * Sets the document payment means to _SEPA Direct Debit_ * - * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit - * @param string|null $creditorReferenceID __BT-90, From BASIC WL__ Unique bank identifier of the payee or the seller assigned by the bank of the payee or the seller + * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit + * @param string|null $creditorReferenceID __BT-90, From BASIC WL__ Unique bank identifier of the payee or the seller assigned by the bank of the payee or the seller * @return ZugferdDocumentBuilder */ public function addDocumentPaymentMeanToDirectDebit(string $buyerIban, ?string $creditorReferenceID = null): ZugferdDocumentBuilder @@ -2045,8 +2050,8 @@ public function addDocumentPaymentMeanToDirectDebit(string $buyerIban, ?string $ /** * Sets the document payment means to _Non-SEPA Direct Debit_ * - * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit - * @param string|null $creditorReferenceID __BT-90, From BASIC WL__ Unique bank identifier of the payee or the seller assigned by the bank of the payee or the seller + * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit + * @param string|null $creditorReferenceID __BT-90, From BASIC WL__ Unique bank identifier of the payee or the seller assigned by the bank of the payee or the seller * @return ZugferdDocumentBuilder */ public function addDocumentPaymentMeanToDirectDebitNonSepa(string $buyerIban, ?string $creditorReferenceID = null): ZugferdDocumentBuilder @@ -2068,9 +2073,9 @@ public function addDocumentPaymentMeanToDirectDebitNonSepa(string $buyerIban, ?s /** * Sets the document payment means to _Payment card_ * - * @param string $cardType __BT-, From __ The type of the card - * @param string $cardId __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 - * @param string|null $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder + * @param string $cardType __BT-, From __ The type of the card + * @param string $cardId __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 + * @param string|null $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder * @return ZugferdDocumentBuilder */ public function addDocumentPaymentMeanToPaymentCard(string $cardType, string $cardId, ?string $cardHolderName = null): ZugferdDocumentBuilder @@ -2132,33 +2137,29 @@ public function addDocumentTax(string $categoryCode, string $typeCode, float $ba /** * Add a VAT breakdown (at document level) in a more simple way * - * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category - * - * The following entries from UNTDID 5305 are used (details in brackets): - * - Standard rate (sales tax is due according to the normal procedure) - * - Goods to be taxed according to the zero rate (sales tax is charged with a percentage of zero) - * - Tax exempt (USt./IGIC/IPSI) - * - Reversal of the tax liability (the rules for reversing the tax liability at USt./IGIC/IPSI apply) - * - VAT exempt for intra-community deliveries of goods (USt./IGIC/IPSI not levied due to rules on intra-community deliveries) - * - Free export item, tax not levied (VAT / IGIC/IPSI not levied due to export outside the EU) - * - Services outside the tax scope (sales are not subject to VAT / IGIC/IPSI) - * - Canary Islands general indirect tax (IGIC tax applies) - * - IPSI (tax for Ceuta / Melilla) applies. - * - * The codes for the VAT category are as follows: - * - S = sales tax is due at the normal rate - * - Z = goods to be taxed according to the zero rate - * - E = tax exempt - * - AE = reversal of tax liability - * - K = VAT is not shown for intra-community deliveries - * - G = tax not levied due to export outside the EU - * - O = Outside the tax scope - * - L = IGIC (Canary Islands) - * - M = IPSI (Ceuta / Melilla) - * @param string $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" - * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. - * @param float $calculatedAmount __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 - * @param float|null $rateApplicablePercent __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) + * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category + * The following entries from UNTDID 5305 are used (details in + * brackets): - Standard rate (sales tax is due according to the + * normal procedure) - Goods to be taxed according to the zero rate + * (sales tax is charged with a percentage of zero) - Tax exempt + * (USt./IGIC/IPSI) - Reversal of the tax liability (the rules for + * reversing the tax liability at USt./IGIC/IPSI apply) - VAT exempt + * for intra-community deliveries of goods (USt./IGIC/IPSI not levied + * due to rules on intra-community deliveries) - Free export item, tax + * not levied (VAT / IGIC/IPSI not levied due to export outside the + * EU) - Services outside the tax scope (sales are not subject to VAT + * / IGIC/IPSI) - Canary Islands general indirect tax (IGIC tax + * applies) - IPSI (tax for Ceuta / Melilla) applies. The codes for + * the VAT category are as follows: - S = sales tax is due at the + * normal rate - Z = goods to be taxed according to the zero rate - E + * = tax exempt - AE = reversal of tax liability - K = VAT is not + * shown for intra-community deliveries - G = tax not levied due to + * export outside the EU - O = Outside the tax scope - L = IGIC + * (Canary Islands) - M = IPSI (Ceuta / Melilla) + * @param string $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" + * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. + * @param float $calculatedAmount __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 + * @param float|null $rateApplicablePercent __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) * @return ZugferdDocumentBuilder */ public function addDocumentTaxSimple(string $categoryCode, string $typeCode, float $basisAmount, float $calculatedAmount, ?float $rateApplicablePercent = null): ZugferdDocumentBuilder @@ -2185,62 +2186,62 @@ public function setDocumentBillingPeriod(?DateTime $startDate, ?DateTime $endDat * Add 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 * - * @param float $actualAmount __BT-92/BT-99, From BASIC WL__ Amount of the surcharge or discount at document level - * @param boolean $isCharge __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 - * @param string $taxCategoryCode __BT-95/BT-102, From BASIC WL__ A coded indication of which sales tax category applies to the surcharge or deduction at document level - * - * The following entries from UNTDID 5305 are used (details in brackets): - * - Standard rate (sales tax is due according to the normal procedure) - * - Goods to be taxed according to the zero rate (sales tax is charged with a percentage of zero) - * - Tax exempt (USt./IGIC/IPSI) - * - Reversal of the tax liability (the rules for reversing the tax liability at USt./IGIC/IPSI apply) - * - VAT exempt for intra-community deliveries of goods (USt./IGIC/IPSI not levied due to rules on intra-community deliveries) - * - Free export item, tax not levied (VAT / IGIC/IPSI not levied due to export outside the EU) - * - Services outside the tax scope (sales are not subject to VAT / IGIC/IPSI) - * - Canary Islands general indirect tax (IGIC tax applies) - * - IPSI (tax for Ceuta / Melilla) applies. - * - * The codes for the VAT category are as follows: - * - S = sales tax is due at the normal rate - * - Z = goods to be taxed according to the zero rate - * - E = tax exempt - * - AE = reversal of tax liability - * - K = VAT is not shown for intra-community deliveries - * - G = tax not levied due to export outside the EU - * - O = Outside the tax scope - * - L = IGIC (Canary Islands) - * - M = IPSI (Ceuta/Melilla) - * - * @param string $taxTypeCode __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" - * @param float $rateApplicablePercent __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) - * @param float|null $sequence __BT-X-265, From EXTENDED__ Calculation order - * @param float|null $calculationPercent __BT-94/BT-101, From BASIC WL__ Percentage surcharge or discount at document level - * @param float|null $basisAmount __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 - * @param float|null $basisQuantity __BT-X-266, From EXTENDED__ Base quantity of the discount - * @param string|null $basisQuantityUnitCode __BT-X-267, From EXTENDED__ Unit of the price base quantity - * @param string|null $reasonCode __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 - * - * Code list: UNTDID 7161 Complete list, code list: UNTDID 5189 Restricted - * Include PEPPOL subset: - * - 41 - Bonus for works ahead of schedule - * - 42 - Other bonus - * - 60 - Manufacturer’s consumer discount - * - 62 - Due to military status - * - 63 - Due to work accident - * - 64 - Special agreement - * - 65 - Production error discount - * - 66 - New outlet discount - * - 67 - Sample discount - * - 68 - End-of-range discount - * - 70 - Incoterm discount - * - 71 - Point of sales threshold allowance - * - 88 - Material surcharge/deduction - * - 95 - Discount - * - 100 - Special rebate - * - 102 - Fixed long term - * - 103 - Temporary - * - 104 - Standard - * - 105 - Yearly turnover + * @param float $actualAmount __BT-92/BT-99, From BASIC WL__ Amount of the surcharge or discount at document level + * @param boolean $isCharge __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 + * @param string $taxCategoryCode __BT-95/BT-102, From BASIC WL__ A coded indication of which sales tax category applies to the surcharge or deduction at document level + * + * The following entries from UNTDID 5305 are used (details in brackets): + * - Standard rate (sales tax is due according to the normal procedure) + * - Goods to be taxed according to the zero rate (sales tax is charged with a percentage of zero) + * - Tax exempt (USt./IGIC/IPSI) + * - Reversal of the tax liability (the rules for reversing the tax liability at USt./IGIC/IPSI apply) + * - VAT exempt for intra-community deliveries of goods (USt./IGIC/IPSI not levied due to rules on intra-community deliveries) + * - Free export item, tax not levied (VAT / IGIC/IPSI not levied due to export outside the EU) + * - Services outside the tax scope (sales are not subject to VAT / IGIC/IPSI) + * - Canary Islands general indirect tax (IGIC tax applies) + * - IPSI (tax for Ceuta / Melilla) applies. + * + * The codes for the VAT category are as follows: + * - S = sales tax is due at the normal rate + * - Z = goods to be taxed according to the zero rate + * - E = tax exempt + * - AE = reversal of tax liability + * - K = VAT is not shown for intra-community deliveries + * - G = tax not levied due to export outside the EU + * - O = Outside the tax scope + * - L = IGIC (Canary Islands) + * - M = IPSI (Ceuta/Melilla) + * + * @param string $taxTypeCode __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" + * @param float $rateApplicablePercent __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) + * @param float|null $sequence __BT-X-265, From EXTENDED__ Calculation order + * @param float|null $calculationPercent __BT-94/BT-101, From BASIC WL__ Percentage surcharge or discount at document level + * @param float|null $basisAmount __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 + * @param float|null $basisQuantity __BT-X-266, From EXTENDED__ Base quantity of the discount + * @param string|null $basisQuantityUnitCode __BT-X-267, From EXTENDED__ Unit of the price base quantity + * @param string|null $reasonCode __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 + * + * Code list: UNTDID 7161 Complete list, code list: UNTDID 5189 Restricted + * Include PEPPOL subset: + * - 41 - Bonus for works ahead of schedule + * - 42 - Other bonus + * - 60 - Manufacturer’s consumer discount + * - 62 - Due to military status + * - 63 - Due to work accident + * - 64 - Special agreement + * - 65 - Production error discount + * - 66 - New outlet discount + * - 67 - Sample discount + * - 68 - End-of-range discount + * - 70 - Incoterm discount + * - 71 - Point of sales threshold allowance + * - 88 - Material surcharge/deduction + * - 95 - Discount + * - 100 - Special rebate + * - 102 - Fixed long term + * - 103 - Temporary + * - 104 - Standard + * - 105 - Yearly turnover * * @param string|null $reason __BT-97/BT-104, From BASIC WL__ The reason given in text form for the surcharge or discount at document level * @return ZugferdDocumentBuilder @@ -2288,12 +2289,12 @@ public function addDocumentPaymentTerm(?string $description = null, ?DateTime $d /** * Add discount Terms to last added payment term * - * @param float|null $calculationPercent __BT-X-286, From EXTENDED__ Percentage of the down payment - * @param DateTime|null $basisDateTime __BT-X-282, From EXTENDED__ Due date reference date - * @param float|null $basisPeriodMeasureValue __BT-X-284, From EXTENDED__ Maturity period (basis) - * @param string|null $basisPeriodMeasureUnitCode __BT-X-284, From EXTENDED__ Maturity period (unit) - * @param float|null $basisAmount __BT-X-284, From EXTENDED__ Base amount of the payment discount - * @param float|null $actualDiscountAmount __BT-X-287, From EXTENDED__ Amount of the payment discount + * @param float|null $calculationPercent __BT-X-286, From EXTENDED__ Percentage of the down payment + * @param DateTime|null $basisDateTime __BT-X-282, From EXTENDED__ Due date reference date + * @param float|null $basisPeriodMeasureValue __BT-X-284, From EXTENDED__ Maturity period (basis) + * @param string|null $basisPeriodMeasureUnitCode __BT-X-284, From EXTENDED__ Maturity period (unit) + * @param float|null $basisAmount __BT-X-284, From EXTENDED__ Base amount of the payment discount + * @param float|null $actualDiscountAmount __BT-X-287, From EXTENDED__ Amount of the payment discount * @return ZugferdDocumentBuilder */ public function addDiscountTermsToPaymentTerms(?float $calculationPercent = null, ?DateTime $basisDateTime = null, ?float $basisPeriodMeasureValue = null, ?string $basisPeriodMeasureUnitCode = null, ?float $basisAmount = null, ?float $actualDiscountAmount = null): ZugferdDocumentBuilder @@ -2306,12 +2307,12 @@ public function addDiscountTermsToPaymentTerms(?float $calculationPercent = null /** * Add a payment term in XRechnung-Style (in the Form #SKONTO#TAGE=14#PROZENT=1.00#BASISBETRAG=2.53#) * - * @param string $description __BT-20, From _EN 16931 XRECHNUNG__ Text to add - * @param int[] $paymentDiscountDays __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount days (array of integer) - * @param float[] $paymentDiscountPercents __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount percents (array of decimal) - * @param float[] $paymentDiscountBaseAmounts __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount base amounts (array of decimal) - * @param DateTime|null $dueDate __BT-9, From EN 16931 XRECHNUNG__ 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. - * @param string|null $directDebitMandateID __BT-89, From EN 16931 XRECHNUNG__ Unique identifier assigned by the payee to reference the direct debit authorization. + * @param string $description __BT-20, From _EN 16931 XRECHNUNG__ Text to add + * @param int[] $paymentDiscountDays __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount days (array of integer) + * @param float[] $paymentDiscountPercents __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount percents (array of decimal) + * @param float[] $paymentDiscountBaseAmounts __BT-20, BR-DE-18, From _EN 16931 XRECHNUNG__ Array of Payment discount base amounts (array of decimal) + * @param DateTime|null $dueDate __BT-9, From EN 16931 XRECHNUNG__ 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. + * @param string|null $directDebitMandateID __BT-89, From EN 16931 XRECHNUNG__ Unique identifier assigned by the payee to reference the direct debit authorization. * @return ZugferdDocumentBuilder */ public function addDocumentPaymentTermXRechnung(string $description, array $paymentDiscountDays = [], array $paymentDiscountPercents = [], array $paymentDiscountBaseAmounts = [], ?DateTime $dueDate = null, ?string $directDebitMandateID = null): ZugferdDocumentBuilder @@ -2322,9 +2323,11 @@ public function addDocumentPaymentTermXRechnung(string $description, array $paym return $this; } - $paymentDiscountDays = array_filter($paymentDiscountDays, function ($k) use ($paymentDiscountPercents) { - return isset($paymentDiscountPercents[$k]); - }, ARRAY_FILTER_USE_KEY); + $paymentDiscountDays = array_filter( + $paymentDiscountDays, function ($k) use ($paymentDiscountPercents) { + return isset($paymentDiscountPercents[$k]); + }, ARRAY_FILTER_USE_KEY + ); if (empty($paymentDiscountDays)) { return $this->addDocumentPaymentTerm(trim($description), $dueDate, $directDebitMandateID); @@ -2352,16 +2355,16 @@ public function addDocumentPaymentTermXRechnung(string $description, array $paym /** * Add information on the booking reference * - * @param string $id __BT-19, From BASIC WL__ Posting reference of the byuer. If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice. - * @param string|null $typeCode __BT-X-290, From EXTENDED__ Type of the posting reference + * @param string $id __BT-19, From BASIC WL__ Posting reference of the byuer. If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice. + * @param string|null $typeCode __BT-X-290, From EXTENDED__ Type of the posting reference * - * Allowed values: - * - 1 Financial - * - 2 Subsidiary - * - 3 Budget - * - 4 Cost Accounting - * - 5 Payable - * - 6 Job Cose Accounting + * Allowed values: + * - 1 Financial + * - 2 Subsidiary + * - 3 Budget + * - 4 Cost Accounting + * - 5 Payable + * - 6 Job Cose Accounting * * @return ZugferdDocumentBuilder */ @@ -2446,13 +2449,13 @@ public function setDocumentSummation(float $grandTotalAmount, float $duePayableA /** * Adds a new position (line) to document * - * @param string $lineid __BT-126, From BASIC__ Identification of the invoice item - * @param string|null $lineStatusCode __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. - * @param string|null $lineStatusReasonCode __BT-X-8, From EXTENDED__ Adds the type to specify whether the invoice line is: + * @param string $lineid __BT-126, From BASIC__ Identification of the invoice item + * @param string|null $lineStatusCode __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. + * @param string|null $lineStatusReasonCode __BT-X-8, From EXTENDED__ Adds the type to specify whether the invoice line is: * - * - DETAIL: detail (normal position) - * - GROUP: Subtotal - * - INFORMATION: Information only + * - DETAIL: detail (normal position) + * - GROUP: Subtotal + * - INFORMATION: Information only * * @return ZugferdDocumentBuilder */ @@ -2467,10 +2470,10 @@ public function addNewPosition(string $lineid, ?string $lineStatusCode = null, ? /** * Adds a new text-only position (line) to document * - * @param string $lineid __BT-126, From BASIC__ Identification of the invoice item - * @param string|null $lineStatusCode __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. - * @param string|null $lineStatusReasonCode __BT-X-8, From EXTENDED__ Adds the type to specify whether the invoice line is: - * @return ZugferdDocumentBuilder + * @param string $lineid __BT-126, From BASIC__ Identification of the invoice item + * @param string|null $lineStatusCode __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. + * @param string|null $lineStatusReasonCode __BT-X-8, From EXTENDED__ Adds the type to specify whether the invoice line is: + * @return ZugferdDocumentBuilder * @deprecated 1.0.75 */ public function addNewTextPosition(string $lineid, ?string $lineStatusCode = null, ?string $lineStatusReasonCode = null): ZugferdDocumentBuilder @@ -2524,11 +2527,11 @@ public function setDocumentPositionProductDetails(string $name, ?string $descrip * Add extra characteristics to the formerly added product. * Contains information about the characteristics of the goods and services invoiced * - * @param string $description __BT-160, From EN 16931__ The name of the attribute or property of the product such as "Colour" - * @param string $value __BT-161, From EN 16931__ The value of the attribute or property of the product such as "Red" - * @param string|null $typeCode __BT-X-11, From EXTENDED__ Type of product characteristic (code). The codes must be taken from the UNTDID 6313 codelist. - * @param float|null $valueMeasure __BT-X-12, From EXTENDED__ Value of the product property (numerical measured variable) - * @param string|null $valueMeasureUnitCode __BT-X-12-0, From EXTENDED__ Unit of measurement code + * @param string $description __BT-160, From EN 16931__ The name of the attribute or property of the product such as "Colour" + * @param string $value __BT-161, From EN 16931__ The value of the attribute or property of the product such as "Red" + * @param string|null $typeCode __BT-X-11, From EXTENDED__ Type of product characteristic (code). The codes must be taken from the UNTDID 6313 codelist. + * @param float|null $valueMeasure __BT-X-12, From EXTENDED__ Value of the product property (numerical measured variable) + * @param string|null $valueMeasureUnitCode __BT-X-12-0, From EXTENDED__ Unit of measurement code * @return ZugferdDocumentBuilder */ public function addDocumentPositionProductCharacteristic(string $description, string $value, ?string $typeCode = null, ?float $valueMeasure = null, ?string $valueMeasureUnitCode = null): ZugferdDocumentBuilder @@ -2542,10 +2545,10 @@ public function addDocumentPositionProductCharacteristic(string $description, st /** * Add detailed information on product classification * - * @param string $classCode __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. - * @param string|null $className __BT-X-138, From EXTENDED__ Name with which an article can be classified according to type or quality. - * @param string|null $listId __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]. - * @param string|null $listVersionId __BT-158-2, From EN 16931__ The version of the identification scheme + * @param string $classCode __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. + * @param string|null $className __BT-X-138, From EXTENDED__ Name with which an article can be classified according to type or quality. + * @param string|null $listId __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]. + * @param string|null $listVersionId __BT-158-2, From EN 16931__ The version of the identification scheme * @return ZugferdDocumentBuilder */ public function addDocumentPositionProductClassification(string $classCode, ?string $className = null, ?string $listId = null, ?string $listVersionId = null): ZugferdDocumentBuilder @@ -2643,9 +2646,9 @@ public function setDocumentPositionQuotationReferencedDocument(string $issuerAss /** * Set details of the related contract position * - * @param string $issuerAssignedId __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) - * @param string $lineId __BT-X-25, From EXTENDED__ Identifier of the according contract position - * @param DateTime|null $issueDate __BT-X-26, From EXTENDED__ Contract date + * @param string $issuerAssignedId __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) + * @param string $lineId __BT-X-25, From EXTENDED__ Identifier of the according contract position + * @param DateTime|null $issueDate __BT-X-26, From EXTENDED__ Contract date * @return ZugferdDocumentBuilder */ public function setDocumentPositionContractReferencedDocument(string $issuerAssignedId, string $lineId, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -2668,14 +2671,14 @@ public function setDocumentPositionContractReferencedDocument(string $issuerAssi * ZugferdDocumentReader::nextDocumentAdditionalReferencedDocument to seek between multiple additional referenced * documents * - * @param string $issuerAssignedId __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. - * @param string $typeCode __BT-X-30, From EXTENDED__ Type of referenced document (See codelist UNTDID 1001) - * @param string|null $uriId __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. - * @param string|null $lineId __BT-X-29, From EXTENDED__ The referenced position identifier in the additional document - * @param string|null $name __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. - * @param string|null $refTypeCode __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. - * @param DateTime|null $issueDate __BT-X-33, From EXTENDED__ Document date - * @param string|null $binaryDataFilename __BT-X-31, From EXTENDED__ Contains a file name of an attachment document embedded as a binary object + * @param string $issuerAssignedId __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. + * @param string $typeCode __BT-X-30, From EXTENDED__ Type of referenced document (See codelist UNTDID 1001) + * @param string|null $uriId __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. + * @param string|null $lineId __BT-X-29, From EXTENDED__ The referenced position identifier in the additional document + * @param string|null $name __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. + * @param string|null $refTypeCode __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. + * @param DateTime|null $issueDate __BT-X-33, From EXTENDED__ Document date + * @param string|null $binaryDataFilename __BT-X-31, From EXTENDED__ Contains a file name of an attachment document embedded as a binary object * @return ZugferdDocumentBuilder */ public function addDocumentPositionAdditionalReferencedDocument(string $issuerAssignedId, string $typeCode, ?string $uriId = null, ?string $lineId = null, ?string $name = null, ?string $refTypeCode = null, ?DateTime $issueDate = null, ?string $binaryDataFilename = null): ZugferdDocumentBuilder @@ -2689,9 +2692,9 @@ public function addDocumentPositionAdditionalReferencedDocument(string $issuerAs /** * Add a referennce of a associated end customer order * - * @param string $issuerAssignedId __BT-X-43, From EXTENDED__ Order number of the end customer - * @param string $lineId __BT-X-44, From EXTENDED__ Order item (end customer) - * @param DateTime|null $issueDate __BT-X-45, From EXTENDED__ Document date of end customer order + * @param string $issuerAssignedId __BT-X-43, From EXTENDED__ Order number of the end customer + * @param string $lineId __BT-X-44, From EXTENDED__ Order item (end customer) + * @param DateTime|null $issueDate __BT-X-45, From EXTENDED__ Document date of end customer order * @return ZugferdDocumentBuilder */ public function addDocumentPositionUltimateCustomerOrderReferencedDocument(string $issuerAssignedId, string $lineId, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -2803,9 +2806,9 @@ public function setDocumentPositionQuantity(float $billedQuantity, string $bille /** * Set detailed information on the different ship-to party at position level * - * @param string|null $name __BT-X-50, From EXTENDED__ 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. - * @param string|null $id __BT-X-48, From EXTENDED__ An identifier for the place where the goods are delivered or where the services are provided. Multiple 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 identifier assigned by the buyer or seller. - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party (Obsolete) + * @param string|null $name __BT-X-50, From EXTENDED__ 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. + * @param string|null $id __BT-X-48, From EXTENDED__ An identifier for the place where the goods are delivered or where the services are provided. Multiple 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 identifier assigned by the buyer or seller. + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party (Obsolete) * @return ZugferdDocumentBuilder */ public function setDocumentPositionShipTo(?string $name = null, ?string $id = null, ?string $description = null): ZugferdDocumentBuilder @@ -2819,8 +2822,8 @@ public function setDocumentPositionShipTo(?string $name = null, ?string $id = nu /** * Add a global id for the Ship-to Trade Party at position level * - * @param string|null $globalID __BT-X-49, From EXTENDED__ The identifier is uniquely assigned to a party by a global registration organization. - * @param string|null $globalIDType __BT-X-49-0, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string|null $globalID __BT-X-49, From EXTENDED__ The identifier is uniquely assigned to a party by a global registration organization. + * @param string|null $globalIDType __BT-X-49-0, From EXTENDED__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdDocumentBuilder */ public function addDocumentPositionShipToGlobalId(?string $globalID = null, ?string $globalIDType = null): ZugferdDocumentBuilder @@ -2834,8 +2837,8 @@ public function addDocumentPositionShipToGlobalId(?string $globalID = null, ?str /** * Add Tax registration to Ship-To Trade party at position level * - * @param string|null $taxRegType __BT-X-66-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string|null $taxRegId __BT-X-66, From EXTENDED__ Tax number or sales tax identification number + * @param string|null $taxRegType __BT-X-66-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string|null $taxRegId __BT-X-66, From EXTENDED__ Tax number or sales tax identification number * @return ZugferdDocumentBuilder */ public function addDocumentPositionShipToTaxRegistration(?string $taxRegType = null, ?string $taxRegId = null): ZugferdDocumentBuilder @@ -2850,13 +2853,14 @@ public function addDocumentPositionShipToTaxRegistration(?string $taxRegType = n /** * Sets the postal address of the Ship-To party at position level * - * @param string|null $lineOne __BG-X-59, 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 - * @param string|null $lineTwo __BG-X-60, 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 - * @param string|null $lineThree __BG-X-61, 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 - * @param string|null $postCode __BG-X-58, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BG-X-62, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located - * @param string|null $country __BG-X-63, 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” - * @param string|null $subDivision __BG-X-64, From EXTENDED__ The product end users state + * @param string|null $lineOne __BG-X-59, 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 + * @param string|null $lineTwo __BG-X-60, 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 + * @param string|null $lineThree __BG-X-61, 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 + * @param string|null $postCode __BG-X-58, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BG-X-62, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located + * @param string|null $country __BG-X-63, 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” + * @param string|null $subDivision __BG-X-64, From EXTENDED__ The product end users state * @return ZugferdDocumentBuilder */ public function setDocumentPositionShipToAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -2871,9 +2875,9 @@ public function setDocumentPositionShipToAddress(?string $lineOne = null, ?strin /** * Set legal organisation of the Ship-To party on position level * - * @param string|null $legalOrgId __BT-X-51, 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 - * @param string|null $legalOrgType __BT-X-51-0, From EXTENDED__ Registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE - * @param string|null $legalOrgName __BT-X-52, From EXTENDED__ A name by which the party is known, if different from the party's name (also known as the company name) + * @param string|null $legalOrgId __BT-X-51, 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 + * @param string|null $legalOrgType __BT-X-51-0, From EXTENDED__ Registration of the party. In particular, the following scheme codes are used: 0021 : SWIFT, 0088 : EAN, 0060 : DUNS, 0177 : ODETTE + * @param string|null $legalOrgName __BT-X-52, From EXTENDED__ A name by which the party is known, if different from the party's name (also known as the company name) * @return ZugferdDocumentBuilder */ public function setDocumentPositionShipToLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -2888,11 +2892,11 @@ public function setDocumentPositionShipToLegalOrganisation(?string $legalOrgId, /** * Set contact of the Ship-To party on position level * - * @param string|null $contactPersonName __BT-X-54, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-54-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-55, From EXTENDED__ Detailed information on the party's phone number - * @param string|null $contactFaxNo __BT-X-56, From EXTENDED__ Detailed information on the party's fax number - * @param string|null $contactEmailAddress __BT-X-57, From EXTENDED__ Detailed information on the party's email address + * @param string|null $contactPersonName __BT-X-54, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-54-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-55, From EXTENDED__ Detailed information on the party's phone number + * @param string|null $contactFaxNo __BT-X-56, From EXTENDED__ Detailed information on the party's fax number + * @param string|null $contactEmailAddress __BT-X-57, From EXTENDED__ Detailed information on the party's email address * @return ZugferdDocumentBuilder */ public function setDocumentPositionShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -2907,11 +2911,11 @@ public function setDocumentPositionShipToContact(?string $contactPersonName, ?st /** * Add an additional contact to the Ship-To party on position level * - * @param string|null $contactPersonName __BT-X-54, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-54-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-55, From EXTENDED__ Detailed information on the party's phone number - * @param string|null $contactFaxNo __BT-X-56, From EXTENDED__ Detailed information on the party's fax number - * @param string|null $contactEmailAddress __BT-X-57, From EXTENDED__ Detailed information on the party's email address + * @param string|null $contactPersonName __BT-X-54, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-54-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-55, From EXTENDED__ Detailed information on the party's phone number + * @param string|null $contactFaxNo __BT-X-56, From EXTENDED__ Detailed information on the party's fax number + * @param string|null $contactEmailAddress __BT-X-57, From EXTENDED__ Detailed information on the party's email address * @return ZugferdDocumentBuilder */ public function addDocumentPositionShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -2926,9 +2930,9 @@ public function addDocumentPositionShipToContact(?string $contactPersonName, ?st /** * Detailed information on the different end recipient on position level * - * @param string|null $name __BT-X-69, From EXTENDED__ 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. - * @param string|null $id __BT-X-67, From EXTENDED__ An identifier for the party Multiple 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 identifier assigned by the buyer or seller. - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party (Obsolete) + * @param string|null $name __BT-X-69, From EXTENDED__ 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. + * @param string|null $id __BT-X-67, From EXTENDED__ An identifier for the party Multiple 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 identifier assigned by the buyer or seller. + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party (Obsolete) * @return ZugferdDocumentBuilder */ public function setDocumentPositionUltimateShipTo(?string $name = null, ?string $id = null, ?string $description = null): ZugferdDocumentBuilder @@ -2957,8 +2961,8 @@ public function addDocumentPositionUltimateShipToGlobalId(?string $globalID = nu /** * Add Tax registration to Ship-To Trade party on position level * - * @param string|null $taxRegType __BT-X-84-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string|null $taxRegId __BT-X-84, From EXTENDED__ Tax number or sales tax identification number + * @param string|null $taxRegType __BT-X-84-0, From EXTENDED__ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string|null $taxRegId __BT-X-84, From EXTENDED__ Tax number or sales tax identification number * @return ZugferdDocumentBuilder */ public function addDocumentPositionUltimateShipToTaxRegistration(?string $taxRegType = null, ?string $taxRegId = null): ZugferdDocumentBuilder @@ -2973,13 +2977,14 @@ public function addDocumentPositionUltimateShipToTaxRegistration(?string $taxReg /** * Sets the postal address of the Ship-To party on position level * - * @param string|null $lineOne __BT_X-77, From EXTENDED__ The main line in the party's address. This is usually the street name and house number or the post office box - * @param string|null $lineTwo __BT_X-78, 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 - * @param string|null $lineThree __BT_X-79, 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 - * @param string|null $postCode __BT_X-76, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT_X-80, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __BT_X-81, 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” - * @param string|null $subDivision __BT_X-82, From EXTENDED__ The party's state + * @param string|null $lineOne __BT_X-77, From EXTENDED__ The main line in the party's address. This is usually the street name and house number or the post office box + * @param string|null $lineTwo __BT_X-78, 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 + * @param string|null $lineThree __BT_X-79, 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 + * @param string|null $postCode __BT_X-76, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT_X-80, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __BT_X-81, 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” + * @param string|null $subDivision __BT_X-82, From EXTENDED__ The party's state * @return ZugferdDocumentBuilder */ public function setDocumentPositionUltimateShipToAddress(?string $lineOne = null, ?string $lineTwo = null, ?string $lineThree = null, ?string $postCode = null, ?string $city = null, ?string $country = null, ?string $subDivision = null): ZugferdDocumentBuilder @@ -2994,9 +2999,9 @@ public function setDocumentPositionUltimateShipToAddress(?string $lineOne = null /** * Set legal organisation of the Ship-To party on position level * - * @param string|null $legalOrgId __BT_X-70, 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 - * @param string|null $legalOrgType __BT_X-70-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 - * @param string|null $legalOrgName __BT_X-71, From EXTENDED__ A name by which the party is known, if different from the party's name (also known as the company name) + * @param string|null $legalOrgId __BT_X-70, 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 + * @param string|null $legalOrgType __BT_X-70-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 + * @param string|null $legalOrgName __BT_X-71, From EXTENDED__ A name by which the party is known, if different from the party's name (also known as the company name) * @return ZugferdDocumentBuilder */ public function setDocumentPositionUltimateShipToLegalOrganisation(?string $legalOrgId, ?string $legalOrgType, ?string $legalOrgName): ZugferdDocumentBuilder @@ -3011,11 +3016,11 @@ public function setDocumentPositionUltimateShipToLegalOrganisation(?string $lega /** * Set contact of the Ship-To party on position level * - * @param string|null $contactPersonName __BT_X-72, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT_X-72-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT_X-73, From EXTENDED__ Detailed information on the party's phone number - * @param string|null $contactFaxNo __BT_X-74, From EXTENDED__ Detailed information on the party's fax number - * @param string|null $contactEmailAddress __BT_X-75, From EXTENDED__ Detailed information on the party's email address + * @param string|null $contactPersonName __BT_X-72, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT_X-72-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT_X-73, From EXTENDED__ Detailed information on the party's phone number + * @param string|null $contactFaxNo __BT_X-74, From EXTENDED__ Detailed information on the party's fax number + * @param string|null $contactEmailAddress __BT_X-75, From EXTENDED__ Detailed information on the party's email address * @return ZugferdDocumentBuilder */ public function setDocumentPositionUltimateShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -3030,11 +3035,11 @@ public function setDocumentPositionUltimateShipToContact(?string $contactPersonN /** * Add an additional contact of the Ship-To party on position level * - * @param string|null $contactPersonName __BT_X-72, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT_X-72-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT_X-73, From EXTENDED__ Detailed information on the party's phone number - * @param string|null $contactFaxNo __BT_X-74, From EXTENDED__ Detailed information on the party's fax number - * @param string|null $contactEmailAddress __BT_X-75, From EXTENDED__ Detailed information on the party's email address + * @param string|null $contactPersonName __BT_X-72, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT_X-72-1, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT_X-73, From EXTENDED__ Detailed information on the party's phone number + * @param string|null $contactFaxNo __BT_X-74, From EXTENDED__ Detailed information on the party's fax number + * @param string|null $contactEmailAddress __BT_X-75, From EXTENDED__ Detailed information on the party's email address * @return ZugferdDocumentBuilder */ public function addDocumentPositionUltimateShipToContact(?string $contactPersonName, ?string $contactDepartmentName, ?string $contactPhoneNo, ?string $contactFaxNo, ?string $contactEmailAddress): ZugferdDocumentBuilder @@ -3063,9 +3068,9 @@ public function setDocumentPositionSupplyChainEvent(?DateTime $date): ZugferdDoc /** * Detailed information on the associated shipping notification on item level * - * @param string $issuerAssignedId __BT-X-86, From EXTENDED__ Shipping notification number - * @param string|null $lineId __BT-X-87, From EXTENDED__ Shipping notification position - * @param DateTime|null $issueDate __BT-X-88, From EXTENDED__ Date of Shipping notification number + * @param string $issuerAssignedId __BT-X-86, From EXTENDED__ Shipping notification number + * @param string|null $lineId __BT-X-87, From EXTENDED__ Shipping notification position + * @param DateTime|null $issueDate __BT-X-88, From EXTENDED__ Date of Shipping notification number * @return ZugferdDocumentBuilder */ public function setDocumentPositionDespatchAdviceReferencedDocument(string $issuerAssignedId, ?string $lineId = null, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -3079,9 +3084,9 @@ public function setDocumentPositionDespatchAdviceReferencedDocument(string $issu /** * Detailed information on the associated goods receipt notification * - * @param string $issuerAssignedId __BT-X-89, From EXTENDED__ Goods receipt number - * @param string|null $lineId __BT-X-90, From EXTENDED__ Goods receipt position - * @param DateTime|null $issueDate __BT-X-91, From EXTENDED__ Date of Goods receipt + * @param string $issuerAssignedId __BT-X-89, From EXTENDED__ Goods receipt number + * @param string|null $lineId __BT-X-90, From EXTENDED__ Goods receipt position + * @param DateTime|null $issueDate __BT-X-91, From EXTENDED__ Date of Goods receipt * @return ZugferdDocumentBuilder */ public function setDocumentPositionReceivingAdviceReferencedDocument(string $issuerAssignedId, ?string $lineId = null, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -3095,9 +3100,9 @@ public function setDocumentPositionReceivingAdviceReferencedDocument(string $iss /** * Detailed information on the associated delivery bill on item level * - * @param string $issuerAssignedId __BT-X-92, From EXTENDED__ Delivery note number - * @param string|null $lineId __BT-X-93, From EXTENDED__ Delivery note position - * @param DateTime|null $issueDate __BT-X-94, From EXTENDED__ Date of Delivery note + * @param string $issuerAssignedId __BT-X-92, From EXTENDED__ Delivery note number + * @param string|null $lineId __BT-X-93, From EXTENDED__ Delivery note position + * @param DateTime|null $issueDate __BT-X-94, From EXTENDED__ Date of Delivery note * @return ZugferdDocumentBuilder */ public function setDocumentPositionDeliveryNoteReferencedDocument(string $issuerAssignedId, ?string $lineId = null, ?DateTime $issueDate = null): ZugferdDocumentBuilder @@ -3166,7 +3171,7 @@ public function addDocumentPositionAllowanceCharge(float $actualAmount, bool $is /** * Set information on item totals * - * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. + * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. * @return ZugferdDocumentBuilder */ public function setDocumentPositionLineSummation(float $lineTotalAmount): ZugferdDocumentBuilder @@ -3180,12 +3185,12 @@ public function setDocumentPositionLineSummation(float $lineTotalAmount): Zugfer /** * Set information on item totals (with support for EXTENDED profile) * - * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item - * @param float $chargeTotalAmount __BT-X-327, From EXTENDED__ Total amount of item surcharges - * @param float $allowanceTotalAmount __BT-X-328, From EXTENDED__ Total amount of item discounts - * @param float $taxTotalAmount __BT-X-329, From EXTENDED__ Total amount of item taxes - * @param float $grandTotalAmount __BT-X-330, From EXTENDED__ Total gross amount of the item - * @param float $totalAllowanceChargeAmount __BT-X-98, From EXTENDED__ Total amount of item surcharges and discounts + * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item + * @param float $chargeTotalAmount __BT-X-327, From EXTENDED__ Total amount of item surcharges + * @param float $allowanceTotalAmount __BT-X-328, From EXTENDED__ Total amount of item discounts + * @param float $taxTotalAmount __BT-X-329, From EXTENDED__ Total amount of item taxes + * @param float $grandTotalAmount __BT-X-330, From EXTENDED__ Total gross amount of the item + * @param float $totalAllowanceChargeAmount __BT-X-98, From EXTENDED__ Total amount of item surcharges and discounts * @return ZugferdDocumentBuilder */ public function setDocumentPositionLineSummationExt(float $lineTotalAmount, ?float $chargeTotalAmount = null, ?float $allowanceTotalAmount = null, ?float $taxTotalAmount = null, ?float $grandTotalAmount = null, ?float $totalAllowanceChargeAmount = null): ZugferdDocumentBuilder @@ -3199,16 +3204,16 @@ public function setDocumentPositionLineSummationExt(float $lineTotalAmount, ?flo /** * Add an AccountingAccount on position level * - * @param string $id __BT-133, From COMFORT__ Posting reference of the byuer. If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice. - * @param string|null $typeCode __BT-X-99, From EXTENDED__ Type of the posting reference + * @param string $id __BT-133, From COMFORT__ Posting reference of the byuer. If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice. + * @param string|null $typeCode __BT-X-99, From EXTENDED__ Type of the posting reference * - * Allowed values: - * - 1 Financial - * - 2 Subsidiary - * - 3 Budget - * - 4 Cost Accounting - * - 5 Payable - * - 6 Job Cose Accounting + * Allowed values: + * - 1 Financial + * - 2 Subsidiary + * - 3 Budget + * - 4 Cost Accounting + * - 5 Payable + * - 6 Job Cose Accounting * * @return ZugferdDocumentBuilder */ diff --git a/src/ZugferdDocumentReader.php b/src/ZugferdDocumentReader.php index fb67d081..e763c95c 100644 --- a/src/ZugferdDocumentReader.php +++ b/src/ZugferdDocumentReader.php @@ -447,7 +447,7 @@ public function getDocumentNotes(?array &$notes): ZugferdDocumentReader * standard, two syntaxes are permitted for displaying electronic invoices: Universal Business Language (UBL) and UN/CEFACT * Cross Industry Invoice (CII). * - * @param string|null $buyerReference __BT-10, From MINIMUM__ An identifier assigned by the buyer and used for internal routing + * @param string|null $buyerReference __BT-10, From MINIMUM__ An identifier assigned by the buyer and used for internal routing * @return ZugferdDocumentReader */ public function getDocumentBuyerReference(?string &$buyerReference): ZugferdDocumentReader @@ -459,9 +459,9 @@ public function getDocumentBuyerReference(?string &$buyerReference): ZugferdDocu /** * Get detailed information about the seller (=service provider) * - * @param string|null $name __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) - * @param array|null $id __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 - * @param string|null $description __BT-33, From EN 16931__ Further legal information that is relevant for the seller + * @param string|null $name __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) + * @param array|null $id __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 + * @param string|null $description __BT-33, From EN 16931__ Further legal information that is relevant for the seller * @return ZugferdDocumentReader */ public function getDocumentSeller(?string &$name, ?array &$id, ?string &$description): ZugferdDocumentReader @@ -478,7 +478,7 @@ public function getDocumentSeller(?string &$name, ?array &$id, ?string &$descrip /** * Get global identifiers of the seller. * - * @param array|null $globalID __BT-29/BT-29-0/BT-29-1, From BASIC WL__ Array of the sellers global ids indexed by the identification scheme. + * @param array|null $globalID __BT-29/BT-29-0/BT-29-1, From BASIC WL__ Array of the sellers global ids indexed by the identification scheme. * @return ZugferdDocumentReader */ public function getDocumentSellerGlobalId(?array &$globalID): ZugferdDocumentReader @@ -512,7 +512,7 @@ public function getDocumentSellerTaxRegistration(?array &$taxReg): ZugferdDocume * @param string|null $postCode __BT-38, From BASIC WL__ Identifier for a group of properties, such as a zip code * @param string|null $city __BT-37, From BASIC WL__ Usual name of the city or municipality in which the seller's address is located * @param string|null $country __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” - * @param array|null $subDivision __BT-39, From BASIC WL__ The sellers state + * @param array|null $subDivision __BT-39, From BASIC WL__ The sellers state * @return ZugferdDocumentReader */ public function getDocumentSellerAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -837,9 +837,9 @@ public function getDocumentSellerTaxRepresentativeAddress(?string &$lineOne, ?st /** * Get the legal organisation of sellers tax agent * - * @param string|null $legalOrgId __BT-, From __ An identifier issued by an official registrar that identifies the seller tax agent as a legal entity or legal person. - * @param string|null $legalOrgType __BT-, From __ 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 - * @param string|null $legalOrgName __BT-, From __ A name by which the sellers tax agent is known, if different from the sellers tax agent name (also known as the company name) + * @param string|null $legalOrgId __BT-, From __ An identifier issued by an official registrar that identifies the seller tax agent as a legal entity or legal person. + * @param string|null $legalOrgType __BT-, From __ 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 + * @param string|null $legalOrgName __BT-, From __ A name by which the sellers tax agent is known, if different from the sellers tax agent name (also known as the company name) * @return ZugferdDocumentReader */ public function getDocumentSellerTaxRepresentativeLegalOrganisation(?string &$legalOrgId, ?string &$legalOrgType, ?string &$legalOrgName): ZugferdDocumentReader @@ -880,11 +880,11 @@ public function nextDocumentSellerTaxRepresentativeContact(): bool /** * Get contact information of sellers tax agent * - * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office - * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. - * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-120, From EXTENDED__ Such as personal name, name of contact person or department or office + * @param string|null $contactDepartmentName __BT-X-121, From EXTENDED__ If a contact person is specified, either the name or the department must be transmitted. + * @param string|null $contactPhoneNo __BT-X-122, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-123, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-124, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentSellerTaxRepresentativeContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -903,9 +903,9 @@ public function getDocumentSellerTaxRepresentativeContact(?string &$contactPerso /** * Get detailed information on the product end user (general information) * - * @param string $name __BT-X-128, From EXTENDED__ Name/company name of the end user - * @param array|null $id __BT-X-126, From EXTENDED__ An array of identifiers of the product end user - * @param string|null $description __BT-, From __ Further legal information that is relevant for the product end user + * @param string $name __BT-X-128, From EXTENDED__ Name/company name of the end user + * @param array|null $id __BT-X-126, From EXTENDED__ An array of identifiers of the product end user + * @param string|null $description __BT-, From __ Further legal information that is relevant for the product end user * @return ZugferdDocumentReader */ public function getDocumentProductEndUser(?string &$name, ?array &$id, ?string &$description): ZugferdDocumentReader @@ -950,13 +950,14 @@ public function getDocumentProductEndUserTaxRegistration(?array &$taxReg): Zugfe /** * Get the address of product end user * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-396, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-400, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located - * @param string|null $country __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” - * @param array|null $subDivision __BT-X-402, From EXTENDED__ The product end users state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-396, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-400, From EXTENDED__ Usual name of the city or municipality in which the product end users address is located + * @param string|null $country __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” + * @param array|null $subDivision __BT-X-402, From EXTENDED__ The product end users state * @return ZugferdDocumentReader */ public function getDocumentProductEndUserAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -975,9 +976,9 @@ public function getDocumentProductEndUserAddress(?string &$lineOne, ?string &$li /** * Get the legal organisation of product end user * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentReader */ public function getDocumentProductEndUserLegalOrganisation(?string &$legalOrgId, ?string &$legalOrgType, ?string &$legalOrgName): ZugferdDocumentReader @@ -1018,11 +1019,11 @@ public function nextDocumentProductEndUserContactContact(): bool /** * Get detailed information on the product end user's contact person * - * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-131, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-132, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-133, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-134, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-135, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentProductEndUserContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1060,7 +1061,7 @@ public function getDocumentShipTo(?string &$name, ?array &$id, ?string &$descrip /** * Get global identifier for the Ship-To party * - * @param array|null $globalID __BT-71-0/BT-71-1, From BASIC WL__ Array of global ids indexed by the identification scheme. + * @param array|null $globalID __BT-71-0/BT-71-1, From BASIC WL__ Array of global ids indexed by the identification scheme. * @return ZugferdDocumentReader */ public function getDocumentShipToGlobalId(?array &$globalID): ZugferdDocumentReader @@ -1094,7 +1095,7 @@ public function getDocumentShipToTaxRegistration(?array &$taxReg): ZugferdDocume * @param string|null $postCode __BT-78, From BASIC WL__ Identifier for a group of properties, such as a zip code * @param string|null $city __BT-77, From BASIC WL__ Usual name of the city or municipality in which the party's address is located * @param string|null $country __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” - * @param array|null $subDivision __BT-79, From BASIC WL__ The party's state + * @param array|null $subDivision __BT-79, From BASIC WL__ The party's state * @return ZugferdDocumentReader */ public function getDocumentShipToAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -1232,7 +1233,7 @@ public function getDocumentUltimateShipToTaxRegistration(?array &$taxReg): Zugfe * @param string|null $postCode __BT-X-172, From EXTENDED__ Identifier for a group of properties, such as a zip code * @param string|null $city __BT-X-176, From EXTENDED__ Usual name of the city or municipality in which the party's address is located * @param string|null $country __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” - * @param array|null $subDivision __BT-X-178, From EXTENDED__ The party's state + * @param array|null $subDivision __BT-X-178, From EXTENDED__ The party's state * @return ZugferdDocumentReader */ public function getDocumentUltimateShipToAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -1294,11 +1295,11 @@ public function nextDocumentUltimateShipToContact(): bool /** * Get detailed information on the contact person of the different end recipient party * - * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-167, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-168, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-169, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-170, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-171, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentUltimateShipToContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1364,13 +1365,14 @@ public function getDocumentShipFromTaxRegistration(?array &$taxReg): ZugferdDocu /** * Get Detailed information on the address of the deviating consignor party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-191, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-195, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param array|null $subDivision __BT-X-197, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-191, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-195, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param array|null $subDivision __BT-X-197, From EXTENDED__ The party's state * @return ZugferdDocumentReader */ public function getDocumentShipFromAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -1389,9 +1391,9 @@ public function getDocumentShipFromAddress(?string &$lineOne, ?string &$lineTwo, /** * Get information about the legal organisation of the deviating consignor party * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentReader */ public function getDocumentShipFromLegalOrganisation(?string &$legalOrgId, ?string &$legalOrgType, ?string &$legalOrgName): ZugferdDocumentReader @@ -1432,11 +1434,11 @@ public function nextDocumentShipFromContact(): bool /** * Get contact information of the deviating consignor party * - * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-186, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-187, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-188, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-189, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-190, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentShipFromContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1455,9 +1457,9 @@ public function getDocumentShipFromContact(?string &$contactPersonName, ?string /** * Get detailed information of the invoicer party * - * @param string $name __BT-X-207, From EXTENDED__ The name of the party - * @param array|null $id __BT-X-205, From EXTENDED__ An array of identifiers - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party + * @param string $name __BT-X-207, From EXTENDED__ The name of the party + * @param array|null $id __BT-X-205, From EXTENDED__ An array of identifiers + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party * @return ZugferdDocumentReader */ public function getDocumentInvoicer(?string &$name, ?array &$id, ?string &$description): ZugferdDocumentReader @@ -1570,11 +1572,11 @@ public function nextDocumentInvoicerContact(): bool /** * Get contact information of the invoicer party * - * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-210, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-211, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-212, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-213, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-214, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentInvoicerContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1593,9 +1595,9 @@ public function getDocumentInvoicerContact(?string &$contactPersonName, ?string /** * Get detailed information on the different invoice recipient party * - * @param string $name __BT-X-226, From EXTENDED__ The name of the party - * @param array|null $id __BT-X-224, From EXTENDED__ An array of identifiers - * @param string|null $description __BT-, From __ Further legal information that is relevant for the party + * @param string $name __BT-X-226, From EXTENDED__ The name of the party + * @param array|null $id __BT-X-224, From EXTENDED__ An array of identifiers + * @param string|null $description __BT-, From __ Further legal information that is relevant for the party * @return ZugferdDocumentReader */ public function getDocumentInvoicee(?string &$name, ?array &$id, ?string &$description): ZugferdDocumentReader @@ -1640,13 +1642,14 @@ public function getDocumentInvoiceeTaxRegistration(?array &$taxReg): ZugferdDocu /** * Get Detailed information on the address of the different invoice recipient party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-234, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-238, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param array|null $subDivision __BT-X-240, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-234, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-238, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param array|null $subDivision __BT-X-240, From EXTENDED__ The party's state * @return ZugferdDocumentReader */ public function getDocumentInvoiceeAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -1665,9 +1668,9 @@ public function getDocumentInvoiceeAddress(?string &$lineOne, ?string &$lineTwo, /** * Get information about the legal organisation of the different invoice recipient party * - * @param string|null $legalOrgId __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 - * @param string|null $legalOrgType __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 - * @param string|null $legalOrgName __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) + * @param string|null $legalOrgId __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 + * @param string|null $legalOrgType __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 + * @param string|null $legalOrgName __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) * @return ZugferdDocumentReader */ public function getDocumentInvoiceeLegalOrganisation(?string &$legalOrgId, ?string &$legalOrgType, ?string &$legalOrgName): ZugferdDocumentReader @@ -1708,11 +1711,11 @@ public function nextDocumentInvoiceeContact(): bool /** * Get contact information of the different invoice recipient party * - * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-229, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-230, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-231, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-232, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-233, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentInvoiceeContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1779,13 +1782,14 @@ public function getDocumentPayeeTaxRegistration(?array &$taxReg): ZugferdDocumen /** * Get Detailed information on the address of the payee party * - * @param string|null $lineOne __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 - * @param string|null $lineTwo __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 - * @param string|null $lineThree __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 - * @param string|null $postCode __BT-X-249, From EXTENDED__ Identifier for a group of properties, such as a zip code - * @param string|null $city __BT-X-253, From EXTENDED__ Usual name of the city or municipality in which the party's address is located - * @param string|null $country __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” - * @param array|null $subDivision __BT-X-255, From EXTENDED__ The party's state + * @param string|null $lineOne __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 + * @param string|null $lineTwo __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 + * @param string|null $lineThree __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 + * @param string|null $postCode __BT-X-249, From EXTENDED__ Identifier for a group of properties, such as a zip code + * @param string|null $city __BT-X-253, From EXTENDED__ Usual name of the city or municipality in which the party's address is located + * @param string|null $country __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” + * @param array|null $subDivision __BT-X-255, From EXTENDED__ The party's state * @return ZugferdDocumentReader */ public function getDocumentPayeeAddress(?string &$lineOne, ?string &$lineTwo, ?string &$lineThree, ?string &$postCode, ?string &$city, ?string &$country, ?array &$subDivision): ZugferdDocumentReader @@ -1847,11 +1851,11 @@ public function nextDocumentPayeeContact(): bool /** * Get contact information of the payee party * - * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point - * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point - * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point + * @param string|null $contactPersonName __BT-X-244, From EXTENDED__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $contactDepartmentName __BT-X-245, From EXTENDED__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $contactPhoneNo __BT-X-246, From EXTENDED__ A telephone number for the contact point + * @param string|null $contactFaxNo __BT-X-247, From EXTENDED__ A fax number of the contact point + * @param string|null $contactEmailAddress __BT-X-248, From EXTENDED__ An e-mail address of the contact point * @return ZugferdDocumentReader */ public function getDocumentPayeeContact(?string &$contactPersonName, ?string &$contactDepartmentName, ?string &$contactPhoneNo, ?string &$contactFaxNo, ?string &$contactEmailAddress): ZugferdDocumentReader @@ -1991,17 +1995,18 @@ public function nextDocumentAdditionalReferencedDocument(): bool * ZugferdDocumentReader::nextDocumentAdditionalReferencedDocument to seek between multiple additional referenced * documents * - * @param string $issuerAssignedId __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. - * @param string $typeCode __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. - * @param string|null $uriId __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. - * @param array|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. - * @param string|null $refTypeCode __BT-, From __ 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. - * @param DateTime|null $issueDate __BT-X-149, From EXTENDED__ Document date - * @param string|null $binaryDataFilename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object + * @param string $issuerAssignedId __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. + * @param string $typeCode __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. + * @param string|null $uriId __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. + * @param array|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. + * @param string|null $refTypeCode __BT-, From __ 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. + * @param DateTime|null $issueDate __BT-X-149, From EXTENDED__ Document date + * @param string|null $binaryDataFilename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object * @return ZugferdDocumentReader */ public function getDocumentAdditionalReferencedDocument(?string &$issuerAssignedId, ?string &$typeCode, ?string &$uriId = null, ?array &$name = null, ?string &$refTypeCode = null, ?DateTime &$issueDate = null, ?string &$binaryDataFilename = null): ZugferdDocumentReader @@ -2086,9 +2091,9 @@ public function nextDocumentInvoiceReferencedDocument(): bool /** * Get reference to the previous invoice * - * @param string $issuerAssignedId __BT-25, From BASIC WL__ The identification of an invoice previously sent by the seller - * @param string|null $typeCode __BT-X-555, From EXTENDED__ Type of previous invoice (code) - * @param DateTime|null $issueDate __BT-26, From BASIC WL__ Date of the previous invoice + * @param string $issuerAssignedId __BT-25, From BASIC WL__ The identification of an invoice previously sent by the seller + * @param string|null $typeCode __BT-X-555, From EXTENDED__ Type of previous invoice (code) + * @param DateTime|null $issueDate __BT-26, From BASIC WL__ Date of the previous invoice */ public function getDocumentInvoiceReferencedDocument(?string &$issuerAssignedId, ?string &$typeCode, ?DateTime &$issueDate = null): ZugferdDocumentReader { @@ -2170,8 +2175,8 @@ public function nextDocumentUltimateCustomerOrderReferencedDocument(): bool /** * Get details of the ultimate customer order * - * @param string|null $issuerAssignedId __BT-X-150, From EXTENDED__ Order number of the end customer - * @param DateTime|null $issueDate __BT-X-151, From EXTENDED__ Date of the order issued by the end customer + * @param string|null $issuerAssignedId __BT-X-150, From EXTENDED__ Order number of the end customer + * @param DateTime|null $issueDate __BT-X-151, From EXTENDED__ Date of the order issued by the end customer * @return ZugferdDocumentReader */ public function getDocumentUltimateCustomerOrderReferencedDocument(?string &$issuerAssignedId, ?DateTime &$issueDate): ZugferdDocumentReader @@ -2254,8 +2259,8 @@ public function getDocumentReceivingAdviceReferencedDocument(?string &$issuerAss /** * Get detailed information on the associated delivery note * - * @param string $issuerAssignedId __BT-X-202, From EXTENDED__ Delivery slip number - * @param DateTime|null $issueDate __BT-X-203, From EXTENDED__ Delivery slip date + * @param string $issuerAssignedId __BT-X-202, From EXTENDED__ Delivery slip number + * @param DateTime|null $issueDate __BT-X-203, From EXTENDED__ Delivery slip date * @return ZugferdDocumentReader */ public function getDocumentDeliveryNoteReferencedDocument(?string &$issuerAssignedId, ?DateTime &$issueDate): ZugferdDocumentReader @@ -2298,17 +2303,17 @@ public function nextGetDocumentPaymentMeans(): bool /** * Get detailed information on the payment method * - * @param string $typeCode __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 + * @param string $typeCode __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 * @param string|null $information __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. * @param string|null $cardType __BT-, From __ The type of the card * @param string|null $cardId __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 @@ -2368,17 +2373,17 @@ public function nextDocumentTax(): bool /** * Get current VAT breakdown (at document level) * - * @param string|null $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category - * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" - * @param float|null $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. - * @param float|null $calculatedAmount __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 - * @param float|null $rateApplicablePercent __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) - * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) - * @param string|null $exemptionReasonCode __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. - * @param float|null $lineTotalBasisAmount __BT-X-262, From EXTENDED__ An amount used as the basis for calculating sales tax, duty or customs duty - * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level - * @param DateTime|null $taxPointDate __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. - * @param string|null $dueDateTypeCode __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 + * @param string|null $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category + * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" + * @param float|null $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. + * @param float|null $calculatedAmount __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 + * @param float|null $rateApplicablePercent __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) + * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) + * @param string|null $exemptionReasonCode __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. + * @param float|null $lineTotalBasisAmount __BT-X-262, From EXTENDED__ An amount used as the basis for calculating sales tax, duty or customs duty + * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level + * @param DateTime|null $taxPointDate __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. + * @param string|null $dueDateTypeCode __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 */ 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): ZugferdDocumentReader { @@ -2406,8 +2411,8 @@ public function getDocumentTax(?string &$categoryCode, ?string &$typeCode, ?floa /** * Get detailed information on the billing period * - * @param DateTime|null $startDate __BT-73, From BASIC WL__ Start of the billing period - * @param DateTime|null $endDate __BT-74, From BASIC WL__ End of the billing period + * @param DateTime|null $startDate __BT-73, From BASIC WL__ Start of the billing period + * @param DateTime|null $endDate __BT-74, From BASIC WL__ End of the billing period * @return ZugferdDocumentReader */ public function getDocumentBillingPeriod(?DateTime &$startDate, ?DateTime &$endDate): ZugferdDocumentReader @@ -2680,12 +2685,12 @@ public function getDocumentPaymentTerm(?string &$description, ?DateTime &$dueDat /** * Get detailed information on payment discounts * - * @param float|null $calculationPercent __BT-X-286, From EXTENDED__ Percentage of the down payment - * @param DateTime|null $basisDateTime __BT-X-282, From EXTENDED__ Due date reference date - * @param float|null $basisPeriodMeasureValue __BT-X-284, From EXTENDED__ Maturity period (basis) - * @param string|null $basisPeriodMeasureUnitCode __BT-X-284, From EXTENDED__ Maturity period (unit) - * @param float|null $basisAmount __BT-X-284, From EXTENDED__ Base amount of the payment discount - * @param float|null $actualDiscountAmount __BT-X-287, From EXTENDED__ Amount of the payment discount + * @param float|null $calculationPercent __BT-X-286, From EXTENDED__ Percentage of the down payment + * @param DateTime|null $basisDateTime __BT-X-282, From EXTENDED__ Due date reference date + * @param float|null $basisPeriodMeasureValue __BT-X-284, From EXTENDED__ Maturity period (basis) + * @param string|null $basisPeriodMeasureUnitCode __BT-X-284, From EXTENDED__ Maturity period (unit) + * @param float|null $basisAmount __BT-X-284, From EXTENDED__ Base amount of the payment discount + * @param float|null $actualDiscountAmount __BT-X-287, From EXTENDED__ Amount of the payment discount * @return ZugferdDocumentReader */ public function getDiscountTermsFromPaymentTerm(?float &$calculationPercent, ?DateTime &$basisDateTime, ?float &$basisPeriodMeasureValue, ?string &$basisPeriodMeasureUnitCode, ?float &$basisAmount, ?float &$actualDiscountAmount): ZugferdDocumentReader @@ -2835,12 +2840,12 @@ public function getDocumentPositionNote(?string &$content, ?string &$contentCode /** * Get information about the goods and services billed * - * @param string|null $name __BT-153, From BASIC__ A name of the item (item name) - * @param string|null $description __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. - * @param string|null $sellerAssignedID __BT-155, From EN 16931__ An identifier assigned to the item by the seller - * @param string|null $buyerAssignedID __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. - * @param string|null $globalIDType __BT-157-1, From BASIC__ The scheme for $globalID - * @param string|null $globalID __BT-157, From BASIC__ Identification of an article according to the registered scheme (Global identifier of the product, GTIN, ...) + * @param string|null $name __BT-153, From BASIC__ A name of the item (item name) + * @param string|null $description __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. + * @param string|null $sellerAssignedID __BT-155, From EN 16931__ An identifier assigned to the item by the seller + * @param string|null $buyerAssignedID __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. + * @param string|null $globalIDType __BT-157-1, From BASIC__ The scheme for $globalID + * @param string|null $globalID __BT-157, From BASIC__ Identification of an article according to the registered scheme (Global identifier of the product, GTIN, ...) * @return ZugferdDocumentReader */ public function getDocumentPositionProductDetails(?string &$name, ?string &$description, ?string &$sellerAssignedID, ?string &$buyerAssignedID, ?string &$globalIDType, ?string &$globalID): ZugferdDocumentReader @@ -2935,11 +2940,11 @@ public function nextDocumentPositionProductCharacteristic(): bool * Get extra characteristics to the formerly added product. * Contains information about the characteristics of the goods and services invoiced * - * @param string $description __BT-160, From EN 16931__ The name of the attribute or property of the product such as "Colour" - * @param string $value __BT-161, From EN 16931__ The value of the attribute or property of the product such as "Red" - * @param string|null $typeCode __BT-X-11, From EXTENDED__ Type of product characteristic (code). The codes must be taken from the UNTDID 6313 codelist. - * @param float|null $valueMeasure __BT-X-12, From EXTENDED__ Value of the product property (numerical measured variable) - * @param string|null $valueMeasureUnitCode __BT-X-12-0, From EXTENDED__ Unit of measurement code + * @param string $description __BT-160, From EN 16931__ The name of the attribute or property of the product such as "Colour" + * @param string $value __BT-161, From EN 16931__ The value of the attribute or property of the product such as "Red" + * @param string|null $typeCode __BT-X-11, From EXTENDED__ Type of product characteristic (code). The codes must be taken from the UNTDID 6313 codelist. + * @param float|null $valueMeasure __BT-X-12, From EXTENDED__ Value of the product property (numerical measured variable) + * @param string|null $valueMeasureUnitCode __BT-X-12-0, From EXTENDED__ Unit of measurement code * @return ZugferdDocumentReader */ public function getDocumentPositionProductCharacteristic(?string &$description, ?string &$value, ?string &$typeCode, ?float &$valueMeasure, ?string &$valueMeasureUnitCode): ZugferdDocumentReader @@ -2997,10 +3002,10 @@ public function nextDocumentPositionProductClassification(): bool /** * Get detailed information on product classification * - * @param string $classCode __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. - * @param string|null $className __BT-X-138, From EXTENDED__ Name with which an article can be classified according to type or quality. - * @param string|null $listID __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]. - * @param string|null $listVersionID __BT-158-2, From EN 16931__ The version of the identification scheme + * @param string $classCode __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. + * @param string|null $className __BT-X-138, From EXTENDED__ Name with which an article can be classified according to type or quality. + * @param string|null $listID __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]. + * @param string|null $listVersionID __BT-158-2, From EN 16931__ The version of the identification scheme * @return ZugferdDocumentReader */ public function getDocumentPositionProductClassification(?string &$classCode, ?string &$className, ?string &$listID, ?string &$listVersionID): ZugferdDocumentReader @@ -3159,9 +3164,9 @@ public function getDocumentPositionQuotationReferencedDocument(?string &$issuerA /** * Get details of the related contract position * - * @param string|null $issuerAssignedId __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) - * @param string|null $lineId __BT-X-25, From EXTENDED__ Identifier of the according contract position - * @param DateTime|null $issueDate __BT-X-26, From EXTENDED__ Contract date + * @param string|null $issuerAssignedId __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) + * @param string|null $lineId __BT-X-25, From EXTENDED__ Identifier of the according contract position + * @param DateTime|null $issueDate __BT-X-26, From EXTENDED__ Contract date * @return ZugferdDocumentReader */ public function getDocumentPositionContractReferencedDocument(?string &$issuerAssignedId, ?string &$lineId, ?DateTime &$issueDate): ZugferdDocumentReader @@ -3221,13 +3226,13 @@ public function nextDocumentPositionAdditionalReferencedDocument(): bool * ZugferdDocumentReader::nextDocumentAdditionalReferencedDocument to seek between multiple additional referenced * documents * - * @param string|null $issuerAssignedId __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. - * @param string|null $typeCode __BT-X-30, From EXTENDED__ Type of referenced document (See codelist UNTDID 1001) - * @param string|null $uriId __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. - * @param string|null $lineId __BT-X-29, From EXTENDED__ The referenced position identifier in the additional document - * @param string|null $name __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. - * @param string|null $refTypeCode __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. - * @param DateTime|null $issueDate __BT-X-33, From EXTENDED__ Document date + * @param string|null $issuerAssignedId __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. + * @param string|null $typeCode __BT-X-30, From EXTENDED__ Type of referenced document (See codelist UNTDID 1001) + * @param string|null $uriId __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. + * @param string|null $lineId __BT-X-29, From EXTENDED__ The referenced position identifier in the additional document + * @param string|null $name __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. + * @param string|null $refTypeCode __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. + * @param DateTime|null $issueDate __BT-X-33, From EXTENDED__ Document date * @return ZugferdDocumentReader */ public function getDocumentPositionAdditionalReferencedDocument(?string &$issuerAssignedId, ?string &$typeCode, ?string &$uriId, ?string &$lineId, ?string &$name, ?string &$refTypeCode, ?DateTime &$issueDate): ZugferdDocumentReader @@ -3442,9 +3447,9 @@ public function getDocumentPositionSupplyChainEvent(?DateTime &$date): ZugferdDo /** * Get detailed information on the associated shipping notification (on position level) * - * @param string|null $issuerAssignedId __BT-X-86, From EXTENDED__ Shipping notification number - * @param string|null $lineId __BT-X-87, From EXTENDED__ Shipping notification position - * @param DateTime|null $issueDate __BT-X-88, From EXTENDED__ Date of Shipping notification number + * @param string|null $issuerAssignedId __BT-X-86, From EXTENDED__ Shipping notification number + * @param string|null $lineId __BT-X-87, From EXTENDED__ Shipping notification position + * @param DateTime|null $issueDate __BT-X-88, From EXTENDED__ Date of Shipping notification number * @return ZugferdDocumentReader */ public function getDocumentPositionDespatchAdviceReferencedDocument(?string &$issuerAssignedId, ?string &$lineId = null, ?DateTime &$issueDate = null): ZugferdDocumentReader @@ -3465,9 +3470,9 @@ public function getDocumentPositionDespatchAdviceReferencedDocument(?string &$is /** * Detailed information on the associated shipping notification (on position level) * - * @param string|null $issuerAssignedId __BT-X-89, From EXTENDED__ Goods receipt number - * @param string|null $lineId __BT-X-90, From EXTENDED__ Goods receipt position - * @param DateTime|null $issueDate __BT-X-91, From EXTENDED__ Date of Goods receipt + * @param string|null $issuerAssignedId __BT-X-89, From EXTENDED__ Goods receipt number + * @param string|null $lineId __BT-X-90, From EXTENDED__ Goods receipt position + * @param DateTime|null $issueDate __BT-X-91, From EXTENDED__ Date of Goods receipt * @return ZugferdDocumentReader */ public function getDocumentPositionReceivingAdviceReferencedDocument(?string &$issuerAssignedId, ?string &$lineId, ?DateTime &$issueDate): ZugferdDocumentReader @@ -3488,9 +3493,9 @@ public function getDocumentPositionReceivingAdviceReferencedDocument(?string &$i /** * Detailed information on the associated delivery note on position level * - * @param string|null $issuerAssignedId __BT-X-92, From EXTENDED__ Delivery note number - * @param string|null $lineId __BT-X-93, From EXTENDED__ Delivery note position - * @param DateTime|null $issueDate __BT-X-94, From EXTENDED__ Date of Delivery note + * @param string|null $issuerAssignedId __BT-X-92, From EXTENDED__ Delivery note number + * @param string|null $lineId __BT-X-93, From EXTENDED__ Delivery note position + * @param DateTime|null $issueDate __BT-X-94, From EXTENDED__ Date of Delivery note * @return ZugferdDocumentReader */ public function getDocumentPositionDeliveryNoteReferencedDocument(?string &$issuerAssignedId, ?string &$lineId, ?DateTime &$issueDate): ZugferdDocumentReader @@ -3638,18 +3643,18 @@ public function nextDocumentPositionAllowanceCharge(): bool /** * Detailed information on currentley seeked surcharges and discounts on position level * - * @param float|null $actualAmount __BT-136/BT-141, From BASIC__ The surcharge/discount amount excluding sales tax - * @param boolean|null $isCharge __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 - * @param float|null $calculationPercent __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 - * @param float|null $basisAmount __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 - * @param string|null $reason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount/surcharge + * @param float|null $actualAmount __BT-136/BT-141, From BASIC__ The surcharge/discount amount excluding sales tax + * @param boolean|null $isCharge __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 + * @param float|null $calculationPercent __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 + * @param float|null $basisAmount __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 + * @param string|null $reason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount/surcharge * @param string|null $taxTypeCode * @param string|null $taxCategoryCode * @param float|null $rateApplicablePercent * @param float|null $sequence * @param float|null $basisQuantity * @param string|null $basisQuantityUnitCode - * @param string|null $reasonCode __BT-140/BT-145, From BASIC__ The reason given as a code for the invoice line discount + * @param string|null $reasonCode __BT-140/BT-145, From BASIC__ The reason given as a code for the invoice line discount * @return ZugferdDocumentReader */ 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 @@ -3709,9 +3714,9 @@ public function getDocumentPositionAllowanceCharge2(?float &$actualAmount, ?bool /** * Get detailed information on item totals * - * @param float|null $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. - * @param float|null $totalAllowanceChargeAmount __BT-, From __ Total amount of item surcharges and discounts - * @return ZugferdDocumentReader + * @param float|null $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. + * @param float|null $totalAllowanceChargeAmount __BT-, From __ Total amount of item surcharges and discounts + * @return ZugferdDocumentReader * @deprecated 1.0.88 */ public function getDocumentPositionLineSummation(?float &$lineTotalAmount, ?float &$totalAllowanceChargeAmount): ZugferdDocumentReader @@ -3726,7 +3731,7 @@ public function getDocumentPositionLineSummation(?float &$lineTotalAmount, ?floa /** * Get detailed information on item totals * - * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. + * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item. * @return ZugferdDocumentReader */ public function getDocumentPositionLineSummationSimple(?float &$lineTotalAmount): ZugferdDocumentReader @@ -3742,12 +3747,12 @@ public function getDocumentPositionLineSummationSimple(?float &$lineTotalAmount) /** * Get detailed information on item totals (with support for EXTENDED profile) * - * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item - * @param float $chargeTotalAmount __BT-X-327, From EXTENDED__ Total amount of item surcharges - * @param float $allowanceTotalAmount __BT-X-328, From EXTENDED__ Total amount of item discounts - * @param float $taxTotalAmount __BT-X-329, From EXTENDED__ Total amount of item taxes - * @param float $grandTotalAmount __BT-X-330, From EXTENDED__ Total gross amount of the item - * @param float $totalAllowanceChargeAmount __BT-X-98, From EXTENDED__ Total amount of item surcharges and discounts + * @param float $lineTotalAmount __BT-131, From BASIC__ The total amount of the invoice item + * @param float $chargeTotalAmount __BT-X-327, From EXTENDED__ Total amount of item surcharges + * @param float $allowanceTotalAmount __BT-X-328, From EXTENDED__ Total amount of item discounts + * @param float $taxTotalAmount __BT-X-329, From EXTENDED__ Total amount of item taxes + * @param float $grandTotalAmount __BT-X-330, From EXTENDED__ Total gross amount of the item + * @param float $totalAllowanceChargeAmount __BT-X-98, From EXTENDED__ Total amount of item surcharges and discounts * @return ZugferdDocumentReader */ public function getDocumentPositionLineSummationExt(?float &$lineTotalAmount, ?float &$chargeTotalAmount, ?float &$allowanceTotalAmount, ?float &$taxTotalAmount, ?float &$grandTotalAmount, ?float &$totalAllowanceChargeAmount): ZugferdDocumentReader diff --git a/src/quick/ZugferdQuickDescriptor.php b/src/quick/ZugferdQuickDescriptor.php index 0a90f738..251420e7 100644 --- a/src/quick/ZugferdQuickDescriptor.php +++ b/src/quick/ZugferdQuickDescriptor.php @@ -99,10 +99,10 @@ protected function onBeforeGetContent() /** * Create a new invoice * - * @param string $invoiceNo __BT-1, From MINIMUM__ The document no issued by the seller - * @param \DateTime $invoiceDate __BT-2, From MINIMUM__ Date of invoice. The date when the document was issued by the seller - * @param string $currency __BT-5, From MINIMUM__ Code for the invoice currency - * @param string|null $invoiceNoReference __BT-83, From BASIC WL__ Intended use for payment + * @param string $invoiceNo __BT-1, From MINIMUM__ The document no issued by the seller + * @param \DateTime $invoiceDate __BT-2, From MINIMUM__ Date of invoice. The date when the document was issued by the seller + * @param string $currency __BT-5, From MINIMUM__ Code for the invoice currency + * @param string|null $invoiceNoReference __BT-83, From BASIC WL__ Intended use for payment * @return ZugferdQuickDescriptor */ public function doCreateInvoice(string $invoiceNo, \DateTime $invoiceDate, string $currency, ?string $invoiceNoReference = null): ZugferdQuickDescriptor @@ -131,8 +131,8 @@ public function doCreateCreditMemo(string $creditMemoNo, \DateTime $invoiceDate, /** * Add a payment term * - * @param string|null $description __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. - * @param DateTime|null $dueDate __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. + * @param string|null $description __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. + * @param DateTime|null $dueDate __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. * @return ZugferdQuickDescriptor */ public function doSetPaymentTerms(string $description, ?DateTime $dueDate = null): ZugferdQuickDescriptor @@ -147,8 +147,8 @@ public function doSetPaymentTerms(string $description, ?DateTime $dueDate = null * If $isSEPA is true code __31__ wil be useed for payment means code. * If $isSEPA is false code __59__ wil be useed for payment means code. * - * @param boolean $isSEPA __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: - * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit + * @param boolean $isSEPA __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: + * @param string $buyerIban __BT-91, From BASIC WL__ The account to be debited by the direct debit * @return ZugferdQuickDescriptor */ public function doSetPaymentMeansForDebitTransfer(bool $isSEPA, string $buyerIban): ZugferdQuickDescriptor @@ -163,11 +163,11 @@ public function doSetPaymentMeansForDebitTransfer(bool $isSEPA, string $buyerIba * If $isSEPA is true code __58__ wil be useed for payment means code. * If $isSEPA is false code __30__ wil be useed for payment means code. * - * @param boolean $isSEPA __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: - * @param string $payeeIban __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 - * @param string|null $payeeAccountName __BT-85, From BASIC WL__ The name of the payment account held with a payment service provider to which the payment should be made - * @param string|null $payeePropId __BT-BT-84-0, From BASIC WL__ National account number (not for SEPA) - * @param string|null $payeeBic __BT-86, From EN 16931__ An identifier for the payment service provider with which the payment account is held + * @param boolean $isSEPA __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: + * @param string $payeeIban __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 + * @param string|null $payeeAccountName __BT-85, From BASIC WL__ The name of the payment account held with a payment service provider to which the payment should be made + * @param string|null $payeePropId __BT-BT-84-0, From BASIC WL__ National account number (not for SEPA) + * @param string|null $payeeBic __BT-86, From EN 16931__ An identifier for the payment service provider with which the payment account is held * @return ZugferdQuickDescriptor */ public function doSetPaymentMeansForCreditTransfer(bool $isSEPA, string $payeeIban, ?string $payeeAccountName = null, ?string $payeePropId = null, ?string $payeeBic = null): ZugferdQuickDescriptor @@ -179,9 +179,9 @@ public function doSetPaymentMeansForCreditTransfer(bool $isSEPA, string $payeeIb /** * Set payment means to "Bank Card" * - * @param string $cardType __BT-, From __ The type of the card - * @param string $cardId __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 - * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder + * @param string $cardType __BT-, From __ The type of the card + * @param string $cardId __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 + * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder * @return ZugferdQuickDescriptor */ public function doSetPaymentMeansForBankCard(string $cardType, string $cardId, string $cardHolderName): ZugferdQuickDescriptor @@ -193,9 +193,9 @@ public function doSetPaymentMeansForBankCard(string $cardType, string $cardId, s /** * Set payment means to "Credit Card" * - * @param string $cardType __BT-, From __ The type of the card - * @param string $cardId __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 - * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder + * @param string $cardType __BT-, From __ The type of the card + * @param string $cardId __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 + * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder * @return ZugferdQuickDescriptor */ public function doSetPaymentMeansForCreditCard(string $cardType, string $cardId, string $cardHolderName): ZugferdQuickDescriptor @@ -207,9 +207,9 @@ public function doSetPaymentMeansForCreditCard(string $cardType, string $cardId, /** * Set payment means to "Debit Card" * - * @param string $cardType __BT-, From __ The type of the card - * @param string $cardId __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 - * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder + * @param string $cardType __BT-, From __ The type of the card + * @param string $cardId __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 + * @param string $cardHolderName __BT-88, From EN 16931__ Name of the payment card holder * @return ZugferdQuickDescriptor */ public function doSetPaymentMeansForDebitCard(string $cardType, string $cardId, string $cardHolderName): ZugferdQuickDescriptor @@ -235,8 +235,8 @@ public function doAddNote(string $note, ?string $subjectCode = null, ?string $co /** * Set details of the related buyer order * - * @param string $orderNo __BT-13, From MINIMUM__ An identifier issued by the buyer for a referenced order (order number) - * @param DateTime $orderDate __BT-X-147, From EXTENDED__ Date of order + * @param string $orderNo __BT-13, From MINIMUM__ An identifier issued by the buyer for a referenced order (order number) + * @param DateTime $orderDate __BT-X-147, From EXTENDED__ Date of order * @return ZugferdQuickDescriptor */ public function doSetBuyerOrderReferenceDocument(string $orderNo, DateTime $orderDate): ZugferdQuickDescriptor @@ -255,15 +255,16 @@ public function doSetBuyerOrderReferenceDocument(string $orderNo, DateTime $orde * to large attachments and / or sensitive information, e.g. for personal services, which must be separated * from the bill * - * @param string $issuerAssignedID __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. - * @param DateTime|null $issueDateTime __BT-X-149, From EXTENDED__ Document date - * @param string|null $typeCode __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. - * @param string|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. - * @param string|null $referenceTypeCode __BT-, From __ 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. - * @param string|null $filename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object + * @param string $issuerAssignedID __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. + * @param DateTime|null $issueDateTime __BT-X-149, From EXTENDED__ Document date + * @param string|null $typeCode __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. + * @param string|null $name __BT-123, From EN 16931__ A description of the document, e.g. Hourly billing, usage or consumption report, etc. + * @param string|null $referenceTypeCode __BT-, From __ 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. + * @param string|null $filename __BT-125, From EN 16931__ Contains a file name of an attachment document embedded as a binary object * @return ZugferdQuickDescriptor */ public function doAddAdditionalReferencedDocument(string $issuerAssignedID, ?DateTime $issueDateTime = null, ?string $typeCode = null, ?string $name = null, ?string $referenceTypeCode = null, ?string $filename = null): ZugferdQuickDescriptor @@ -275,8 +276,8 @@ public function doAddAdditionalReferencedDocument(string $issuerAssignedID, ?Dat /** * Set detailed information on the associated delivery note * - * @param string $deliveryNoteNo __BT-X-202, From EXTENDED__ Delivery slip number - * @param DateTime $deliveryNoteDate __BT-X-203, From EXTENDED__ Delivery slip date + * @param string $deliveryNoteNo __BT-X-202, From EXTENDED__ Delivery slip number + * @param DateTime $deliveryNoteDate __BT-X-203, From EXTENDED__ Delivery slip date * @return ZugferdQuickDescriptor */ public function doSetDeliveryNoteReferenceDocument(string $deliveryNoteNo, DateTime $deliveryNoteDate): ZugferdQuickDescriptor @@ -293,8 +294,8 @@ public function doSetDeliveryNoteReferenceDocument(string $deliveryNoteNo, DateT * - reference is made to previous partial invoices from a final invoice * - Reference is made to previous invoices for advance payments from a final invoice * - * @param string $id __BT-25, From BASIC WL__ The identification of an invoice previously sent by the seller - * @param DateTime|null $issueDateTime __BT-26, From BASIC WL__ Date of the previous invoice + * @param string $id __BT-25, From BASIC WL__ The identification of an invoice previously sent by the seller + * @param DateTime|null $issueDateTime __BT-26, From BASIC WL__ Date of the previous invoice * @return ZugferdQuickDescriptor */ public function doSetInvoiceReferencedDocument(string $id, ?DateTime $issueDateTime = null): ZugferdQuickDescriptor @@ -306,8 +307,8 @@ public function doSetInvoiceReferencedDocument(string $id, ?DateTime $issueDateT /** * Set Details of a project reference * - * @param string $id __BT-11, From EN 16931__ The identifier of the project to which the invoice relates - * @param string $name __BT-11-0, From EN 16931__ The name of the project to which the invoice relates + * @param string $id __BT-11, From EN 16931__ The identifier of the project to which the invoice relates + * @param string $name __BT-11-0, From EN 16931__ The name of the project to which the invoice relates * @return ZugferdQuickDescriptor */ public function doSetSpecifiedProcuringProject(string $id, string $name): ZugferdQuickDescriptor @@ -331,15 +332,16 @@ public function doSetSupplyChainEvent(?DateTime $date): ZugferdQuickDescriptor /** * Detailed information about the buyer (service recipient) * - * @param string $name __BT-44, From MINIMUM__ The full name of the buyer - * @param string $postcode __BT-53, From BASIC WL__ Identifier for a group of properties, such as a zip code - * @param string $city __BT-52, From BASIC WL__ Usual name of the city or municipality in which the buyers address is located - * @param string $street __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 - * @param string $country __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” - * @param string $buyerReference __BT-10, From MINIMUM__ An identifier assigned by the buyer and used for internal routing - * @param string $id __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 - * @param string|null $globalID __BT-46-0, From BASIC WL__ The buyers's identifier identification scheme is an identifier uniquely assigned to a buyer by a global registration organization. - * @param string|null $globalIDscheme __BT-46-1, From BASIC WL__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string $name __BT-44, From MINIMUM__ The full name of the buyer + * @param string $postcode __BT-53, From BASIC WL__ Identifier for a group of properties, such as a zip code + * @param string $city __BT-52, From BASIC WL__ Usual name of the city or municipality in which the buyers address is located + * @param string $street __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 + * @param string $country __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” + * @param string $buyerReference __BT-10, From MINIMUM__ An identifier assigned by the buyer and used for internal routing + * @param string $id __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 + * @param string|null $globalID __BT-46-0, From BASIC WL__ The buyers's identifier identification scheme is an identifier uniquely assigned to a buyer by a global registration organization. + * @param string|null $globalIDscheme __BT-46-1, From BASIC WL__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdQuickDescriptor */ 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 @@ -356,11 +358,11 @@ public function doSetBuyer(string $name, string $postcode, string $city, string /** * Set contact of the buyer party * - * @param string $name __BT-56, From EN 16931__ Contact point for a legal entity, such as a personal name of the contact person - * @param string|null $orgunit __BT-56-0, From EN 16931__ Contact point for a legal entity, such as a name of the department or office - * @param string|null $emailAddress __BT-58, From EN 16931__ An e-mail address of the contact point - * @param string|null $phoneno __BT-57, From EN 16931__ A telephone number for the contact point - * @param string|null $faxno __BT-X-115, From EXTENDED__ A fax number of the contact point + * @param string $name __BT-56, From EN 16931__ Contact point for a legal entity, such as a personal name of the contact person + * @param string|null $orgunit __BT-56-0, From EN 16931__ Contact point for a legal entity, such as a name of the department or office + * @param string|null $emailAddress __BT-58, From EN 16931__ An e-mail address of the contact point + * @param string|null $phoneno __BT-57, From EN 16931__ A telephone number for the contact point + * @param string|null $faxno __BT-X-115, From EXTENDED__ A fax number of the contact point * @return ZugferdQuickDescriptor */ public function doSetBuyerContact(string $name, ?string $orgunit = null, ?string $emailAddress = null, ?string $phoneno = null, ?string $faxno = null): ZugferdQuickDescriptor @@ -379,8 +381,8 @@ public function doSetBuyerContact(string $name, ?string $orgunit = null, ?string * buyers. Sales tax number with a prefixed country code. A supplier registered as subject to VAT must provide his sales tax * identification number, unless he uses a tax agent. * - * @param string $no __BT-48-0, From BASIC WL__ Type of tax number (FC = Tax number, VA = Sales tax identification number) - * @param string $schemeID __BT-48, From BASIC WL__ Tax number or sales tax identification number + * @param string $no __BT-48-0, From BASIC WL__ Type of tax number (FC = Tax number, VA = Sales tax identification number) + * @param string $schemeID __BT-48, From BASIC WL__ Tax number or sales tax identification number * @return ZugferdQuickDescriptor */ public function doAddBuyerTaxRegistration(string $no, string $schemeID): ZugferdQuickDescriptor @@ -392,8 +394,8 @@ public function doAddBuyerTaxRegistration(string $no, string $schemeID): Zugferd /** * Set Buyers electronic communication information * - * @param string $uri __BT-49, From BASIC WL__ Specifies the buyer's electronic address to which the invoice is sent - * @param string $uriScheme __BT-49-1, From BASIC WL__ The identifier for the identification scheme of the buyer's electronic address (Default: EM) + * @param string $uri __BT-49, From BASIC WL__ Specifies the buyer's electronic address to which the invoice is sent + * @param string $uriScheme __BT-49-1, From BASIC WL__ The identifier for the identification scheme of the buyer's electronic address (Default: EM) * @return ZugferdQuickDescriptor */ public function doSetBuyerElectronicCommunication(string $uri, string $uriScheme = "EM"): ZugferdQuickDescriptor @@ -405,14 +407,15 @@ public function doSetBuyerElectronicCommunication(string $uri, string $uriScheme /** * Detailed information about the seller (=service provider) * - * @param string $name __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) - * @param string $postcode __BT-38, From BASIC WL__ Identifier for a group of properties, such as a zip code - * @param string $city __BT-37, From BASIC WL__ Usual name of the city or municipality in which the seller's address is located - * @param string $street __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 - * @param string $country __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” - * @param string|null $id __BT-29, From BASIC WL__ An identifier 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 - * @param string|null $globalID __BT-29/BT-29-0, From BASIC WL__ The seller's identifier identification scheme is an identifier uniquely assigned to a seller by a global registration organization. - * @param string|null $globalIDscheme __BT-29-1, From BASIC WL__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. + * @param string $name __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) + * @param string $postcode __BT-38, From BASIC WL__ Identifier for a group of properties, such as a zip code + * @param string $city __BT-37, From BASIC WL__ Usual name of the city or municipality in which the seller's address is located + * @param string $street __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 + * @param string $country __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” + * @param string|null $id __BT-29, From BASIC WL__ An identifier 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 + * @param string|null $globalID __BT-29/BT-29-0, From BASIC WL__ The seller's identifier identification scheme is an identifier uniquely assigned to a seller by a global registration organization. + * @param string|null $globalIDscheme __BT-29-1, From BASIC WL__ If the identifier is used for the identification scheme, it must be selected from the entries in the list published by the ISO / IEC 6523 Maintenance Agency. * @return ZugferdQuickDescriptor */ public function doSetSeller(string $name, string $postcode, string $city, string $street, string $country, ?string $id = null, ?string $globalID = null, ?string $globalIDscheme = null): ZugferdQuickDescriptor @@ -426,11 +429,11 @@ public function doSetSeller(string $name, string $postcode, string $city, string /** * Set contact of the seller party * - * @param string $name __BT-41, From EN 16931__ Such as personal name, name of contact person or department or office - * @param string|null $orgunit __BT-41-0, From EN 16931__ If a contact person is specified, either the name or the department must be transmitted. - * @param string|null $emailAddress __BT-43, From EN 16931__ An e-mail address of the contact point - * @param string|null $phoneno __BT-42, From EN 16931__ A telephone number for the contact point - * @param string|null $faxno __BT-X-107, From EXTENDED__ A fax number of the contact point + * @param string $name __BT-41, From EN 16931__ Such as personal name, name of contact person or department or office + * @param string|null $orgunit __BT-41-0, From EN 16931__ If a contact person is specified, either the name or the department must be transmitted. + * @param string|null $emailAddress __BT-43, From EN 16931__ An e-mail address of the contact point + * @param string|null $phoneno __BT-42, From EN 16931__ A telephone number for the contact point + * @param string|null $faxno __BT-X-107, From EXTENDED__ A fax number of the contact point * @return ZugferdQuickDescriptor */ public function doSetSellerContact(string $name, ?string $orgunit = null, ?string $emailAddress = null, ?string $phoneno = null, ?string $faxno = null): ZugferdQuickDescriptor @@ -449,8 +452,8 @@ public function doSetSellerContact(string $name, ?string $orgunit = null, ?strin * seller. Sales tax number with a prefixed country code. A supplier registered as subject to VAT must provide his sales tax * identification number, unless he uses a tax agent. * - * @param string $no __BT-31/32, From MINIMUM/EN 16931__ Tax number of the seller or sales tax identification number of the seller - * @param string $schemeID __BT-31-0/BT-32-0, From MINIMUM/EN 16931__ Type of tax number of the seller (FC = Tax number, VA = Sales tax identification number) + * @param string $no __BT-31/32, From MINIMUM/EN 16931__ Tax number of the seller or sales tax identification number of the seller + * @param string $schemeID __BT-31-0/BT-32-0, From MINIMUM/EN 16931__ Type of tax number of the seller (FC = Tax number, VA = Sales tax identification number) * @return ZugferdQuickDescriptor */ public function doAddSellerTaxRegistration(string $no, string $schemeID): ZugferdQuickDescriptor @@ -462,8 +465,8 @@ public function doAddSellerTaxRegistration(string $no, string $schemeID): Zugfer /** * Set Sellers electronic communication information * - * @param string $uri __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 - * @param string $uriScheme __BT-34-1, From BASIC WL__ The identifier for the identification scheme of the seller's electronic address (Default: EM) + * @param string $uri __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 + * @param string $uriScheme __BT-34-1, From BASIC WL__ The identifier for the identification scheme of the seller's electronic address (Default: EM) * @return ZugferdQuickDescriptor */ public function doSetSellerElectronicCommunication(string $uri, string $uriScheme = "EM"): ZugferdQuickDescriptor @@ -475,9 +478,9 @@ public function doSetSellerElectronicCommunication(string $uri, string $uriSchem /** * Add a new text position * - * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item - * @param string $comment __BT-127, From BASIC__ A free text that contains unstructured information that is relevant to the invoice item - * @return ZugferdQuickDescriptor + * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item + * @param string $comment __BT-127, From BASIC__ A free text that contains unstructured information that is relevant to the invoice item + * @return ZugferdQuickDescriptor * @deprecated 1.0.75 */ public function doAddTradeLineCommentItem(string $lineId, string $comment): ZugferdQuickDescriptor @@ -490,16 +493,17 @@ public function doAddTradeLineCommentItem(string $lineId, string $comment): Zugf /** * Adds a new position (line) to document * - * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item - * @param string $productName __BT-153, From BASIC__ A name of the item (item name) - * @param float $unitPrice __BT-146, From BASIC__ Net price of the item - * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line - * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed - * @param float $allowanceChargeAmount __BT-136/BT-141, From BASIC__ The surcharge/discount amount excluding sales tax - * @param string $allowanceChargeReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount/surcharge - * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category - * @param string $taxTypeCode __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. - * @param float $taxPercent __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) + * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item + * @param string $productName __BT-153, From BASIC__ A name of the item (item name) + * @param float $unitPrice __BT-146, From BASIC__ Net price of the item + * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line + * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed + * @param float $allowanceChargeAmount __BT-136/BT-141, From BASIC__ The surcharge/discount amount excluding sales tax + * @param string $allowanceChargeReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount/surcharge + * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category + * @param string $taxTypeCode __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. + * @param float $taxPercent __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) * @return ZugferdQuickDescriptor */ public function doAddTradeLineItem(string $lineId, string $productName, float $unitPrice, float $quantity, string $unitCode, float $allowanceChargeAmount, string $allowanceChargeReason, string $taxCategoryCode, string $taxTypeCode, float $taxPercent): ZugferdQuickDescriptor @@ -538,7 +542,7 @@ public function doAddTradeLineItem(string $lineId, string $productName, float $u /** * Add detailed information on the free text on the position * - * @param string $content __BT-127, From BASIC__ A free text that contains unstructured information that is relevant to the invoice item + * @param string $content __BT-127, From BASIC__ A free text that contains unstructured information that is relevant to the invoice item * @return ZugferdQuickDescriptor */ public function doSetDocumentPositionNote(string $content): ZugferdQuickDescriptor @@ -551,16 +555,17 @@ public function doSetDocumentPositionNote(string $content): ZugferdQuickDescript /** * Adds a new position (line) to document with a surcharge amount * - * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item - * @param string $productName __BT-153, From BASIC__ A name of the item (item name) - * @param float $unitPrice __BT-146, From BASIC__ Net price of the item - * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line - * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed - * @param float $chargeAmount __BT-136/BT-141, From BASIC__ The surcharge amount excluding sales tax - * @param string $chargeReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item surcharge - * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category - * @param string $taxTypeCode __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. - * @param float $taxPercent __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) + * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item + * @param string $productName __BT-153, From BASIC__ A name of the item (item name) + * @param float $unitPrice __BT-146, From BASIC__ Net price of the item + * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line + * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed + * @param float $chargeAmount __BT-136/BT-141, From BASIC__ The surcharge amount excluding sales tax + * @param string $chargeReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item surcharge + * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category + * @param string $taxTypeCode __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. + * @param float $taxPercent __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) * @return ZugferdQuickDescriptor */ public function doAddTradeLineItemWithSurcharge(string $lineId, string $productName, float $unitPrice, float $chargeAmount, string $chargeReason, float $quantity, string $unitCode, string $taxCategoryCode, string $taxTypeCode, float $taxPercent): ZugferdQuickDescriptor @@ -572,16 +577,17 @@ public function doAddTradeLineItemWithSurcharge(string $lineId, string $productN /** * Adds a new position (line) to document with a discount amount * - * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item - * @param string $productName __BT-153, From BASIC__ A name of the item (item name) - * @param float $unitPrice __BT-146, From BASIC__ Net price of the item - * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line - * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed - * @param float $discountAmount __BT-136/BT-141, From BASIC__ The discount amount excluding sales tax - * @param string $discountReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount - * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category - * @param string $taxTypeCode __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. - * @param float $taxPercent __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) + * @param string $lineId __BT-126, From BASIC__ Identification of the invoice item + * @param string $productName __BT-153, From BASIC__ A name of the item (item name) + * @param float $unitPrice __BT-146, From BASIC__ Net price of the item + * @param float $quantity __BT-129, From BASIC__ The quantity of individual items (goods or services) billed in the relevant line + * @param string $unitCode __BT-130, From BASIC__ The unit of measure applicable to the amount billed + * @param float $discountAmount __BT-136/BT-141, From BASIC__ The discount amount excluding sales tax + * @param string $discountReason __BT-139/BT-144, From BASIC__ The reason given in text form for the invoice item discount + * @param string $taxCategoryCode __BT-151, From BASIC__ Coded description of a sales tax category + * @param string $taxTypeCode __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. + * @param float $taxPercent __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) * @return ZugferdQuickDescriptor */ public function doAddTradeLineItemWithDiscount(string $lineId, string $productName, float $unitPrice, float $discountAmount, string $discountReason, float $quantity, string $unitCode, string $taxCategoryCode, string $taxTypeCode, float $taxPercent): ZugferdQuickDescriptor @@ -593,11 +599,11 @@ public function doAddTradeLineItemWithDiscount(string $lineId, string $productNa /** * Add a logistical service fees (On document level) * - * @param float $amount __BT-X-272, From EXTENDED__ Amount of the service fee - * @param string $description __BT-X-271, From EXTENDED__ Identification of the service fee - * @param string $taxTypeCode __BT-X-273-0, From EXTENDED__ Code of the Tax type. Note: Fixed value = "VAT" - * @param string $taxCategoryCode __BT-X-273, From EXTENDED__ Code of the VAT category - * @param float $taxPercent __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) + * @param float $amount __BT-X-272, From EXTENDED__ Amount of the service fee + * @param string $description __BT-X-271, From EXTENDED__ Identification of the service fee + * @param string $taxTypeCode __BT-X-273-0, From EXTENDED__ Code of the Tax type. Note: Fixed value = "VAT" + * @param string $taxCategoryCode __BT-X-273, From EXTENDED__ Code of the VAT category + * @param float $taxPercent __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) * @return ZugferdQuickDescriptor */ public function doAddLogisticsServiceCharge(float $amount, string $description, string $taxTypeCode, string $taxCategoryCode, float $taxPercent): ZugferdQuickDescriptor @@ -621,11 +627,11 @@ public function doAddLogisticsServiceCharge(float $amount, string $description, * Add 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 * - * @param float $actualAmount __BT-92/BT-99, From BASIC WL__ Amount of the surcharge or discount at document level - * @param string $reason __BT-97/BT-104, From BASIC WL__ The reason given in text form for the surcharge or discount at document level - * @param string $taxCategoryCode __BT-95/BT-102, From BASIC WL__ A coded indication of which sales tax category applies to the surcharge or deduction at document level - * @param string $taxTypeCode __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" - * @param float $taxPercent __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) + * @param float $actualAmount __BT-92/BT-99, From BASIC WL__ Amount of the surcharge or discount at document level + * @param string $reason __BT-97/BT-104, From BASIC WL__ The reason given in text form for the surcharge or discount at document level + * @param string $taxCategoryCode __BT-95/BT-102, From BASIC WL__ A coded indication of which sales tax category applies to the surcharge or deduction at document level + * @param string $taxTypeCode __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" + * @param float $taxPercent __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) * @return ZugferdQuickDescriptor */ public function doAddTradeAllowanceCharge(float $actualAmount, string $reason, string $taxCategoryCode, string $taxTypeCode, float $taxPercent): ZugferdQuickDescriptor @@ -656,13 +662,13 @@ public function doAddTradeAllowanceCharge(float $actualAmount, string $reason, s /** * Add a VAT breakdown (at document level) * - * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. - * @param float $percent __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) - * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category - * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" - * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level - * @param string|null $exemptionReasonCode __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. - * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) + * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. + * @param float $percent __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) + * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category + * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" + * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level + * @param string|null $exemptionReasonCode __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. + * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) * @return ZugferdQuickDescriptor */ public function doAddApplicableTradeTax(float $basisAmount, float $percent, string $categoryCode, ?string $typeCode = null, ?float $allowanceChargeBasisAmount = null, ?string $exemptionReasonCode = null, ?string $exemptionReason = null): ZugferdQuickDescriptor @@ -674,13 +680,13 @@ public function doAddApplicableTradeTax(float $basisAmount, float $percent, stri /** * Add a VAT breakdown (at document level) * - * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. - * @param float $calculatedAmount __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 - * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category - * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" - * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level - * @param string|null $exemptionReasonCode __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. - * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) + * @param float $basisAmount __BT-116, From BASIC WL__ Tax base amount, Each sales tax breakdown must show a category-specific tax base amount. + * @param float $calculatedAmount __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 + * @param string $categoryCode __BT-118, From BASIC WL__ Coded description of a sales tax category + * @param string|null $typeCode __BT-118-0, From BASIC WL__ Coded description of a sales tax category. Note: Fixed value = "VAT" + * @param float|null $allowanceChargeBasisAmount __BT-X-263, From EXTENDED__ Total amount Additions and deductions to the tax rate at document level + * @param string|null $exemptionReasonCode __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. + * @param string|null $exemptionReason __BT-120, From BASIC WL__ Reason for tax exemption (free text) * @return ZugferdQuickDescriptor */ public function doAddApplicableTradeTax2(float $basisAmount, float $calculatedAmount, string $categoryCode, ?string $typeCode = null, ?float $allowanceChargeBasisAmount = null, ?string $exemptionReasonCode = null, ?string $exemptionReason = null): ZugferdQuickDescriptor diff --git a/tests/testcases/PdfBuilderEn16931Test.php b/tests/testcases/PdfBuilderEn16931Test.php index 384616f5..fe37d1f9 100644 --- a/tests/testcases/PdfBuilderEn16931Test.php +++ b/tests/testcases/PdfBuilderEn16931Test.php @@ -89,7 +89,6 @@ public static function tearDownAfterClass(): void /** * Tests */ - public function testBuildFromSourcePdfFileWhichDoesNotExist(): void { $this->expectException(ZugferdFileNotFoundException::class); @@ -789,22 +788,24 @@ public function testCustomMetaInformation(): void $whichArray = []; $pdfBuilder = new ZugferdDocumentPdfBuilder(self::$document, self::$sourcePdfFilename); - $pdfBuilder->setMetaInformationCallback(function ($which) use (&$whichArray) { - $whichArray[] = $which; - - $this->assertIsString($which); - $this->assertTrue(in_array($which, ['author', 'keywords', 'title', 'subject'])); - - if ($which === 'title') { - return "DummyTitle"; - } - if ($which === 'author') { - return "DummyAuthor"; + $pdfBuilder->setMetaInformationCallback( + function ($which) use (&$whichArray) { + $whichArray[] = $which; + + $this->assertIsString($which); + $this->assertTrue(in_array($which, ['author', 'keywords', 'title', 'subject'])); + + if ($which === 'title') { + return "DummyTitle"; + } + if ($which === 'author') { + return "DummyAuthor"; + } + if ($which === 'subject') { + return "DummySubject"; + } } - if ($which === 'subject') { - return "DummySubject"; - } - }); + ); $pdfBuilder->generateDocument(); $pdfBuilder->saveDocument(self::$destPdfFilename); @@ -859,17 +860,19 @@ public function testCustomMetaInformation(): void $this->assertStringContainsString(date("Y-m-d"), $pdfDetails["xmp:modifydate"]); $pdfBuilder = new ZugferdDocumentPdfBuilder(self::$document, self::$sourcePdfFilename); - $pdfBuilder->setMetaInformationCallback(function ($which) { - if ($which === 'title') { - return ""; - } - if ($which === 'author') { - return ""; - } - if ($which === 'subject') { - return ""; + $pdfBuilder->setMetaInformationCallback( + function ($which) { + if ($which === 'title') { + return ""; + } + if ($which === 'author') { + return ""; + } + if ($which === 'subject') { + return ""; + } } - }); + ); $pdfBuilder->setTitleTemplate('%3$s : %2$s %1$s'); $pdfBuilder->setKeywordTemplate('%1$s, %2$s, %3$s, %4$s'); $pdfBuilder->setAuthorTemplate('Issued by seller with name %3$s');