diff --git a/doc/doc-index.html b/doc/doc-index.html index 54f47505..7a8154c3 100644 --- a/doc/doc-index.html +++ b/doc/doc-index.html @@ -136,7 +136,9 @@

A

Adds a new position (line) to document
ZugferdDocumentBuilder::addNewTextPosition() — Method in class ZugferdDocumentBuilder
Adds a new text-only position (line) to document
ZugferdDocumentBuilder::addDocumentPositionProductCharacteristic() — Method in class ZugferdDocumentBuilder
Add extra characteristics to the formerly added product.
ZugferdDocumentBuilder::addDocumentPositionProductClassification() — Method in class ZugferdDocumentBuilder
-
Add detailed information on product classification
ZugferdDocumentBuilder::addDocumentPositionAdditionalReferencedDocument() — Method in class ZugferdDocumentBuilder
+
Add detailed information on product classification
ZugferdDocumentBuilder::addDocumentPositionReferencedProduct() — Method in class ZugferdDocumentBuilder
+
Add detailed information on included products. This information relates to the +product that has just been added
ZugferdDocumentBuilder::addDocumentPositionAdditionalReferencedDocument() — Method in class ZugferdDocumentBuilder
Add an additional Document reference on a position
ZugferdDocumentBuilder::addDocumentPositionUltimateCustomerOrderReferencedDocument() — Method in class ZugferdDocumentBuilder
Add a referennce to a ultimate customer order referenced document
ZugferdDocumentBuilder::addDocumentPositionGrossPriceAllowanceCharge() — Method in class ZugferdDocumentBuilder
Detailed information on surcharges and discounts on item gross price
ZugferdDocumentBuilder::addDocumentPositionShipToGlobalId() — Method in class ZugferdDocumentBuilder
@@ -409,7 +411,8 @@

A

Get instance of SupplyChainTradeLineItemType
ZugferdObjectHelper::getTradeProductType() — Method in class ZugferdObjectHelper
Get product specification
ZugferdObjectHelper::getProductCharacteristicType() — Method in class ZugferdObjectHelper
Get Product Characteristic
ZugferdObjectHelper::getProductClassificationType() — Method in class ZugferdObjectHelper
-
Get Product Classification
ZugferdObjectHelper::getTradePriceType() — Method in class ZugferdObjectHelper
+
Get Product Classification
ZugferdObjectHelper::getReferencedProductType() — Method in class ZugferdObjectHelper
+
Get product reference product
ZugferdObjectHelper::getTradePriceType() — Method in class ZugferdObjectHelper
Get trade price
ZugferdObjectHelper::getTradeSettlementLineMonetarySummationType() — Method in class ZugferdObjectHelper
Get Line Summation
ZugferdObjectHelper::getTaxApplicableTradeCurrencyExchangeType() — Method in class ZugferdObjectHelper
Undocumented function
ZugferdObjectHelper::getRateType() — Method in class ZugferdObjectHelper
diff --git a/doc/horstoeko/zugferd/ZugferdDocumentBuilder.html b/doc/horstoeko/zugferd/ZugferdDocumentBuilder.html index bfa071ae..f171c3dd 100644 --- a/doc/horstoeko/zugferd/ZugferdDocumentBuilder.html +++ b/doc/horstoeko/zugferd/ZugferdDocumentBuilder.html @@ -1180,6 +1180,17 @@

Methods

Sets the detailed information on the product origin

+ +
+
+ ZugferdDocumentBuilder +
+
+ addDocumentPositionReferencedProduct(string $name, string|null $description = null, string|null $sellerAssignedID = null, string|null $buyerAssignedID = null, string|null $globalID = null, string|null $globalIDType = null, float|null $unitQuantity = null, string|null $unitCode = null) + +

Add detailed information on included products. This information relates to the +product that has just been added

+
@@ -7255,13 +7266,99 @@

Return Value

+
+
+ + +
+

+
at line 2612
+ ZugferdDocumentBuilder + addDocumentPositionReferencedProduct(string $name, string|null $description = null, string|null $sellerAssignedID = null, string|null $buyerAssignedID = null, string|null $globalID = null, string|null $globalIDType = null, float|null $unitQuantity = null, string|null $unitCode = null) + +

+
+ + + +
+

Add detailed information on included products. This information relates to the +product that has just been added

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
string$nameItem name
string|null$descriptionItem description
string|null$sellerAssignedIDItem number of the seller
string|null$buyerAssignedIDItem number of the buyer +Note: The identifier of the product is a unique, bilaterally agreed identification of the +product. It can, for example, be the customer article number or the article number assigned by +the manufacturer.
string|null$globalIDGlobal identifier of the product +Note: The global identifier of the product is a label uniquely assigned by the manufacturer, +which is based on the rules of a global registration organization.
string|null$globalIDTypeType of global item number +In particular, the following codes can be used: + * 0021: SWIFT + * 0088: EAN + * 0060: DUNS + * 0177: ODETTE
float|null$unitQuantityIncluded quantity
string|null$unitCodeUnit of measurement of the included quantity
+ + +

Return Value

+ + + + + + +
ZugferdDocumentBuilder
+ + +

-
at line 2592
+
at line 2632
ZugferdDocumentBuilder setDocumentPositionBuyerOrderReferencedDocument(string $issuerassignedid, string $lineid, DateTime|null $issueddate = null) @@ -7312,7 +7409,7 @@

Return Value

-
at line 2612
+
at line 2652
ZugferdDocumentBuilder setDocumentPositionContractReferencedDocument(string $issuerassignedid, string $lineid, DateTime|null $issueddate = null) @@ -7363,7 +7460,7 @@

Return Value

-
at line 2660
+
at line 2700
ZugferdDocumentBuilder addDocumentPositionAdditionalReferencedDocument(string $issuerassignedid, string $typecode, string|null $uriid = null, string|null $lineid = null, string|null $name = null, string|null $reftypecode = null, DateTime|null $issueddate = null, string|null $binarydatafilename = null) @@ -7455,7 +7552,7 @@

Return Value

-
at line 2676
+
at line 2716
ZugferdDocumentBuilder addDocumentPositionUltimateCustomerOrderReferencedDocument(string $issuerassignedid, string $lineid, DateTime|null $issueddate = null) @@ -7505,7 +7602,7 @@

Return Value

-
at line 2697
+
at line 2737
ZugferdDocumentBuilder setDocumentPositionGrossPrice(float $amount, float|null $basisQuantity = null, string|null $basisQuantityUnitCode = null) @@ -7557,7 +7654,7 @@

Return Value

-
at line 2729
+
at line 2769
ZugferdDocumentBuilder addDocumentPositionGrossPriceAllowanceCharge(float $actualAmount, bool|null $isCharge = null, float|null $calculationPercent = null, float|null $basisAmount = null, string|null $reason = null, string|null $taxTypeCode = null, string|null $taxCategoryCode = null, float|null $rateApplicablePercent = null, float|null $sequence = null, float|null $basisQuantity = null, string|null $basisQuantityUnitCode = null, string|null $reasonCode = null) @@ -7654,7 +7751,7 @@

Return Value

-
at line 2749
+
at line 2789
ZugferdDocumentBuilder setDocumentPositionNetPrice(float $amount, float|null $basisQuantity = null, string|null $basisQuantityUnitCode = null) @@ -7704,7 +7801,7 @@

Return Value

-
at line 2802
+
at line 2842
ZugferdDocumentBuilder setDocumentPositionNetPriceTax(string $categoryCode, string $typeCode, float $rateApplicablePercent, float|null $calculatedAmount = null, string|null $exemptionReason = null, string|null $exemptionReasonCode = null) @@ -7797,7 +7894,7 @@

Return Value

-
at line 2835
+
at line 2875
ZugferdDocumentBuilder setDocumentPositionQuantity(float $billedQuantity, string $billedQuantityUnitCode, float|null $chargeFreeQuantity = null, string|null $chargeFreeQuantityUnitCpde = null, float|null $packageQuantity = null, string|null $packageQuantityUnitCode = null) @@ -7869,7 +7966,7 @@

Return Value

-
at line 2859
+
at line 2899
ZugferdDocumentBuilder setDocumentPositionShipTo(string $name, string|null $id = null, string|null $description = null) @@ -7923,7 +8020,7 @@

Return Value

-
at line 2877
+
at line 2917
ZugferdDocumentBuilder addDocumentPositionShipToGlobalId(string|null $globalID = null, string|null $globalIDType = null) @@ -7969,7 +8066,7 @@

Return Value

-
at line 2901
+
at line 2941
ZugferdDocumentBuilder addDocumentPositionShipToTaxRegistration(string|null $taxregtype = null, string|null $taxregid = null) @@ -8019,7 +8116,7 @@

Return Value

-
at line 2934
+
at line 2974
ZugferdDocumentBuilder setDocumentPositionShipToAddress(string|null $lineone = null, string|null $linetwo = null, string|null $linethree = null, string|null $postcode = null, string|null $city = null, string|null $country = null, string|null $subdivision = null) @@ -8094,7 +8191,7 @@

Return Value

-
at line 2957
+
at line 2997
ZugferdDocumentBuilder setDocumentPositionShipToLegalOrganisation(string|null $legalorgid, string|null $legalorgtype, string|null $legalorgname) @@ -8148,7 +8245,7 @@

Return Value

-
at line 2981
+
at line 3021
ZugferdDocumentBuilder setDocumentPositionShipToContact(string|null $contactpersonname, string|null $contactdepartmentname, string|null $contactphoneno, string|null $contactfaxno, string|null $contactemailadd) @@ -8208,7 +8305,7 @@

Return Value

-
at line 3004
+
at line 3044
ZugferdDocumentBuilder setDocumentPositionUltimateShipTo(string $name, string|null $id = null, string|null $description = null) @@ -8261,7 +8358,7 @@

Return Value

-
at line 3022
+
at line 3062
ZugferdDocumentBuilder addDocumentPositionUltimateShipToGlobalId(string|null $globalID = null, string|null $globalIDType = null) @@ -8307,7 +8404,7 @@

Return Value

-
at line 3039
+
at line 3079
ZugferdDocumentBuilder addDocumentPositionUltimateShipToTaxRegistration(string|null $taxregtype = null, string|null $taxregid = null) @@ -8352,7 +8449,7 @@

Return Value

-
at line 3072
+
at line 3112
ZugferdDocumentBuilder setDocumentPositionUltimateShipToAddress(string|null $lineone = null, string|null $linetwo = null, string|null $linethree = null, string|null $postcode = null, string|null $city = null, string|null $country = null, string|null $subdivision = null) @@ -8427,7 +8524,7 @@

Return Value

-
at line 3095
+
at line 3135
ZugferdDocumentBuilder setDocumentPositionUltimateShipToLegalOrganisation(string|null $legalorgid, string|null $legalorgtype, string|null $legalorgname) @@ -8482,7 +8579,7 @@

Return Value

-
at line 3119
+
at line 3159
ZugferdDocumentBuilder setDocumentPositionUltimateShipToContact(string|null $contactpersonname, string|null $contactdepartmentname, string|null $contactphoneno, string|null $contactfaxno, string|null $contactemailadd) @@ -8542,7 +8639,7 @@

Return Value

-
at line 3134
+
at line 3174
ZugferdDocumentBuilder setDocumentPositionSupplyChainEvent(DateTime|null $date) @@ -8582,7 +8679,7 @@

Return Value

-
at line 3150
+
at line 3190
ZugferdDocumentBuilder setDocumentPositionDespatchAdviceReferencedDocument(string $issuerassignedid, string|null $lineid = null, DateTime|null $issueddate = null) @@ -8632,7 +8729,7 @@

Return Value

-
at line 3166
+
at line 3206
ZugferdDocumentBuilder setDocumentPositionReceivingAdviceReferencedDocument(string $issuerassignedid, string|null $lineid = null, DateTime|null $issueddate = null) @@ -8682,7 +8779,7 @@

Return Value

-
at line 3182
+
at line 3222
ZugferdDocumentBuilder setDocumentPositionDeliveryNoteReferencedDocument(string $issuerassignedid, string|null $lineid = null, DateTime|null $issueddate = null) @@ -8732,7 +8829,7 @@

Return Value

-
at line 3235
+
at line 3275
ZugferdDocumentBuilder addDocumentPositionTax(string $categoryCode, string $typeCode, float $rateApplicablePercent, float|null $calculatedAmount = null, string|null $exemptionReason = null, string|null $exemptionReasonCode = null) @@ -8825,7 +8922,7 @@

Return Value

-
at line 3253
+
at line 3293
ZugferdDocumentBuilder setDocumentPositionBillingPeriod(DateTime|null $startdate, DateTime|null $endDate) @@ -8870,7 +8967,7 @@

Return Value

-
at line 3328
+
at line 3368
ZugferdDocumentBuilder addDocumentPositionAllowanceCharge(float $actualAmount, bool $isCharge, float|null $calculationPercent = null, float|null $basisAmount = null, string|null $reasonCode = null, string|null $reason = null) @@ -8985,7 +9082,7 @@

Return Value

-
at line 3347
+
at line 3387
ZugferdDocumentBuilder setDocumentPositionLineSummation(float $lineTotalAmount, float|null $totalAllowanceChargeAmount = null) @@ -9032,7 +9129,7 @@

Return Value

-
at line 3363
+
at line 3403
ZugferdDocumentBuilder addDocumentPositionReceivableSpecifiedTradeAccountingAccount(string $id, string|null $typeCode) diff --git a/doc/horstoeko/zugferd/ZugferdObjectHelper.html b/doc/horstoeko/zugferd/ZugferdObjectHelper.html index a5a43798..9d2969de 100644 --- a/doc/horstoeko/zugferd/ZugferdObjectHelper.html +++ b/doc/horstoeko/zugferd/ZugferdObjectHelper.html @@ -627,6 +627,16 @@

Methods

Get Product Classification

+ +
+
+ object|null +
+
+ getReferencedProductType(string|null $globalID, string|null $globalIDType, string|null $sellerAssignedID, string|null $buyerAssignedID, string|null $name, string|null $description = null, float|null $unitQuantity, string|null $unitCode) + +

Get product reference product

+
@@ -3300,13 +3310,88 @@

Return Value

+
+
+ + +
+

+
at line 1244
+ object|null + getReferencedProductType(string|null $globalID, string|null $globalIDType, string|null $sellerAssignedID, string|null $buyerAssignedID, string|null $name, string|null $description = null, float|null $unitQuantity, string|null $unitCode) + +

+
+ + + +
+

Get product reference product

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
string|null$globalID
string|null$globalIDType
string|null$sellerAssignedID
string|null$buyerAssignedID
string|null$name
string|null$description
float|null$unitQuantity
string|null$unitCode
+ + +

Return Value

+ + + + + + +
object|null
+ + +

-
at line 1239
+
at line 1270
object|null getTradePriceType(float|null $amount = null, float|null $basisQuantity = null, string|null $basisQuantityUnitCode = null) @@ -3356,7 +3441,7 @@

Return Value

-
at line 1260
+
at line 1291
object|null getTradeSettlementLineMonetarySummationType(float|null $lineTotalAmount = null, float|null $totalAllowanceChargeAmount = null) @@ -3401,7 +3486,7 @@

Return Value

-
at line 1283
+
at line 1314
object|null getTaxApplicableTradeCurrencyExchangeType(string|null $sourceCurrencyCode = null, string|null $targetCurrencyCode = null, float|null $rate = null, DateTime|null $rateDateTime = null) @@ -3456,7 +3541,7 @@

Return Value

-
at line 1306
+
at line 1337
DateTime|null toDateTime(string|null $dateTimeString, string|null $format) @@ -3510,7 +3595,7 @@

Exceptions

-
at line 1334
+
at line 1365
object|null getRateType(float|null $rateValue) @@ -3550,7 +3635,7 @@

Return Value

-
at line 1348
+
at line 1379
object|null createClassInstance($classname, mixed $constructorvalue = null) @@ -3595,7 +3680,7 @@

Return Value

-
at line 1368
+
at line 1399
ZugferdObjectHelper tryCall(object $instance, string $method, mixed $value) @@ -3645,7 +3730,7 @@

Return Value

-
at line 1394
+
at line 1425
ZugferdObjectHelper tryCallAll(object $instance, array $methods, mixed $value) @@ -3695,7 +3780,7 @@

Return Value

-
at line 1420
+
at line 1451
mixed tryCallAndReturn(object $instance, string $method) @@ -3741,7 +3826,7 @@

Return Value

-
at line 1443
+
at line 1474
void tryCallByPath(object $instance, string $methods, $value) @@ -3791,7 +3876,7 @@

Return Value

-
at line 1464
+
at line 1495
mixed tryCallByPathAndReturn(object $instance, string $methods) @@ -3836,7 +3921,7 @@

Return Value

-
at line 1484
+
at line 1515
array ensureStringArray(mixed $input) @@ -3876,7 +3961,7 @@

Return Value

-
at line 1500
+
at line 1531
array ensureArray(mixed $value) @@ -3916,7 +4001,7 @@

Return Value

-
at line 1518
+
at line 1549
static boolean isNullOrEmpty(mixed $value) @@ -3956,7 +4041,7 @@

Return Value

-
at line 1538
+
at line 1569
static bool isAllNullOrEmpty(array $args) @@ -3996,7 +4081,7 @@

Return Value

-
at line 1559
+
at line 1590
static bool isOneNullOrEmpty(array $args) diff --git a/doc/sami.js b/doc/sami.js index 3f43fb03..0d83cc68 100644 --- a/doc/sami.js +++ b/doc/sami.js @@ -128,6 +128,7 @@ window.projectVersion = 'master'; {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_addDocumentPositionProductCharacteristic", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::addDocumentPositionProductCharacteristic", "doc": ""Add extra characteristics to the formerly added product.""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_addDocumentPositionProductClassification", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::addDocumentPositionProductClassification", "doc": ""Add detailed information on product classification""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_setDocumentPositionProductOriginTradeCountry", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::setDocumentPositionProductOriginTradeCountry", "doc": ""Sets the detailed information on the product origin""}, + {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_addDocumentPositionReferencedProduct", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::addDocumentPositionReferencedProduct", "doc": ""Add detailed information on included products. This information relates to the\nproduct that has just been added""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_setDocumentPositionBuyerOrderReferencedDocument", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::setDocumentPositionBuyerOrderReferencedDocument", "doc": ""Set details of the related buyer order position""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_setDocumentPositionContractReferencedDocument", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::setDocumentPositionContractReferencedDocument", "doc": ""Set details of the related contract position""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdDocumentBuilder", "fromLink": "horstoeko/zugferd/ZugferdDocumentBuilder.html", "link": "horstoeko/zugferd/ZugferdDocumentBuilder.html#method_addDocumentPositionAdditionalReferencedDocument", "name": "horstoeko\\zugferd\\ZugferdDocumentBuilder::addDocumentPositionAdditionalReferencedDocument", "doc": ""Add an additional Document reference on a position""}, @@ -373,6 +374,7 @@ window.projectVersion = 'master'; {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getTradeProductType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getTradeProductType", "doc": ""Get product specification""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getProductCharacteristicType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getProductCharacteristicType", "doc": ""Get Product Characteristic""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getProductClassificationType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getProductClassificationType", "doc": ""Get Product Classification""}, + {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getReferencedProductType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getReferencedProductType", "doc": ""Get product reference product""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getTradePriceType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getTradePriceType", "doc": ""Get trade price""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getTradeSettlementLineMonetarySummationType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getTradeSettlementLineMonetarySummationType", "doc": ""Get Line Summation""}, {"type": "Method", "fromName": "horstoeko\\zugferd\\ZugferdObjectHelper", "fromLink": "horstoeko/zugferd/ZugferdObjectHelper.html", "link": "horstoeko/zugferd/ZugferdObjectHelper.html#method_getTaxApplicableTradeCurrencyExchangeType", "name": "horstoeko\\zugferd\\ZugferdObjectHelper::getTaxApplicableTradeCurrencyExchangeType", "doc": ""Undocumented function""},