Class InvoiceLine

java.lang.Object
com.fourjs.report.facturx.profiles.extended.InvoiceLine

public class InvoiceLine extends Object
BG-25 INVOICE LINE — A group of business terms providing information on individual Invoice lines.

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBG-25
CoversBG-30-00, BG-31, BT-126-00
Business terms (value fields)BT-X-7, BT-X-8, BT-X-37, BT-X-38, BT-X-39, BT-X-40, BT-X-41, BT-X-42, BT-X-46, BT-X-46-0, BT-X-47, BT-X-47-0, BT-X-50, BT-X-51, BT-X-51-0, BT-X-52, BT-X-58, BT-X-59, BT-X-60, BT-X-61, BT-X-62, BT-X-63, BT-X-64, BT-X-65, BT-X-65-0, BT-X-67, BT-X-69, BT-X-70, BT-X-70-0, BT-X-71, BT-X-76, BT-X-77, BT-X-78, BT-X-79, BT-X-80, BT-X-81, BT-X-82, BT-X-83, BT-X-83-0, BT-X-85, BT-X-85-0, BT-X-98, BT-X-304, BT-X-305, BT-X-327, BT-X-328, BT-X-330, BT-X-532, BT-X-533, BT-X-535, BT-X-536, BT-X-541, BT-X-542, BT-X-561, BT-X-561-0, BT-X-562, BT-X-565, BT-X-566, BT-X-569, BT-X-570, BT-X-571, BT-X-572, BT-X-572-0, BT-X-573, BT-X-579, BT-X-580, BT-X-581, BT-X-582, BT-X-583, BT-X-584, BT-X-585, BT-X-586, BT-X-586-0, BT-X-595, BT-X-596, BT-X-597, BT-X-598, BT-X-598-0, BT-X-599, BT-X-606, BT-X-607, BT-X-608, BT-X-609, BT-X-610, BT-X-611, BT-X-612, BT-X-613, BT-X-613-0, BT-126, BT-129, BT-130, BT-131, BT-134, BT-134-0, BT-135, BT-135-0, BT-146, BT-148, BT-149, BT-149-1, BT-150, BT-150-1, BT-153, BT-154, BT-155, BT-156, BT-157, BT-157-1, BT-159, BT-186-00
Repeatable business terms (value lists)BT-X-534, BT-X-567, BT-X-593
Business groups (object lists)BG-X-1, BG-X-2, BG-X-3, BG-X-5, BG-X-8, BG-X-11, BG-X-13, BG-X-47, BG-X-48, BG-X-81, BG-X-82, BG-X-83, BG-X-84, BG-X-91, BG-X-94, BG-27, BG-28, BG-30, BG-32, BT-X-66-00, BT-X-68, BT-X-84-00, BT-X-329, BT-X-568, BT-X-587-00, BT-X-588-00, BT-X-590, BT-X-594, BT-X-614-00, BT-X-615-00, BT-127-00, BT-128-00, BT-132-00, BT-133-00, BT-147-00, BT-158-00, BT-186

Documentation of the represented business group:

BG-25 — INVOICE LINE
DescriptionENA group of business terms providing information on individual Invoice lines.
FRGroupe de termes métiers fournissant des informations sur des lignes de Facture individuelles.
Business ruleENBR-16: An Invoice shall have at least one Invoice line (BG-25).
FRBR-16 : Une Facture doit avoir au moins une ligne de Facture (BG-25).
Since:
1.0.06/2.2
  • Method Details

    • setInvoiceLineIdentifier

      public InvoiceLine setInvoiceLineIdentifier(String value)
      Sets BT-126 Invoice line identifier — A unique identifier for the individual line within the Invoice.

      Rule: BR-21: Each Invoice line (BG-25) shall have an Invoice line identifier (BT-126).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID

      FR: Identifiant de ligne de facture — Identifiant unique d'une ligne au sein de la Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setInvoicedQuantity

      public InvoiceLine setInvoicedQuantity(Quantity value)
      Sets BT-129 Invoiced quantity — The quantity of items (goods or services) that is charged in the Invoice line.

      Conditions (CIUS): CHORUS PRO: Invoiced quantity is supported on 10 digits maximum.

      Rule: BR-22: Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity

      FR: Quantité facturée — Quantité d'articles (biens ou services) prise en compte dans la ligne de Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setInvoicedQuantityUnitOfMeasureCode

      public InvoiceLine setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
      Sets BT-130 Invoiced quantity unit of measure code — The unit of measure that applies to the invoiced quantity.

      Usage: The unit of measure shall be chosen from the lists in UN/ECE Recommendation N°. 20 “Codes for Units of Measure Used in International Trade” [7] and UN/ECE Recommendation N° 21 “Codes for Passengers, Types of Cargo, Packages and Packaging Materials (with Complementary Codes for Package Names)” [19] applying the method described in UN/ECE Rec N° 20 Intro 2.a). Note that in most cases it is not needed for Buyers and Sellers to implement these lists fully in their software. Sellers need only to support the units needed for their goods and services; Buyers only need to verify that the units used in the Invoice are equal to the units used in other documents (such as Contract, Catalogue, Order and Despatch advice).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BR-23: An Invoice line (BG-25) shall have an Invoiced quantity unit of measure code (BT-130).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode

      FR: Unité de mesure de la quantité facturée — Unité de mesure applicable à la quantité facturée.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setInvoiceLineNetAmount

      public InvoiceLine setInvoiceLineNetAmount(Amount value)
      Sets BT-131 Invoice line net amount — The total amount of the Invoice line.

      Usage: The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.

      Rule: BR-24: Each Invoice line (BG-25) shall have an Invoice line net amount (BT-131).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount

      FR: Montant net de ligne de facture — Montant total de la ligne de Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
      API Note:
      This is a computed value: by default it is computed from the invoice contents, and a value supplied through this method is ignored. There is normally no reason to call this method.

      Calling this setter stores the value, but getInvoiceLineNetAmount() returns that stored value if and only if recomputation is disabled -- that is, either Invoice.setRecompute(false) has been called and is in effect, or line-amount computation has been switched off (the facturx.computeBT131 system property set to false), at the moment getInvoiceLineNetAmount() is invoked; otherwise getInvoiceLineNetAmount() returns the freshly computed value and the stored value is ignored.

      Because toXML() reads this value through getInvoiceLineNetAmount(), a value set here appears in the generated XML only under those same conditions.

    • setInvoiceLinePeriodStartDate

      public InvoiceLine setInvoiceLinePeriodStartDate(LocalDate value)
      Sets BT-134 Invoice line period start date — The date when the Invoice period for this Invoice line starts.

      Usage: The date is the first day of the period.

      Conditions (CIUS): This date must be less than or equal to the end date of the period (BT-135), if it exists

      Rule: BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString

      FR: Date de début de période de facturation d'une ligne — Date à laquelle la période de facturation commence pour cette ligne de Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setInvoiceLinePeriodEndDate

      public InvoiceLine setInvoiceLinePeriodEndDate(LocalDate value)
      Sets BT-135 Invoice line period end date — The date when the Invoice period for this Invoice line ends.

      Usage: The date is the last day of the period.

      Conditions (CIUS): This date must be greater than or equal to the period start date (BT-134), if it exists

      Rule: BR-30: If both Invoice line period start date (BT-134) and Invoice line period end date (BT-135) are given then the Invoice line period end date (BT-135) shall be later or equal to the Invoice line period start date (BT-134).BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString

      FR: Date de fin de période de facturation d'une ligne — Date à laquelle la période de facturation se termine pour cette ligne de Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setItemNetPrice

      public InvoiceLine setItemNetPrice(UnitPriceAmount value)
      Sets BT-146 Item net price — The price of an item, exclusive of VAT, after subtracting item price discount.

      Usage: The Item net price has to be equal with the Item gross price less the Item price discount.

      Conditions (CIUS): The Item net price MUST NOT be negative

      Rule: BR-26: Each Invoice line (BG-25) shall contain the Item net price (BT-146).BR-27: The Item net price (BT-146) shall NOT be negative.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount

      FR: Prix net de l'article — Prix d'un article, hors TVA, après application du Rabais sur le prix de l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed from the invoice contents, so there is usually no reason to call this method. Unlike the other computed fields, however, a value you set here is always honoured: getItemNetPrice() returns it and recomputation never overrides it.

      Because toXML() reads this value through getItemNetPrice(), a value set here is always written to the generated XML.

    • setItemGrossPrice

      public InvoiceLine setItemGrossPrice(UnitPriceAmount value)
      Sets BT-148 Item gross price — The unit price, exclusive of VAT, before subtracting Item price discount.

      Conditions (CIUS): The Item gross price MUST NOT be negative

      Rule: BR-28: The Item gross price (BT-148) shall NOT be negative.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:ChargeAmount

      FR: Prix brut de l'article — Prix unitaire, hors TVA, avant application du Rabais sur le prix de l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed from the invoice contents, so there is usually no reason to call this method. Unlike the other computed fields, however, a value you set here is always honoured: getItemGrossPrice() returns it and recomputation never overrides it.

      Because toXML() reads this value through getItemGrossPrice(), a value set here is always written to the generated XML.

    • setNetItemPriceBaseQuantity

      public InvoiceLine setNetItemPriceBaseQuantity(Quantity value)
      Sets BT-149 Item price base quantity — The number of item units to which the price applies.

      Conditions (CIUS): Optional, if filled and if BT-148 is present (EN16931 and EXTENDED profiles), then it should be the same value than BT-149-1

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity

      FR: Quantité de base du prix de l'article — Nombre d'articles sur lequel s'applique le prix.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setGrossItemPriceBaseQuantity

      public InvoiceLine setGrossItemPriceBaseQuantity(Quantity value)
      Sets BT-149-1 Item price base quantity — The number of item units to which the price applies.

      Conditions (CIUS): To fill if BT-149 is present and if BT-148 is present, with the same value than BT-149

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity

      FR: Quantité de base du prix de l'article — Nombre d'articles sur lequel s'applique le prix.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setNetItemPriceBaseQuantityUnitOfMeasureCode

      public InvoiceLine setNetItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
      Sets BT-150 Item price base quantity unit of measure code — The unit of measure that applies to the Item price base quantity.

      Usage: The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BT-130, BT-150 and BT-150-1 must be equal if stated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode

      FR: Unité de mesure de la quantité de base du prix de l'article — Unité de mesure applicable à la Quantité de base du prix de l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setGrossItemPriceBaseQuantityUnitOfMeasureCode

      public InvoiceLine setGrossItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
      Sets BT-150-1 Item price base quantity unit of measure code — The unit of measure that applies to the Item price base quantity.

      Usage: The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BT-130, BT-150 and BT-150-1 must be equal if stated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity/@unitCode

      FR: Unité de mesure de la quantité de base du prix de l'article — Unité de mesure applicable à la Quantité de base du prix de l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setItemName

      public InvoiceLine setItemName(String value)
      Sets BT-153 Item name — A name for an item.

      Rule: BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name

      FR: Nom de l'article — Nom d'un article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setItemDescription

      public InvoiceLine setItemDescription(String value)
      Sets BT-154 Item description — A description for an item.

      Usage: The Item description allows for describing the item and its features in more detail than the Item name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Description

      FR: Description de l'article — Description d'un article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setSellerAssignedID

      public InvoiceLine setSellerAssignedID(String value)
      Sets BT-155 Item Seller's identifier — An identifier, assigned by the Seller, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:SellerAssignedID

      FR: Identifiant vendeur de l'article — Identifiant attribué par le Vendeur à un article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setBuyerAssignedID

      public InvoiceLine setBuyerAssignedID(String value)
      Sets BT-156 Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BuyerAssignedID

      FR: Identifiant acheteur de l'article — Identifiant attribué par l'Acheteur à un article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemStandardIdentifier

      public InvoiceLine setItemStandardIdentifier(String value)
      Sets BT-157 Item standard identifier — An item identifier based on a registered scheme.

      Conditions (CIUS): CHORUSPRO: this field is limited to 40 characters

      Rule: BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID

      FR: Identifiant standard de l'article — Identifiant d'article basé sur un schéma enregistré.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setSchemeIdentifierForItemStandardIdentifier

      public InvoiceLine setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)
      Sets BT-157-1 Scheme identifier for Item standard identifier — The identification scheme identifier of the Item standard identifier

      Usage: The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant standard de l'article

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setItemCountryOfOrigin

      public InvoiceLine setItemCountryOfOrigin(Codes.CountryCodeList value)
      Sets BT-159 Item country of origin — The code identifying the country from which the item originates.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:OriginTradeCountry/ram:ID

      FR: Pays d'origine de l'article — Code identifiant le pays d'où provient l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToIdentifier

      public InvoiceLine setLineDeliverToIdentifier(String value)
      Sets BT-186-00 SHIP TO ID.

      Usage: A previously exchanged assigned identifier of the business partner.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:ID

      FR: Identifiant du lieu de livraison à la ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setParentLineID

      public InvoiceLine setParentLineID(String value)
      Sets BT-X-304 Parent Line ID — The value given here refers to the superior line. In this way, a hierarchy tree of invoice items can be mapped.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:ParentLineID

      FR: Identfiant de ligne parent pour une souus-ligne — La valeur indiquée ici renvoie à la ligne supérieure. De cette manière, une arborescence des postes de facture peut être représentée.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemStandardIdentifierSchemeIdentifier

      public InvoiceLine setItemStandardIdentifierSchemeIdentifier(String value)
      Sets BT-X-305 Item standard identifier Scheme identifier — An item identifier

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ID

      FR: Identifiant de l'article — Identifiant privé d'article

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setChargeTotalAmount

      public InvoiceLine setChargeTotalAmount(UnitPriceAmount value)
      Sets BT-X-327 Line Total Charges Amount (without VAT).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:ChargeTotalAmount

      FR: Montant total des charges de ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setAllowanceTotalAmount

      public InvoiceLine setAllowanceTotalAmount(UnitPriceAmount value)
      Sets BT-X-328 Line Total Allowance Amount (without VAT).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:AllowanceTotalAmount

      FR: Montant total des remises de ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineGrandTotalAmount

      public InvoiceLine setLineGrandTotalAmount(Decimal value)
      Sets BT-X-330 Line Grand Total amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:GrandTotalAmount

      FR: Montant total avec taxes

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setIncludedTaxForB2CCalculatedAmount

      public InvoiceLine setIncludedTaxForB2CCalculatedAmount(UnitPriceAmount value)
      Sets BT-X-37 Included tax for B2C — A monetary value resulting from the calculation of this trade related tax, levy or duty.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CalculatedAmount

      FR: Montant de TVA incluse pour le B2C

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setIncludedTaxForB2CExcemptionReason

      public InvoiceLine setIncludedTaxForB2CExcemptionReason(String value)
      Sets BT-X-39 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReason

      FR: Raison de l'exonération de TVA pour le B2C — Énoncé expliquant pourquoi un montant est exonéré de TVA.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setIncludedTaxForB2CCategoryCode

      public InvoiceLine setIncludedTaxForB2CCategoryCode(Codes.VATCategoryCode value)
      Sets BT-X-40 VAT category code — Coded identification of a VAT category.

      Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)

      Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CategoryCode

      FR: Catégorie de TVA pour le B2C — Identification codée d’un type de TVA.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setVATExemptionReasonCode

      public InvoiceLine setVATExemptionReasonCode(Codes.VATExemptionReasonCode value)
      Sets BT-X-41 VAT exemption reason code — A coded statement of the reason for why the amount is exempted from VAT.

      Usage: Code list issued and maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReasonCode

      FR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setIncludedTaxForB2CApplicablePercent

      public InvoiceLine setIncludedTaxForB2CApplicablePercent(Percentage value)
      Sets BT-X-42 VAT category rate — The VAT rate, represented as percentage that applies for the relevant VAT category.

      Usage: The VAT category code and the VAT category rate shall be consistent.

      Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA pour le B2C — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setChargeFreeQuantity

      public InvoiceLine setChargeFreeQuantity(Quantity value)
      Sets BT-X-46 Charge Free Quantity — The quantity, at line level, free of charge, in this trade delivery.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity

      FR: Quantité sans frais

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setChargeFreeQuantityMeasurementUnit

      public InvoiceLine setChargeFreeQuantityMeasurementUnit(Codes.UnitOfMeasure value)
      Sets BT-X-46-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity/@unitCode

      FR: Unité de mesure

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setPackageQuantity

      public InvoiceLine setPackageQuantity(Quantity value)
      Sets BT-X-47 Package quantity — The number of packages, at line level, in this trade delivery.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity

      FR: Nombre de colis

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setPackageQuantityMeasurementUnit

      public InvoiceLine setPackageQuantityMeasurementUnit(Codes.UnitOfMeasure value)
      Sets BT-X-47-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity/@unitCode

      FR: Unité de mesure

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToName

      public InvoiceLine setLineDeliverToName(String value)
      Sets BT-X-50 SHIP TO Name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:Name

      FR: Nom du lieu de livraison

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToLegalOrganizationIdentifer

      public InvoiceLine setLineDeliverToLegalOrganizationIdentifer(String value)
      Sets BT-X-51 SHIP TO Legal ID — An identifier issued by an official registrar that identifies the party as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToLegalOrganizationSchemeIdentiferAttribute

      public InvoiceLine setLineDeliverToLegalOrganizationSchemeIdentiferAttribute(String value)
      Sets BT-X-51-0 Scheme identifier — The identification scheme identifier of the Buyer legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToLegalOrganizationTradingName

      public InvoiceLine setLineDeliverToLegalOrganizationTradingName(String value)
      Sets BT-X-52 SHIP TO Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial du lieu de livraison alternatif — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setIndustryAssignedID

      public InvoiceLine setIndustryAssignedID(String value)
      Sets BT-X-532 Item (Trade Product) Industry Assigned ID — An identifier, assigned by the Industry, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IndustryAssignedID

      FR: Identifiant Industrie de l'article — Un identifiant, attribué par l'industrie, pour l'article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setModelID

      public InvoiceLine setModelID(String value)
      Sets BT-X-533 Item (Trade Product) Model Name ID — A unique model identifier for this item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ModelID

      FR: Identification du modèle de l'article — Un identifiant de modèle unique pour cet article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setBrandName

      public InvoiceLine setBrandName(String value)
      Sets BT-X-535 Item (Trade Product) Brand Name — The brand name, expressed as text, for this item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BrandName

      FR: Marque de l'article — Le nom de la marque, exprimé sous forme de texte, pour cet article.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setModelName

      public InvoiceLine setModelName(String value)
      Sets BT-X-536 Item (Trade Product) Model Name — A group of business terms providing information about properties of the goods and services ordered.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ModelName

      FR: Nom du modèle de l'article

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToRoleCode

      public InvoiceLine setLineDeliverToRoleCode(String value)
      Sets BT-X-541 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035, for instance:DL: FactorDS: DistributorMOP: Market operator

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToRoleCode

      public InvoiceLine setLineUltimateShipToRoleCode(String value)
      Sets BT-X-542 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035, for instance:DL: FactorDS: DistributorMOP: Market operator

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setPerPackageUnitQuantity

      public InvoiceLine setPerPackageUnitQuantity(Quantity value)
      Sets BT-X-561 Number of units in a Parent line (BT-X-304) unit — In case of a presence of a ParentLineID, it describes the number of units in a single unit of the ParenltlineID

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PerPackageUnitQuantity

      FR: Nombre d'unité dans une unité de la ligne Parent (BT-X-304) — En cas de présence d'un ParentLineID, il décrit le nombre d'unités dans une seule unité du ParenltlineID.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setUnitOfMeasure

      public InvoiceLine setUnitOfMeasure(Codes.UnitOfMeasure value)
      Sets BT-X-561-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PerPackageUnitQuantity/@unitCode

      FR: Unité de mesure

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setDeliveryTypeCodeForThisLineItem

      public InvoiceLine setDeliveryTypeCodeForThisLineItem(Codes.Incoterms value)
      Sets BT-X-562 DeliveryTypeCode for this line item — The code specifying the type of delivery for these trade delivery terms.

      Usage: To be chosen from the entries in UNTDID 4053 + INCOTERMS List 1 : Delivery arranged by the supplier (Indicates that the supplier will arrange delivery of the goods).2 : Delivery arranged by logistic service provider (Code indicating that the logistic service provider has arranged the delivery of goods).CFR : Cost and Freight (insert named port of destination)CIF : Cost, Insurance and Freight (insert named port of destination)CIP : Carriage and Insurance Paid to (insert named place of destination) CPT : Carriage Paid To (insert named place of destination)DAP : Delivered At Place (insert named place of destination)DAT : Delivered At Terminal (insert named terminal at port or place of destination)DDP : Delivered Duty Paid (insert named place of destination)EXW : Ex Works (insert named place of delivery)FAS : Free Alongside Ship (insert named port of shipment)FCA : Free Carrier (insert named place of delivery)FOB : Free On Board (insert named port of shipment)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:DeliveryTypeCode

      FR: Type de livraison en code pour cette ligne — Code spécifiant le type de livraison pour ces conditions de livraison commerciale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setCountryIDOfLocationForTheDeliveryTermsForThisLineItem

      public InvoiceLine setCountryIDOfLocationForTheDeliveryTermsForThisLineItem(Codes.CountryCodeList value)
      Sets BT-X-565 CountryID of location for the delivery terms for this line item — The Country ID of the delivery location

      Usage: From ISO 3166

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:RelevantTradeLocation/ram:CountryID

      FR: Code pays du lieu de livraison pour cette ligne — Lieu de livraison identifié dans les conditions de livraison

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setNameOfLocationForTheDeliveryTermsForThisLineItem

      public InvoiceLine setNameOfLocationForTheDeliveryTermsForThisLineItem(String value)
      Sets BT-X-566 Name of location for the delivery terms for this line item — The name of the delivery location

      Usage: Such as a Port, place of delivery

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:RelevantTradeLocation/ram:Name

      FR: Nom du lieu de livraison pour cette ligne — Lieu de livraison identifié dans les conditions de livraison

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerName

      public InvoiceLine setItemSellerName(String value)
      Sets BT-X-569 Seller on line level name — The full formal name by which the Seller on line level is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:Name

      FR: Raison sociale du vendeur à la ligne — Dénomination officielle complète sous laquelle le Vendeur est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerRoleCode

      public InvoiceLine setItemSellerRoleCode(String value)
      Sets BT-X-570 Seller on line level Role (code) — A code qualifying the role of the party

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:RoleCode

      FR: Code du röle du Vendeur à le ligne — Un Code pour qualifier le role de la Party

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerAdditionalLegalInformation

      public InvoiceLine setItemSellerAdditionalLegalInformation(String value)
      Sets BT-X-571 Seller on line level additional legal information — Additional legal information relevant for the Seller.

      Usage: Such as share capital.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:Description

      FR: Informations juridiques additionnelles sur le vendeur à la ligne — Informations juridiques additionnelles sur le Vendeu à la ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerLegalOrganizationIdentifer

      public InvoiceLine setItemSellerLegalOrganizationIdentifer(String value)
      Sets BT-X-572 Seller on line level legal registration identifier — An identifier issued by an official registrar that identifies the Seller on line level as a legal entity or person.

      Usage: If no identification scheme is specified, it must be known by Buyer and Seller.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du vendeur à la ligne — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Vendeur comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerLegalOrganizationSchemeIdentiferAttribute

      public InvoiceLine setItemSellerLegalOrganizationSchemeIdentiferAttribute(String value)
      Sets BT-X-572-0 Scheme identifier — The identification scheme identifier of the Seller on line level legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du vendeur.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerLegalOrganizationTradingName

      public InvoiceLine setItemSellerLegalOrganizationTradingName(String value)
      Sets BT-X-573 Seller on line level trading name — A name by which the Seller on line level is known, other than Seller on line level name (also known as Business name).

      Usage: This may be used if different from the Seller name.

      Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Appellation commerciale du vendeur à la ligne — Nom sous lequel le Vendeur est connu, autre que la Raison sociale du vendeur (également appelée Dénomination commerciale).

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerPostCode

      public InvoiceLine setItemSellerPostCode(String value)
      Sets BT-X-579 Seller on line level post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal du vendeur à la ligne — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToPostCode

      public InvoiceLine setLineDeliverToPostCode(String value)
      Sets BT-X-58 PostcodeCode — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de livraison — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setItemSellerAddressLine1

      public InvoiceLine setItemSellerAddressLine1(String value)
      Sets BT-X-580 Seller on line level address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse du vendeur à la ligne - Ligne 1 — Ligne principale d'une adresse.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerAddressLine2

      public InvoiceLine setItemSellerAddressLine2(String value)
      Sets BT-X-581 Seller on line level address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse du vendeur à la ligne - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerAddressLine3

      public InvoiceLine setItemSellerAddressLine3(String value)
      Sets BT-X-582 Seller on line level address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse du vendeur à la ligne - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerCity

      public InvoiceLine setItemSellerCity(String value)
      Sets BT-X-583 Seller on line level city — The common name of the city, town or village, where the Seller on line level address is located.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité du vendeur à la ligne — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Vendeur.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerCountryCode

      public InvoiceLine setItemSellerCountryCode(Codes.CountryCodeList value)
      Sets BT-X-584 Seller on line level country code — A code that identifies the country.

      Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays du vendeur à la ligne — Code d'identification du pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerCountrySubdivision

      public InvoiceLine setItemSellerCountrySubdivision(String value)
      Sets BT-X-585 Seller on line level country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays du vendeur à la ligne — Subdivision d'un pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerElectronicAddress

      public InvoiceLine setItemSellerElectronicAddress(String value)
      Sets BT-X-586 Seller on line level electronic address — Identifies the Seller on line level's electronic address to which a business document may be delivered.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du vendeur à la ligne — Identifie l'adresse électronique du Vendeur à laquelle un document commercial peut être transmis.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setItemSellerElectronicAddressScheme

      public InvoiceLine setItemSellerElectronicAddressScheme(Codes.ElectronicAddressScheme value)
      Sets BT-X-586-0 Scheme identifier — The identification scheme identifier of the Seller on line level electronic address

      Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma d'identification de l'adresse électronique du vendeur

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToAddressLine1

      public InvoiceLine setLineDeliverToAddressLine1(String value)
      Sets BT-X-59 LineOne — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setManufacturerName

      public InvoiceLine setManufacturerName(String value)
      Sets BT-X-595 Manufacturer on line level name — The full formal name by which the Manufacturer on line level is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:Name

      FR: Raison sociale du fabricant — Dénomination officielle complète sous laquelle le fabricant est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerRoleCode

      public InvoiceLine setManufacturerRoleCode(String value)
      Sets BT-X-596 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerAdditionalLegalInformation

      public InvoiceLine setManufacturerAdditionalLegalInformation(String value)
      Sets BT-X-597 Manufacturer additional legal information — Additional legal information relevant for the manufacturer.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:Description

      FR: Informations juridiques additionnelles sur le fabricant — Informations juridiques additionnelles sur le fabricant.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerLegalOrganizationIdentifer

      public InvoiceLine setManufacturerLegalOrganizationIdentifer(String value)
      Sets BT-X-598 Manufacturer legal registration identifier — An identifier issued by an official registrar that identifies the manufacturer as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du fabricant — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le fabricant comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerLegalOrganizationSchemeIdentiferAttribute

      public InvoiceLine setManufacturerLegalOrganizationSchemeIdentiferAttribute(String value)
      Sets BT-X-598-0 Scheme identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Identifiant d’enregistrement légal de l'acheteur

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerLegalOrganizationTradingName

      public InvoiceLine setManufacturerLegalOrganizationTradingName(String value)
      Sets BT-X-599 Manufacturer trading name — A name by which the manufacturer is known, other than manufacturer name (also known as Business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Appellation commerciale du fabricant — Nom sous lequel le fabricant est connu, autre que la Raison sociale du fabricant (également appelée Dénomination commerciale).

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToAddressLine2

      public InvoiceLine setLineDeliverToAddressLine2(String value)
      Sets BT-X-60 LineTwo — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setManufacturerPostCode

      public InvoiceLine setManufacturerPostCode(String value)
      Sets BT-X-606 Manufacturer on line level post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerAddressLine1

      public InvoiceLine setManufacturerAddressLine1(String value)
      Sets BT-X-607 Manufacturer on line level address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse ligne 1 — Ligne principale d'une adresse.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerAddressLine2

      public InvoiceLine setManufacturerAddressLine2(String value)
      Sets BT-X-608 Manufacturer on line level address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerAddressLine3

      public InvoiceLine setManufacturerAddressLine3(String value)
      Sets BT-X-609 Manufacturer on line level address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToAddressLine3

      public InvoiceLine setLineDeliverToAddressLine3(String value)
      Sets BT-X-61 LineThree — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse de livraison - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setManufacturerCity

      public InvoiceLine setManufacturerCity(String value)
      Sets BT-X-610 Manufacturer on line level city — The common name of the city, town or village, where the Manufacturer on line level address is located.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité — Nom usuel de la commune, ville ou village.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerCountryCode

      public InvoiceLine setManufacturerCountryCode(Codes.CountryCodeList value)
      Sets BT-X-611 Manufacturer on line level country code — A code that identifies the country.

      Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays — Code d'identification du pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerCountrySubdivision

      public InvoiceLine setManufacturerCountrySubdivision(String value)
      Sets BT-X-612 Manufacturer on line level country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays — Subdivision d'un pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerElectronicAddress

      public InvoiceLine setManufacturerElectronicAddress(String value)
      Sets BT-X-613 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setManufacturerElectronicAddressScheme

      public InvoiceLine setManufacturerElectronicAddressScheme(Codes.ElectronicAddressScheme value)
      Sets BT-X-613-0 Scheme identifier.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToCity

      public InvoiceLine setLineDeliverToCity(String value)
      Sets BT-X-62 CityName — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité de livraison — Nom usuel de la commune, ville ou village.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToCountryCode

      public InvoiceLine setLineDeliverToCountryCode(Codes.CountryCodeList value)
      Sets BT-X-63 CountryID — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code du pays de livraison — Code d'identification du pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToCountrySubdivision

      public InvoiceLine setLineDeliverToCountrySubdivision(String value)
      Sets BT-X-64 CountrySubDivisionName — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de livraison — Subdivision d'un pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineDeliverToElectronicAddress

      public InvoiceLine setLineDeliverToElectronicAddress(String value)
      Sets BT-X-65 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du lieu de livraison alternatif

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineDeliverToElectronicAddressScheme

      public InvoiceLine setLineDeliverToElectronicAddressScheme(Codes.ElectronicAddressScheme value)
      Sets BT-X-65-0 Scheme identifier.

      Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineUltimateShipToIdentifier

      public InvoiceLine setLineUltimateShipToIdentifier(String value)
      Sets BT-X-67 Final recipient identifier.

      Usage: A previously exchanged assigned identifier of the business partner.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:ID

      FR: Identifiant du lieu de livraison final à la ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToName

      public InvoiceLine setLineUltimateShipToName(String value)
      Sets BT-X-69 Final Recipient Name / Company Name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:Name

      FR: Nom du lieu de livraison final

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineStatusCode

      public InvoiceLine setLineStatusCode(LineStatusCodeContentType value)
      Sets BT-X-7 LineStatusCode — Indicating whether an item includes the prices which must be taken into account when calculating the invoice amount, or whether it only contains information.

      Usage: Codelist UNTDID 1229

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusCode

      FR: Type de ligne de facture en code — Indique si la ligne contient des prix à prendre dans le modèle de calcul ou seulement des données informatives.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineUltimateShipToLegalOrganizationIdentifer

      public InvoiceLine setLineUltimateShipToLegalOrganizationIdentifer(String value)
      Sets BT-X-70 Company Registration Number — An identifier issued by an official registrar that identifies the party as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant de l'organisation légale du lieu de livraison final — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToLegalOrganizationSchemeIdentiferAttribute

      public InvoiceLine setLineUltimateShipToLegalOrganizationSchemeIdentiferAttribute(String value)
      Sets BT-X-70-0 Scheme identifier — The identification scheme identifier of the Buyer legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToLegalOrganizationTradingName

      public InvoiceLine setLineUltimateShipToLegalOrganizationTradingName(String value)
      Sets BT-X-71 Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial du lieu de livraison final — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToPostCode

      public InvoiceLine setLineUltimateShipToPostCode(String value)
      Sets BT-X-76 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de livraison final — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToAddressLine1

      public InvoiceLine setLineUltimateShipToAddressLine1(String value)
      Sets BT-X-77 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToAddressLine2

      public InvoiceLine setLineUltimateShipToAddressLine2(String value)
      Sets BT-X-78 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToAddressLine3

      public InvoiceLine setLineUltimateShipToAddressLine3(String value)
      Sets BT-X-79 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse de livraison final - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineStatusReasonCode

      public InvoiceLine setLineStatusReasonCode(String value)
      Sets BT-X-8 LineStatusReasonCode — Complements the type to clarify whether the invoice item is one of the following: - Detail (default positioning) - Subtotal - Solely information

      Usage: If the LineStatusCode element is used, the LineStatusReasonCode must be filled in: DETAIL, GROUP, INFORMATION

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusReasonCode

      FR: Sous-type de ligne de facture — Complète le type, afin de préciser si la ligne est :- détail (ligne normale)- sous-total- seulement des informations

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setLineUltimateShipToCity

      public InvoiceLine setLineUltimateShipToCity(String value)
      Sets BT-X-80 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité de livraison finale — Nom usuel de la commune, ville ou village.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToCountryCode

      public InvoiceLine setLineUltimateShipToCountryCode(Codes.CountryCodeList value)
      Sets BT-X-81 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code du pays de livraison finale — Code d'identification du pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToCountrySubdivision

      public InvoiceLine setLineUltimateShipToCountrySubdivision(String value)
      Sets BT-X-82 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de livraison finale — Subdivision d'un pays.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToElectronicAddress

      public InvoiceLine setLineUltimateShipToElectronicAddress(String value)
      Sets BT-X-83 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du lieu de livraison alternatif

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setLineUltimateShipToElectronicAddressScheme

      public InvoiceLine setLineUltimateShipToElectronicAddressScheme(Codes.ElectronicAddressScheme value)
      Sets BT-X-83-0 Scheme identifier.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • setDeliveryDateForThisLine

      public InvoiceLine setDeliveryDateForThisLine(LocalDate value)
      Sets BT-X-85 Delivery Date for this line.

      Usage: The VAT relevant date of delivery and achievement must be specified on the level of document.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString

      FR: Date de livraison à la ligne, valeur

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • setTotalAllowanceAndChargeAmountForThisLine

      public InvoiceLine setTotalAllowanceAndChargeAmountForThisLine(UnitPriceAmount value)
      Sets BT-X-98 Total Allowance AND Charge Amount for this line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TotalAllowanceChargeAmount

      FR: Montant total des remises et charges de ligne

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.09.2/2.5.2
    • getInvoiceLineIdentifier

      public String getInvoiceLineIdentifier()
      Returns BT-126 Invoice line identifier — A unique identifier for the individual line within the Invoice.

      Rule: BR-21: Each Invoice line (BG-25) shall have an Invoice line identifier (BT-126).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID

      FR: Identifiant de ligne de facture — Identifiant unique d'une ligne au sein de la Facture.

      Returns:
      the BT-126 value
      Since:
      1.09.2/2.5.2
    • getInvoicedQuantity

      public Quantity getInvoicedQuantity()
      Returns BT-129 Invoiced quantity — The quantity of items (goods or services) that is charged in the Invoice line.

      Conditions (CIUS): CHORUS PRO: Invoiced quantity is supported on 10 digits maximum.

      Rule: BR-22: Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity

      FR: Quantité facturée — Quantité d'articles (biens ou services) prise en compte dans la ligne de Facture.

      Returns:
      the BT-129 value
      Since:
      1.0.06/2.2
    • getInvoicedQuantityUnitOfMeasureCode

      public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
      Returns BT-130 Invoiced quantity unit of measure code — The unit of measure that applies to the invoiced quantity.

      Usage: The unit of measure shall be chosen from the lists in UN/ECE Recommendation N°. 20 “Codes for Units of Measure Used in International Trade” [7] and UN/ECE Recommendation N° 21 “Codes for Passengers, Types of Cargo, Packages and Packaging Materials (with Complementary Codes for Package Names)” [19] applying the method described in UN/ECE Rec N° 20 Intro 2.a). Note that in most cases it is not needed for Buyers and Sellers to implement these lists fully in their software. Sellers need only to support the units needed for their goods and services; Buyers only need to verify that the units used in the Invoice are equal to the units used in other documents (such as Contract, Catalogue, Order and Despatch advice).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BR-23: An Invoice line (BG-25) shall have an Invoiced quantity unit of measure code (BT-130).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode

      FR: Unité de mesure de la quantité facturée — Unité de mesure applicable à la quantité facturée.

      Returns:
      the BT-130 value
      Since:
      1.0.06/2.2
    • getInvoiceLinePeriodStartDate

      public LocalDate getInvoiceLinePeriodStartDate()
      Returns BT-134 Invoice line period start date — The date when the Invoice period for this Invoice line starts.

      Usage: The date is the first day of the period.

      Conditions (CIUS): This date must be less than or equal to the end date of the period (BT-135), if it exists

      Rule: BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString

      FR: Date de début de période de facturation d'une ligne — Date à laquelle la période de facturation commence pour cette ligne de Facture.

      Returns:
      the BT-134 value
      Since:
      1.0.06/2.2
    • getStartDateFormat

      public Codes.DateFormat getStartDateFormat() throws ComputationException
      Returns BT-134-0 Date format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-134-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getInvoiceLinePeriodEndDate

      public LocalDate getInvoiceLinePeriodEndDate()
      Returns BT-135 Invoice line period end date — The date when the Invoice period for this Invoice line ends.

      Usage: The date is the last day of the period.

      Conditions (CIUS): This date must be greater than or equal to the period start date (BT-134), if it exists

      Rule: BR-30: If both Invoice line period start date (BT-134) and Invoice line period end date (BT-135) are given then the Invoice line period end date (BT-135) shall be later or equal to the Invoice line period start date (BT-134).BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString

      FR: Date de fin de période de facturation d'une ligne — Date à laquelle la période de facturation se termine pour cette ligne de Facture.

      Returns:
      the BT-135 value
      Since:
      1.0.06/2.2
    • getEndDateFormat

      public Codes.DateFormat getEndDateFormat() throws ComputationException
      Returns BT-135-0 Date format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-135-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getNetItemPriceBaseQuantity

      public Quantity getNetItemPriceBaseQuantity()
      Returns BT-149 Item price base quantity — The number of item units to which the price applies.

      Conditions (CIUS): Optional, if filled and if BT-148 is present (EN16931 and EXTENDED profiles), then it should be the same value than BT-149-1

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity

      FR: Quantité de base du prix de l'article — Nombre d'articles sur lequel s'applique le prix.

      Returns:
      the BT-149 value
      Since:
      1.0.06/2.2
    • getGrossItemPriceBaseQuantity

      public Quantity getGrossItemPriceBaseQuantity()
      Returns BT-149-1 Item price base quantity — The number of item units to which the price applies.

      Conditions (CIUS): To fill if BT-149 is present and if BT-148 is present, with the same value than BT-149

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity

      FR: Quantité de base du prix de l'article — Nombre d'articles sur lequel s'applique le prix.

      Returns:
      the BT-149-1 value
      Since:
      1.0.06/2.2
    • getNetItemPriceBaseQuantityUnitOfMeasureCode

      public Codes.UnitOfMeasure getNetItemPriceBaseQuantityUnitOfMeasureCode()
      Returns BT-150 Item price base quantity unit of measure code — The unit of measure that applies to the Item price base quantity.

      Usage: The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BT-130, BT-150 and BT-150-1 must be equal if stated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode

      FR: Unité de mesure de la quantité de base du prix de l'article — Unité de mesure applicable à la Quantité de base du prix de l'article.

      Returns:
      the BT-150 value
      Since:
      1.0.06/2.2
    • getGrossItemPriceBaseQuantityUnitOfMeasureCode

      public Codes.UnitOfMeasure getGrossItemPriceBaseQuantityUnitOfMeasureCode()
      Returns BT-150-1 Item price base quantity unit of measure code — The unit of measure that applies to the Item price base quantity.

      Usage: The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

      Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton

      Rule: BT-130, BT-150 and BT-150-1 must be equal if stated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity/@unitCode

      FR: Unité de mesure de la quantité de base du prix de l'article — Unité de mesure applicable à la Quantité de base du prix de l'article.

      Returns:
      the BT-150-1 value
      Since:
      1.0.06/2.2
    • getItemName

      public String getItemName()
      Returns BT-153 Item name — A name for an item.

      Rule: BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name

      FR: Nom de l'article — Nom d'un article.

      Returns:
      the BT-153 value
      Since:
      1.0.06/2.2
    • getItemDescription

      public String getItemDescription()
      Returns BT-154 Item description — A description for an item.

      Usage: The Item description allows for describing the item and its features in more detail than the Item name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Description

      FR: Description de l'article — Description d'un article.

      Returns:
      the BT-154 value
      Since:
      1.0.06/2.2
    • getSellerAssignedID

      public String getSellerAssignedID()
      Returns BT-155 Item Seller's identifier — An identifier, assigned by the Seller, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:SellerAssignedID

      FR: Identifiant vendeur de l'article — Identifiant attribué par le Vendeur à un article.

      Returns:
      the BT-155 value
      Since:
      1.09.2/2.5.2
    • getBuyerAssignedID

      public String getBuyerAssignedID()
      Returns BT-156 Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BuyerAssignedID

      FR: Identifiant acheteur de l'article — Identifiant attribué par l'Acheteur à un article.

      Returns:
      the BT-156 value
      Since:
      1.09.2/2.5.2
    • getItemStandardIdentifier

      public String getItemStandardIdentifier()
      Returns BT-157 Item standard identifier — An item identifier based on a registered scheme.

      Conditions (CIUS): CHORUSPRO: this field is limited to 40 characters

      Rule: BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID

      FR: Identifiant standard de l'article — Identifiant d'article basé sur un schéma enregistré.

      Returns:
      the BT-157 value
      Since:
      1.09.2/2.5.2
    • getSchemeIdentifierForItemStandardIdentifier

      public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
      Returns BT-157-1 Scheme identifier for Item standard identifier — The identification scheme identifier of the Item standard identifier

      Usage: The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant standard de l'article

      Returns:
      the BT-157-1 value
      Since:
      1.0.06/2.2
    • getItemCountryOfOrigin

      public Codes.CountryCodeList getItemCountryOfOrigin()
      Returns BT-159 Item country of origin — The code identifying the country from which the item originates.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:OriginTradeCountry/ram:ID

      FR: Pays d'origine de l'article — Code identifiant le pays d'où provient l'article.

      Returns:
      the BT-159 value
      Since:
      1.0.06/2.2
    • getLineDeliverToIdentifier

      public String getLineDeliverToIdentifier()
      Returns BT-186-00 SHIP TO ID.

      Usage: A previously exchanged assigned identifier of the business partner.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:ID

      FR: Identifiant du lieu de livraison à la ligne

      Returns:
      the BT-186-00 value
      Since:
      1.09.2/2.5.2
    • getParentLineID

      public String getParentLineID()
      Returns BT-X-304 Parent Line ID — The value given here refers to the superior line. In this way, a hierarchy tree of invoice items can be mapped.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:ParentLineID

      FR: Identfiant de ligne parent pour une souus-ligne — La valeur indiquée ici renvoie à la ligne supérieure. De cette manière, une arborescence des postes de facture peut être représentée.

      Returns:
      the BT-X-304 value
      Since:
      1.09.2/2.5.2
    • getItemStandardIdentifierSchemeIdentifier

      public String getItemStandardIdentifierSchemeIdentifier()
      Returns BT-X-305 Item standard identifier Scheme identifier — An item identifier

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ID

      FR: Identifiant de l'article — Identifiant privé d'article

      Returns:
      the BT-X-305 value
      Since:
      1.09.2/2.5.2
    • getChargeTotalAmount

      public UnitPriceAmount getChargeTotalAmount()
      Returns BT-X-327 Line Total Charges Amount (without VAT).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:ChargeTotalAmount

      FR: Montant total des charges de ligne

      Returns:
      the BT-X-327 value
      Since:
      1.0.06/2.2
    • getAllowanceTotalAmount

      public UnitPriceAmount getAllowanceTotalAmount()
      Returns BT-X-328 Line Total Allowance Amount (without VAT).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:AllowanceTotalAmount

      FR: Montant total des remises de ligne

      Returns:
      the BT-X-328 value
      Since:
      1.0.06/2.2
    • getLineGrandTotalAmount

      public Decimal getLineGrandTotalAmount()
      Returns BT-X-330 Line Grand Total amount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:GrandTotalAmount

      FR: Montant total avec taxes

      Returns:
      the BT-X-330 value
      Since:
      1.0.06/2.2
    • getIncludedTaxForB2CCalculatedAmount

      public UnitPriceAmount getIncludedTaxForB2CCalculatedAmount()
      Returns BT-X-37 Included tax for B2C — A monetary value resulting from the calculation of this trade related tax, levy or duty.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CalculatedAmount

      FR: Montant de TVA incluse pour le B2C

      Returns:
      the BT-X-37 value
      Since:
      1.0.06/2.2
    • getIncludedTaxForB2CTypeCode

      public Codes.VATTypeCode getIncludedTaxForB2CTypeCode() throws ComputationException
      Returns BT-X-38 Type of tax (code) — The code specifying the type of trade related tax, levy or duty, such as a code for a Value Added Tax (VAT) [Reference United Nations Code List (UNCL) 5153].

      Usage: Fixed value = "VAT"

      Rule: Fixed value "VAT"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:TypeCode

      FR: Code TVA pour le B2C

      Returns:
      the BT-X-38 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed by the API. A value assigned through the corresponding setter is returned here only if Invoice.setRecompute(false) has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also what toXML() writes.
    • getIncludedTaxForB2CExcemptionReason

      public String getIncludedTaxForB2CExcemptionReason()
      Returns BT-X-39 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReason

      FR: Raison de l'exonération de TVA pour le B2C — Énoncé expliquant pourquoi un montant est exonéré de TVA.

      Returns:
      the BT-X-39 value
      Since:
      1.0.06/2.2
    • getIncludedTaxForB2CCategoryCode

      public Codes.VATCategoryCode getIncludedTaxForB2CCategoryCode()
      Returns BT-X-40 VAT category code — Coded identification of a VAT category.

      Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)

      Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CategoryCode

      FR: Catégorie de TVA pour le B2C — Identification codée d’un type de TVA.

      Returns:
      the BT-X-40 value
      Since:
      1.0.06/2.2
    • getVATExemptionReasonCode

      public Codes.VATExemptionReasonCode getVATExemptionReasonCode()
      Returns BT-X-41 VAT exemption reason code — A coded statement of the reason for why the amount is exempted from VAT.

      Usage: Code list issued and maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReasonCode

      FR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.

      Returns:
      the BT-X-41 value
      Since:
      1.0.06/2.2
    • getIncludedTaxForB2CApplicablePercent

      public Percentage getIncludedTaxForB2CApplicablePercent()
      Returns BT-X-42 VAT category rate — The VAT rate, represented as percentage that applies for the relevant VAT category.

      Usage: The VAT category code and the VAT category rate shall be consistent.

      Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA pour le B2C — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.

      Returns:
      the BT-X-42 value
      Since:
      1.0.06/2.2
    • getChargeFreeQuantity

      public Quantity getChargeFreeQuantity()
      Returns BT-X-46 Charge Free Quantity — The quantity, at line level, free of charge, in this trade delivery.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity

      FR: Quantité sans frais

      Returns:
      the BT-X-46 value
      Since:
      1.0.06/2.2
    • getChargeFreeQuantityMeasurementUnit

      public Codes.UnitOfMeasure getChargeFreeQuantityMeasurementUnit()
      Returns BT-X-46-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity/@unitCode

      FR: Unité de mesure

      Returns:
      the BT-X-46-0 value
      Since:
      1.0.06/2.2
    • getPackageQuantity

      public Quantity getPackageQuantity()
      Returns BT-X-47 Package quantity — The number of packages, at line level, in this trade delivery.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity

      FR: Nombre de colis

      Returns:
      the BT-X-47 value
      Since:
      1.0.06/2.2
    • getPackageQuantityMeasurementUnit

      public Codes.UnitOfMeasure getPackageQuantityMeasurementUnit()
      Returns BT-X-47-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity/@unitCode

      FR: Unité de mesure

      Returns:
      the BT-X-47-0 value
      Since:
      1.0.06/2.2
    • getLineDeliverToName

      public String getLineDeliverToName()
      Returns BT-X-50 SHIP TO Name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:Name

      FR: Nom du lieu de livraison

      Returns:
      the BT-X-50 value
      Since:
      1.0.06/2.2
    • getLineDeliverToLegalOrganizationIdentifer

      public String getLineDeliverToLegalOrganizationIdentifer()
      Returns BT-X-51 SHIP TO Legal ID — An identifier issued by an official registrar that identifies the party as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-51 value
      Since:
      1.0.06/2.2
    • getLineDeliverToLegalOrganizationSchemeIdentiferAttribute

      public String getLineDeliverToLegalOrganizationSchemeIdentiferAttribute()
      Returns BT-X-51-0 Scheme identifier — The identification scheme identifier of the Buyer legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-51-0 value
      Since:
      1.0.06/2.2
    • getLineDeliverToLegalOrganizationTradingName

      public String getLineDeliverToLegalOrganizationTradingName()
      Returns BT-X-52 SHIP TO Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial du lieu de livraison alternatif — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

      Returns:
      the BT-X-52 value
      Since:
      1.0.06/2.2
    • getIndustryAssignedID

      public String getIndustryAssignedID()
      Returns BT-X-532 Item (Trade Product) Industry Assigned ID — An identifier, assigned by the Industry, for the item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IndustryAssignedID

      FR: Identifiant Industrie de l'article — Un identifiant, attribué par l'industrie, pour l'article.

      Returns:
      the BT-X-532 value
      Since:
      1.09.2/2.5.2
    • getModelID

      public String getModelID()
      Returns BT-X-533 Item (Trade Product) Model Name ID — A unique model identifier for this item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ModelID

      FR: Identification du modèle de l'article — Un identifiant de modèle unique pour cet article.

      Returns:
      the BT-X-533 value
      Since:
      1.09.2/2.5.2
    • getBrandName

      public String getBrandName()
      Returns BT-X-535 Item (Trade Product) Brand Name — The brand name, expressed as text, for this item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BrandName

      FR: Marque de l'article — Le nom de la marque, exprimé sous forme de texte, pour cet article.

      Returns:
      the BT-X-535 value
      Since:
      1.09.2/2.5.2
    • getModelName

      public String getModelName()
      Returns BT-X-536 Item (Trade Product) Model Name — A group of business terms providing information about properties of the goods and services ordered.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ModelName

      FR: Nom du modèle de l'article

      Returns:
      the BT-X-536 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToRoleCode

      public String getLineDeliverToRoleCode()
      Returns BT-X-541 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035, for instance:DL: FactorDS: DistributorMOP: Market operator

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Returns:
      the BT-X-541 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToRoleCode

      public String getLineUltimateShipToRoleCode()
      Returns BT-X-542 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035, for instance:DL: FactorDS: DistributorMOP: Market operator

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Returns:
      the BT-X-542 value
      Since:
      1.09.2/2.5.2
    • getPerPackageUnitQuantity

      public Quantity getPerPackageUnitQuantity()
      Returns BT-X-561 Number of units in a Parent line (BT-X-304) unit — In case of a presence of a ParentLineID, it describes the number of units in a single unit of the ParenltlineID

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PerPackageUnitQuantity

      FR: Nombre d'unité dans une unité de la ligne Parent (BT-X-304) — En cas de présence d'un ParentLineID, il décrit le nombre d'unités dans une seule unité du ParenltlineID.

      Returns:
      the BT-X-561 value
      Since:
      1.09.2/2.5.2
    • getUnitOfMeasure

      public Codes.UnitOfMeasure getUnitOfMeasure()
      Returns BT-X-561-0 Unit of measure.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PerPackageUnitQuantity/@unitCode

      FR: Unité de mesure

      Returns:
      the BT-X-561-0 value
      Since:
      1.09.2/2.5.2
    • getDeliveryTypeCodeForThisLineItem

      public Codes.Incoterms getDeliveryTypeCodeForThisLineItem()
      Returns BT-X-562 DeliveryTypeCode for this line item — The code specifying the type of delivery for these trade delivery terms.

      Usage: To be chosen from the entries in UNTDID 4053 + INCOTERMS List 1 : Delivery arranged by the supplier (Indicates that the supplier will arrange delivery of the goods).2 : Delivery arranged by logistic service provider (Code indicating that the logistic service provider has arranged the delivery of goods).CFR : Cost and Freight (insert named port of destination)CIF : Cost, Insurance and Freight (insert named port of destination)CIP : Carriage and Insurance Paid to (insert named place of destination) CPT : Carriage Paid To (insert named place of destination)DAP : Delivered At Place (insert named place of destination)DAT : Delivered At Terminal (insert named terminal at port or place of destination)DDP : Delivered Duty Paid (insert named place of destination)EXW : Ex Works (insert named place of delivery)FAS : Free Alongside Ship (insert named port of shipment)FCA : Free Carrier (insert named place of delivery)FOB : Free On Board (insert named port of shipment)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:DeliveryTypeCode

      FR: Type de livraison en code pour cette ligne — Code spécifiant le type de livraison pour ces conditions de livraison commerciale.

      Returns:
      the BT-X-562 value
      Since:
      1.09.2/2.5.2
    • getCountryIDOfLocationForTheDeliveryTermsForThisLineItem

      public Codes.CountryCodeList getCountryIDOfLocationForTheDeliveryTermsForThisLineItem()
      Returns BT-X-565 CountryID of location for the delivery terms for this line item — The Country ID of the delivery location

      Usage: From ISO 3166

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:RelevantTradeLocation/ram:CountryID

      FR: Code pays du lieu de livraison pour cette ligne — Lieu de livraison identifié dans les conditions de livraison

      Returns:
      the BT-X-565 value
      Since:
      1.09.2/2.5.2
    • getNameOfLocationForTheDeliveryTermsForThisLineItem

      public String getNameOfLocationForTheDeliveryTermsForThisLineItem()
      Returns BT-X-566 Name of location for the delivery terms for this line item — The name of the delivery location

      Usage: Such as a Port, place of delivery

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:RelevantTradeLocation/ram:Name

      FR: Nom du lieu de livraison pour cette ligne — Lieu de livraison identifié dans les conditions de livraison

      Returns:
      the BT-X-566 value
      Since:
      1.09.2/2.5.2
    • getItemSellerName

      public String getItemSellerName()
      Returns BT-X-569 Seller on line level name — The full formal name by which the Seller on line level is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:Name

      FR: Raison sociale du vendeur à la ligne — Dénomination officielle complète sous laquelle le Vendeur est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.

      Returns:
      the BT-X-569 value
      Since:
      1.09.2/2.5.2
    • getItemSellerRoleCode

      public String getItemSellerRoleCode()
      Returns BT-X-570 Seller on line level Role (code) — A code qualifying the role of the party

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:RoleCode

      FR: Code du röle du Vendeur à le ligne — Un Code pour qualifier le role de la Party

      Returns:
      the BT-X-570 value
      Since:
      1.09.2/2.5.2
    • getItemSellerAdditionalLegalInformation

      public String getItemSellerAdditionalLegalInformation()
      Returns BT-X-571 Seller on line level additional legal information — Additional legal information relevant for the Seller.

      Usage: Such as share capital.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:Description

      FR: Informations juridiques additionnelles sur le vendeur à la ligne — Informations juridiques additionnelles sur le Vendeu à la ligne

      Returns:
      the BT-X-571 value
      Since:
      1.09.2/2.5.2
    • getItemSellerLegalOrganizationIdentifer

      public String getItemSellerLegalOrganizationIdentifer()
      Returns BT-X-572 Seller on line level legal registration identifier — An identifier issued by an official registrar that identifies the Seller on line level as a legal entity or person.

      Usage: If no identification scheme is specified, it must be known by Buyer and Seller.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du vendeur à la ligne — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Vendeur comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-572 value
      Since:
      1.09.2/2.5.2
    • getItemSellerLegalOrganizationSchemeIdentiferAttribute

      public String getItemSellerLegalOrganizationSchemeIdentiferAttribute()
      Returns BT-X-572-0 Scheme identifier — The identification scheme identifier of the Seller on line level legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du vendeur.

      Returns:
      the BT-X-572-0 value
      Since:
      1.09.2/2.5.2
    • getItemSellerLegalOrganizationTradingName

      public String getItemSellerLegalOrganizationTradingName()
      Returns BT-X-573 Seller on line level trading name — A name by which the Seller on line level is known, other than Seller on line level name (also known as Business name).

      Usage: This may be used if different from the Seller name.

      Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Appellation commerciale du vendeur à la ligne — Nom sous lequel le Vendeur est connu, autre que la Raison sociale du vendeur (également appelée Dénomination commerciale).

      Returns:
      the BT-X-573 value
      Since:
      1.09.2/2.5.2
    • getItemSellerPostCode

      public String getItemSellerPostCode()
      Returns BT-X-579 Seller on line level post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal du vendeur à la ligne — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-579 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToPostCode

      public String getLineDeliverToPostCode()
      Returns BT-X-58 PostcodeCode — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de livraison — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-58 value
      Since:
      1.0.06/2.2
    • getItemSellerAddressLine1

      public String getItemSellerAddressLine1()
      Returns BT-X-580 Seller on line level address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse du vendeur à la ligne - Ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-580 value
      Since:
      1.09.2/2.5.2
    • getItemSellerAddressLine2

      public String getItemSellerAddressLine2()
      Returns BT-X-581 Seller on line level address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse du vendeur à la ligne - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-581 value
      Since:
      1.09.2/2.5.2
    • getItemSellerAddressLine3

      public String getItemSellerAddressLine3()
      Returns BT-X-582 Seller on line level address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse du vendeur à la ligne - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-582 value
      Since:
      1.09.2/2.5.2
    • getItemSellerCity

      public String getItemSellerCity()
      Returns BT-X-583 Seller on line level city — The common name of the city, town or village, where the Seller on line level address is located.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité du vendeur à la ligne — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Vendeur.

      Returns:
      the BT-X-583 value
      Since:
      1.09.2/2.5.2
    • getItemSellerCountryCode

      public Codes.CountryCodeList getItemSellerCountryCode()
      Returns BT-X-584 Seller on line level country code — A code that identifies the country.

      Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays du vendeur à la ligne — Code d'identification du pays.

      Returns:
      the BT-X-584 value
      Since:
      1.09.2/2.5.2
    • getItemSellerCountrySubdivision

      public String getItemSellerCountrySubdivision()
      Returns BT-X-585 Seller on line level country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays du vendeur à la ligne — Subdivision d'un pays.

      Returns:
      the BT-X-585 value
      Since:
      1.09.2/2.5.2
    • getItemSellerElectronicAddress

      public String getItemSellerElectronicAddress()
      Returns BT-X-586 Seller on line level electronic address — Identifies the Seller on line level's electronic address to which a business document may be delivered.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du vendeur à la ligne — Identifie l'adresse électronique du Vendeur à laquelle un document commercial peut être transmis.

      Returns:
      the BT-X-586 value
      Since:
      1.09.2/2.5.2
    • getItemSellerElectronicAddressScheme

      public Codes.ElectronicAddressScheme getItemSellerElectronicAddressScheme()
      Returns BT-X-586-0 Scheme identifier — The identification scheme identifier of the Seller on line level electronic address

      Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:ItemSellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma — Identifiant du schéma d'identification de l'adresse électronique du vendeur

      Returns:
      the BT-X-586-0 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToAddressLine1

      public String getLineDeliverToAddressLine1()
      Returns BT-X-59 LineOne — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-59 value
      Since:
      1.0.06/2.2
    • getManufacturerName

      public String getManufacturerName()
      Returns BT-X-595 Manufacturer on line level name — The full formal name by which the Manufacturer on line level is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:Name

      FR: Raison sociale du fabricant — Dénomination officielle complète sous laquelle le fabricant est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.

      Returns:
      the BT-X-595 value
      Since:
      1.09.2/2.5.2
    • getManufacturerRoleCode

      public String getManufacturerRoleCode()
      Returns BT-X-596 Role (code) — A code qualifying the role

      Usage: To be chosen from UNTDID 3035.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:RoleCode

      FR: Rôle (code) — Un code qualifiant le rôle

      Returns:
      the BT-X-596 value
      Since:
      1.09.2/2.5.2
    • getManufacturerAdditionalLegalInformation

      public String getManufacturerAdditionalLegalInformation()
      Returns BT-X-597 Manufacturer additional legal information — Additional legal information relevant for the manufacturer.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:Description

      FR: Informations juridiques additionnelles sur le fabricant — Informations juridiques additionnelles sur le fabricant.

      Returns:
      the BT-X-597 value
      Since:
      1.09.2/2.5.2
    • getManufacturerLegalOrganizationIdentifer

      public String getManufacturerLegalOrganizationIdentifer()
      Returns BT-X-598 Manufacturer legal registration identifier — An identifier issued by an official registrar that identifies the manufacturer as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant d’enregistrement légal du fabricant — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le fabricant comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-598 value
      Since:
      1.09.2/2.5.2
    • getManufacturerLegalOrganizationSchemeIdentiferAttribute

      public String getManufacturerLegalOrganizationSchemeIdentiferAttribute()
      Returns BT-X-598-0 Scheme identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Identifiant d’enregistrement légal de l'acheteur

      Returns:
      the BT-X-598-0 value
      Since:
      1.09.2/2.5.2
    • getManufacturerLegalOrganizationTradingName

      public String getManufacturerLegalOrganizationTradingName()
      Returns BT-X-599 Manufacturer trading name — A name by which the manufacturer is known, other than manufacturer name (also known as Business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Appellation commerciale du fabricant — Nom sous lequel le fabricant est connu, autre que la Raison sociale du fabricant (également appelée Dénomination commerciale).

      Returns:
      the BT-X-599 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToAddressLine2

      public String getLineDeliverToAddressLine2()
      Returns BT-X-60 LineTwo — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-60 value
      Since:
      1.0.06/2.2
    • getManufacturerPostCode

      public String getManufacturerPostCode()
      Returns BT-X-606 Manufacturer on line level post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-606 value
      Since:
      1.09.2/2.5.2
    • getManufacturerAddressLine1

      public String getManufacturerAddressLine1()
      Returns BT-X-607 Manufacturer on line level address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-607 value
      Since:
      1.09.2/2.5.2
    • getManufacturerAddressLine2

      public String getManufacturerAddressLine2()
      Returns BT-X-608 Manufacturer on line level address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-608 value
      Since:
      1.09.2/2.5.2
    • getManufacturerAddressLine3

      public String getManufacturerAddressLine3()
      Returns BT-X-609 Manufacturer on line level address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-609 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToAddressLine3

      public String getLineDeliverToAddressLine3()
      Returns BT-X-61 LineThree — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse de livraison - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-61 value
      Since:
      1.0.06/2.2
    • getManufacturerCity

      public String getManufacturerCity()
      Returns BT-X-610 Manufacturer on line level city — The common name of the city, town or village, where the Manufacturer on line level address is located.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité — Nom usuel de la commune, ville ou village.

      Returns:
      the BT-X-610 value
      Since:
      1.09.2/2.5.2
    • getManufacturerCountryCode

      public Codes.CountryCodeList getManufacturerCountryCode()
      Returns BT-X-611 Manufacturer on line level country code — A code that identifies the country.

      Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code de pays — Code d'identification du pays.

      Returns:
      the BT-X-611 value
      Since:
      1.09.2/2.5.2
    • getManufacturerCountrySubdivision

      public String getManufacturerCountrySubdivision()
      Returns BT-X-612 Manufacturer on line level country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays — Subdivision d'un pays.

      Returns:
      the BT-X-612 value
      Since:
      1.09.2/2.5.2
    • getManufacturerElectronicAddress

      public String getManufacturerElectronicAddress()
      Returns BT-X-613 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique

      Returns:
      the BT-X-613 value
      Since:
      1.09.2/2.5.2
    • getManufacturerElectronicAddressScheme

      public Codes.ElectronicAddressScheme getManufacturerElectronicAddressScheme()
      Returns BT-X-613-0 Scheme identifier.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:ManufacturerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Returns:
      the BT-X-613-0 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToCity

      public String getLineDeliverToCity()
      Returns BT-X-62 CityName — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité de livraison — Nom usuel de la commune, ville ou village.

      Returns:
      the BT-X-62 value
      Since:
      1.0.06/2.2
    • getLineDeliverToCountryCode

      public Codes.CountryCodeList getLineDeliverToCountryCode()
      Returns BT-X-63 CountryID — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code du pays de livraison — Code d'identification du pays.

      Returns:
      the BT-X-63 value
      Since:
      1.0.06/2.2
    • getLineDeliverToCountrySubdivision

      public String getLineDeliverToCountrySubdivision()
      Returns BT-X-64 CountrySubDivisionName — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de livraison — Subdivision d'un pays.

      Returns:
      the BT-X-64 value
      Since:
      1.09.2/2.5.2
    • getLineDeliverToElectronicAddress

      public String getLineDeliverToElectronicAddress()
      Returns BT-X-65 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du lieu de livraison alternatif

      Returns:
      the BT-X-65 value
      Since:
      1.0.06/2.2
    • getLineDeliverToElectronicAddressScheme

      public Codes.ElectronicAddressScheme getLineDeliverToElectronicAddressScheme()
      Returns BT-X-65-0 Scheme identifier.

      Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Returns:
      the BT-X-65-0 value
      Since:
      1.0.06/2.2
    • getLineUltimateShipToIdentifier

      public String getLineUltimateShipToIdentifier()
      Returns BT-X-67 Final recipient identifier.

      Usage: A previously exchanged assigned identifier of the business partner.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:ID

      FR: Identifiant du lieu de livraison final à la ligne

      Returns:
      the BT-X-67 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToName

      public String getLineUltimateShipToName()
      Returns BT-X-69 Final Recipient Name / Company Name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:Name

      FR: Nom du lieu de livraison final

      Returns:
      the BT-X-69 value
      Since:
      1.09.2/2.5.2
    • getLineStatusCode

      public LineStatusCodeContentType getLineStatusCode()
      Returns BT-X-7 LineStatusCode — Indicating whether an item includes the prices which must be taken into account when calculating the invoice amount, or whether it only contains information.

      Usage: Codelist UNTDID 1229

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusCode

      FR: Type de ligne de facture en code — Indique si la ligne contient des prix à prendre dans le modèle de calcul ou seulement des données informatives.

      Returns:
      the BT-X-7 value
      Since:
      1.0.06/2.2
    • getLineUltimateShipToLegalOrganizationIdentifer

      public String getLineUltimateShipToLegalOrganizationIdentifer()
      Returns BT-X-70 Company Registration Number — An identifier issued by an official registrar that identifies the party as a legal entity or person.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

      FR: Identifiant de l'organisation légale du lieu de livraison final — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie la contrepartie comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-70 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToLegalOrganizationSchemeIdentiferAttribute

      public String getLineUltimateShipToLegalOrganizationSchemeIdentiferAttribute()
      Returns BT-X-70-0 Scheme identifier — The identification scheme identifier of the Buyer legal registration identifier.

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): For a SIREN, the value of this field is "0002"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

      FR: Schéma de l'identifiant de l'organisation légale du lieu de livraison alternatif — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.

      Returns:
      the BT-X-70-0 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToLegalOrganizationTradingName

      public String getLineUltimateShipToLegalOrganizationTradingName()
      Returns BT-X-71 Trading Business Name — A name by which the party is known, other than party name (also known as business name).

      Usage: This may be used if different from the party name.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

      FR: Nom commercial du lieu de livraison final — Un nom sous lequel le partenaire commercial est connu, s'il est différent du nom du partenaire commercial (également connu sous le nom de l'entreprise).

      Returns:
      the BT-X-71 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToPostCode

      public String getLineUltimateShipToPostCode()
      Returns BT-X-76 Post code — The identifier for an addressable group of properties according to the relevant postal service.

      Usage: Such as a ZIP code or a post code.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

      FR: Code postal de livraison final — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.

      Returns:
      the BT-X-76 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToAddressLine1

      public String getLineUltimateShipToAddressLine1()
      Returns BT-X-77 Address line 1 — The main address line in an address.

      Usage: Usually the street name and number or post office box.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

      FR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.

      Returns:
      the BT-X-77 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToAddressLine2

      public String getLineUltimateShipToAddressLine2()
      Returns BT-X-78 Address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

      FR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-78 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToAddressLine3

      public String getLineUltimateShipToAddressLine3()
      Returns BT-X-79 Address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

      FR: Adresse de livraison final - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.

      Returns:
      the BT-X-79 value
      Since:
      1.09.2/2.5.2
    • getLineStatusReasonCode

      public String getLineStatusReasonCode()
      Returns BT-X-8 LineStatusReasonCode — Complements the type to clarify whether the invoice item is one of the following: - Detail (default positioning) - Subtotal - Solely information

      Usage: If the LineStatusCode element is used, the LineStatusReasonCode must be filled in: DETAIL, GROUP, INFORMATION

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusReasonCode

      FR: Sous-type de ligne de facture — Complète le type, afin de préciser si la ligne est :- détail (ligne normale)- sous-total- seulement des informations

      Returns:
      the BT-X-8 value
      Since:
      1.0.06/2.2
    • getLineUltimateShipToCity

      public String getLineUltimateShipToCity()
      Returns BT-X-80 City — The common name of the city, town or village.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName

      FR: Localité de livraison finale — Nom usuel de la commune, ville ou village.

      Returns:
      the BT-X-80 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToCountryCode

      public Codes.CountryCodeList getLineUltimateShipToCountryCode()
      Returns BT-X-81 Country code — A code that identifies the country.

      Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

      FR: Code du pays de livraison finale — Code d'identification du pays.

      Returns:
      the BT-X-81 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToCountrySubdivision

      public String getLineUltimateShipToCountrySubdivision()
      Returns BT-X-82 Country subdivision — The subdivision of a country.

      Usage: Such as a region, a county, a state, a province, etc.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionName

      FR: Subdivision du pays de livraison finale — Subdivision d'un pays.

      Returns:
      the BT-X-82 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToElectronicAddress

      public String getLineUltimateShipToElectronicAddress()
      Returns BT-X-83 Electronic address.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

      FR: Adresse électronique du lieu de livraison alternatif

      Returns:
      the BT-X-83 value
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToElectronicAddressScheme

      public Codes.ElectronicAddressScheme getLineUltimateShipToElectronicAddressScheme()
      Returns BT-X-83-0 Scheme identifier.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

      FR: Identifiant du schéma

      Returns:
      the BT-X-83-0 value
      Since:
      1.09.2/2.5.2
    • getDeliveryDateForThisLine

      public LocalDate getDeliveryDateForThisLine()
      Returns BT-X-85 Delivery Date for this line.

      Usage: The VAT relevant date of delivery and achievement must be specified on the level of document.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString

      FR: Date de livraison à la ligne, valeur

      Returns:
      the BT-X-85 value
      Since:
      1.0.06/2.2
    • getFormat

      public Codes.DateFormat getFormat() throws ComputationException
      Returns BT-X-85-0 format — A finite sequence of characters.

      Usage: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-X-85-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getTotalAllowanceAndChargeAmountForThisLine

      public UnitPriceAmount getTotalAllowanceAndChargeAmountForThisLine()
      Returns BT-X-98 Total Allowance AND Charge Amount for this line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TotalAllowanceChargeAmount

      FR: Montant total des remises et charges de ligne

      Returns:
      the BT-X-98 value
      Since:
      1.09.2/2.5.2
    • appendNewInvoiceLineNote

      public InvoiceLineNote appendNewInvoiceLineNote()
      Creates, appends and returns a new InvoiceLineNote (BT-127-00 INVOICE LINE NOTE).
      Returns:
      the new InvoiceLineNote
      Since:
      1.0.06/2.2
    • getInvoiceLineNotes

      public List<InvoiceLineNote> getInvoiceLineNotes()
    • appendNewItemAttributes

      public ItemAttributes appendNewItemAttributes()
      Creates, appends and returns a new ItemAttributes (BG-32 ITEM ATTRIBUTES).
      Returns:
      the new ItemAttributes
      Since:
      1.0.06/2.2
    • getItemAttributes

      public List<ItemAttributes> getItemAttributes()
    • appendNewItemClassificationIdentifier

      public ItemClassificationIdentifier appendNewItemClassificationIdentifier()
      Creates, appends and returns a new ItemClassificationIdentifier (BT-158-00 (ITEM CLASSIFICATION IDENTIFIER)).
      Returns:
      the new ItemClassificationIdentifier
      Since:
      1.0.06/2.2
    • getItemClassificationIdentifiers

      public List<ItemClassificationIdentifier> getItemClassificationIdentifiers()
    • appendNewIndividualTradeProductInstance

      public IndividualTradeProductInstance appendNewIndividualTradeProductInstance()
      Creates, appends and returns a new IndividualTradeProductInstance (BG-X-84 Item (Trade Product) Instances).
      Returns:
      the new IndividualTradeProductInstance
      Since:
      1.0.06/2.2
    • getIndividualTradeProductInstances

      public List<IndividualTradeProductInstance> getIndividualTradeProductInstances()
    • appendNewManufacturerIdentifierSchemeIdentifier

      public ManufacturerIdentifierSchemeIdentifier appendNewManufacturerIdentifierSchemeIdentifier(String manufacturerIdentifierIdentificationSchemeIdentifier, String manufacturerIdentifierSchemeIdentifier)
      Creates, appends and returns a new ManufacturerIdentifierSchemeIdentifier (BT-X-594 Manufacturer on line level on line level identifier (Global ID)).
      Parameters:
      manufacturerIdentifierIdentificationSchemeIdentifier - BT-X-594-0 Manufacturer on line level identifier identification scheme identifier — Scheme identifier

      Usage: The identification scheme identifier shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): In particular, the following codes can be used:0009 : SIRET0021 : SWIFT0060 : DUNS0088 : GLN0177 : ODETTE0231 : SIREN of single Taxable company (France)

      FR: Attribut de l'Identifiant du schéma (si GlobalID)

      manufacturerIdentifierSchemeIdentifier - BT-X-594 Manufacturer on line level on line level identifier (Global ID) — An identification of the Manufacturer on line level.

      Usage: GloablID, if global identifier exists and can be stated in @schemeID, ID else

      Conditions (CIUS): If the Manufacturer on line levelr has a GlobalID, he can qualify it with this attribute. Otherwise, he uses the ID.

      FR: Identifiant global

      Returns:
      the new ManufacturerIdentifierSchemeIdentifier
      Since:
      1.09.2/2.5.2
    • getManufacturerIdentifierSchemeIdentifiers

      public List<ManufacturerIdentifierSchemeIdentifier> getManufacturerIdentifierSchemeIdentifiers()
    • appendNewManufacturer

      public Manufacturer appendNewManufacturer()
      Creates, appends and returns a new Manufacturer (BG-X-94 Detailed contact information of the Manufacturer).
      Returns:
      the new Manufacturer
      Since:
      1.09.2/2.5.2
    • getManufacturers

      public List<Manufacturer> getManufacturers()
    • appendNewDetailedInformationOnTaxInformationOfTheSellerOnLineItemLevel

      public DetailedInformationOnTaxInformationOfTheSellerOnLineItemLevel appendNewDetailedInformationOnTaxInformationOfTheSellerOnLineItemLevel()
    • getDetailedInformationOnTaxInformationOfTheSellerOnLineItemLevels

      public List<DetailedInformationOnTaxInformationOfTheSellerOnLineItemLevel> getDetailedInformationOnTaxInformationOfTheSellerOnLineItemLevels()
    • appendNewDetailedInformationOnTaxInformationOfTheManufacturer

      public DetailedInformationOnTaxInformationOfTheManufacturer appendNewDetailedInformationOnTaxInformationOfTheManufacturer()
    • getDetailedInformationOnTaxInformationOfTheManufacturers

      public List<DetailedInformationOnTaxInformationOfTheManufacturer> getDetailedInformationOnTaxInformationOfTheManufacturers()
    • appendNewIncludedItem

      public IncludedItem appendNewIncludedItem(String nameOfIncludedItem)
      Creates, appends and returns a new IncludedItem (BG-X-1 Included Item).
      Parameters:
      nameOfIncludedItem - BT-X-18 Name of Included Item

      FR: Nom du produit référencé inclus

      Returns:
      the new IncludedItem
      Since:
      1.09.2/2.5.2
    • getIncludedItems

      public List<IncludedItem> getIncludedItems()
    • appendNewReferencedSalesOrderLineReference

      public ReferencedSalesOrderLineReference appendNewReferencedSalesOrderLineReference()
      Creates, appends and returns a new ReferencedSalesOrderLineReference (BG-X-81 (Referenced Sales order line reference)).
      Returns:
      the new ReferencedSalesOrderLineReference
      Since:
      1.09.2/2.5.2
    • getReferencedSalesOrderLineReferences

      public List<ReferencedSalesOrderLineReference> getReferencedSalesOrderLineReferences()
    • appendNewReferencedPurchaseOrderLineReference

      public ReferencedPurchaseOrderLineReference appendNewReferencedPurchaseOrderLineReference()
      Creates, appends and returns a new ReferencedPurchaseOrderLineReference (BT-132-00 (Referenced purchase order line reference)).
      Returns:
      the new ReferencedPurchaseOrderLineReference
      Since:
      1.0.06/2.2
    • getReferencedPurchaseOrderLineReferences

      public List<ReferencedPurchaseOrderLineReference> getReferencedPurchaseOrderLineReferences()
    • appendNewQuotationReferenceDocOnLineLevel

      public QuotationReferenceDocOnLineLevel appendNewQuotationReferenceDocOnLineLevel()
      Creates, appends and returns a new QuotationReferenceDocOnLineLevel (BG-X-47 QUOTATION REFERENCE DOC ON LINE LEVEL).
      Returns:
      the new QuotationReferenceDocOnLineLevel
      Since:
      1.09.2/2.5.2
    • getQuotationReferenceDocOnLineLevels

      public List<QuotationReferenceDocOnLineLevel> getQuotationReferenceDocOnLineLevels()
    • appendNewContractReferenceDocOnLineLevel

      public ContractReferenceDocOnLineLevel appendNewContractReferenceDocOnLineLevel()
      Creates, appends and returns a new ContractReferenceDocOnLineLevel (BG-X-2 CONTRACT REFERENCE DOC ON LINE LEVEL).
      Returns:
      the new ContractReferenceDocOnLineLevel
      Since:
      1.09.2/2.5.2
    • getContractReferenceDocOnLineLevels

      public List<ContractReferenceDocOnLineLevel> getContractReferenceDocOnLineLevels()
    • appendNewAdditionalReferencedDocumentOnLineLevel

      public AdditionalReferencedDocumentOnLineLevel appendNewAdditionalReferencedDocumentOnLineLevel(String documentNumber, Codes.SupportingDocumentTypeCode typeCode)
      Creates, appends and returns a new AdditionalReferencedDocumentOnLineLevel (BG-X-3 ADDITIONAL REFERENCED DOCUMENT ON LINE LEVEL).
      Parameters:
      documentNumber - BT-X-27 Document number

      FR: Identifiant du document

      typeCode - BT-X-30 Type of the document (code)

      FR: Type de document (code)

      Returns:
      the new AdditionalReferencedDocumentOnLineLevel
      Since:
      1.09.2/2.5.2
    • getAdditionalReferencedDocumentOnLineLevels

      public List<AdditionalReferencedDocumentOnLineLevel> getAdditionalReferencedDocumentOnLineLevels()
    • appendNewAppliedTradeAllowanceCharge

      public AppliedTradeAllowanceCharge appendNewAppliedTradeAllowanceCharge(Boolean itemPriceChargeIndicator, UnitPriceAmount itemPriceDiscount)
      Creates, appends and returns a new AppliedTradeAllowanceCharge (BT-147-00 (((Item price discount)))).
      Parameters:
      itemPriceChargeIndicator - BT-147-02 (Item price discount)

      Usage: Price allowance => false

      Rule: Value = false

      FR: (Rabais sur le prix de l'article)

      itemPriceDiscount - BT-147 Item price discount — The total discount subtracted from the Item gross price to calculate the Item net price.

      Usage: Only applies if the discount is provided per unit and if it is not included in the Item gross price.

      FR: Rabais sur le prix de l'article — Remise totale qui, une fois soustraite du Prix brut de l'article, donne le Prix net de l'article.

      Returns:
      the new AppliedTradeAllowanceCharge
      Since:
      1.09.2/2.5.2
    • appendNewAppliedTradeAllowanceCharge

      @Deprecated public AppliedTradeAllowanceCharge appendNewAppliedTradeAllowanceCharge()
      Deprecated.
    • getAppliedTradeAllowanceCharges

      public List<AppliedTradeAllowanceCharge> getAppliedTradeAllowanceCharges()
    • appendNewItemSellerIdentifierSchemeIdentifier

      public ItemSellerIdentifierSchemeIdentifier appendNewItemSellerIdentifierSchemeIdentifier(String itemSellerIdentifierIdentificationSchemeIdentifier, String itemSellerIdentifierSchemeIdentifier)
      Creates, appends and returns a new ItemSellerIdentifierSchemeIdentifier (BT-X-568 Seller on line level on line level identifier (Global ID)).
      Parameters:
      itemSellerIdentifierIdentificationSchemeIdentifier - BT-X-568-0 Seller on line level identifier identification scheme identifier — Scheme identifier

      Usage: The identification scheme identifier shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

      Conditions (CIUS): In particular, the following codes can be used:0009 : SIRET0021 : SWIFT0060 : DUNS0088 : GLN0177 : ODETTE0231 : SIREN of single Taxable company (France)

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant du vendeur.

      itemSellerIdentifierSchemeIdentifier - BT-X-568 Seller on line level on line level identifier (Global ID) — An identification of the Seller on line level.

      Usage: GloablID, if global identifier exists and can be stated in @schemeID, ID else

      Conditions (CIUS): If the seller has a GlobalID, he can qualify it with this attribute. Otherwise, he uses the ID.

      FR: Identifiant du vendeur à la ligne (Global ID) — Identifiant du schéma de l'identifiant global

      Returns:
      the new ItemSellerIdentifierSchemeIdentifier
      Since:
      1.09.2/2.5.2
    • getItemSellerIdentifierSchemeIdentifiers

      public List<ItemSellerIdentifierSchemeIdentifier> getItemSellerIdentifierSchemeIdentifiers()
    • appendNewItemSeller

      public ItemSeller appendNewItemSeller()
      Creates, appends and returns a new ItemSeller (BG-X-91 SELLER ON LINE LEVEL CONTACT).
      Returns:
      the new ItemSeller
      Since:
      1.09.2/2.5.2
    • getItemSellers

      public List<ItemSeller> getItemSellers()
    • appendNewSellerOnLineLevelVATIdentifier

      public SellerOnLineLevelVATIdentifier appendNewSellerOnLineLevelVATIdentifier()
    • getSellerOnLineLevelVATIdentifiers

      public List<SellerOnLineLevelVATIdentifier> getSellerOnLineLevelVATIdentifiers()
    • appendNewSellerOnLineLevelTaxRegistrationIdentifier

      public SellerOnLineLevelTaxRegistrationIdentifier appendNewSellerOnLineLevelTaxRegistrationIdentifier()
    • getSellerOnLineLevelTaxRegistrationIdentifiers

      public List<SellerOnLineLevelTaxRegistrationIdentifier> getSellerOnLineLevelTaxRegistrationIdentifiers()
    • appendNewLineUltimateCustomerOrderReferencedDocument

      public LineUltimateCustomerOrderReferencedDocument appendNewLineUltimateCustomerOrderReferencedDocument()
      Creates, appends and returns a new LineUltimateCustomerOrderReferencedDocument (BG-X-5 ULTIMATE CUSTOMER ORDER REFERENCED DOCUMENT).
      Returns:
      the new LineUltimateCustomerOrderReferencedDocument
      Since:
      1.09.2/2.5.2
    • getLineUltimateCustomerOrderReferencedDocuments

      public List<LineUltimateCustomerOrderReferencedDocument> getLineUltimateCustomerOrderReferencedDocuments()
    • appendNewLineDeliverToIdentifierSchemeIdentifier

      public LineDeliverToIdentifierSchemeIdentifier appendNewLineDeliverToIdentifierSchemeIdentifier(Codes.SchemeIdentifier lineDeliverToIdentifierIdentificationSchemeIdentifier, String lineDeliverToIdentifierSchemeIdentifier)
      Creates, appends and returns a new LineDeliverToIdentifierSchemeIdentifier (BT-186 SHIP TO GlobalID).
      Parameters:
      lineDeliverToIdentifierIdentificationSchemeIdentifier - BT-186-1 schemeID

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      FR: Attribut de l'Identifiant du schéma (si GlobalID)

      lineDeliverToIdentifierSchemeIdentifier - BT-186 SHIP TO GlobalID

      Usage: GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

      FR: Identifiant global du lieu de livraison à la ligne — Identification du lieu de livraison

      Returns:
      the new LineDeliverToIdentifierSchemeIdentifier
      Since:
      1.09.2/2.5.2
    • appendNewLineDeliverToIdentifierSchemeIdentifier

      @Deprecated public LineDeliverToIdentifierSchemeIdentifier appendNewLineDeliverToIdentifierSchemeIdentifier()
      Deprecated.
    • getLineDeliverToIdentifierSchemeIdentifiers

      public List<LineDeliverToIdentifierSchemeIdentifier> getLineDeliverToIdentifierSchemeIdentifiers()
    • appendNewLineDeliverTo

      public LineDeliverTo appendNewLineDeliverTo()
      Creates, appends and returns a new LineDeliverTo (BG-X-8 SHIP TO Contact).
      Returns:
      the new LineDeliverTo
      Since:
      1.0.06/2.2
    • getLineDeliverTos

      public List<LineDeliverTo> getLineDeliverTos()
    • appendNewShipToTaxID

      public ShipToTaxID appendNewShipToTaxID(Codes.SchemeIdentifierAttribute lineDeliverToVATIdentifierSchemeIdentifier, String lineDeliverToVATIdentifier)
      Creates, appends and returns a new ShipToTaxID (BT-X-66-00 SHIP TO TAX ID).
      Parameters:
      lineDeliverToVATIdentifierSchemeIdentifier - BT-X-66-0 Tax Scheme identifier

      Usage: Value = VA (VAT ID)

      Rule: Value = VA

      FR: Type d'identifiant fiscal

      lineDeliverToVATIdentifier - BT-X-66 VAT ID

      FR: Identifiant fiscalIdentifiant à la TVA

      Returns:
      the new ShipToTaxID
      Since:
      1.09.2/2.5.2
    • getShipToTaxIDs

      public List<ShipToTaxID> getShipToTaxIDs()
    • appendNewLineUltimateShipToIdentifierSchemeIdentifier

      public LineUltimateShipToIdentifierSchemeIdentifier appendNewLineUltimateShipToIdentifierSchemeIdentifier(Codes.SchemeIdentifier lineUltimateShipToIdentifierIdentificationSchemeIdentifier, String lineUltimateShipToIdentifierSchemeIdentifier)
      Creates, appends and returns a new LineUltimateShipToIdentifierSchemeIdentifier (BT-X-68 Final recipient global identifier).
      Parameters:
      lineUltimateShipToIdentifierIdentificationSchemeIdentifier - BT-X-68-0 Scheme identifier

      Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

      FR: Attribut de l'Identifiant du schéma (si GlobalID)

      lineUltimateShipToIdentifierSchemeIdentifier - BT-X-68 Final recipient global identifier

      Usage: GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

      FR: Identifiant global du lieu final de livraison à la ligne — Identification du lieu de livraison

      Returns:
      the new LineUltimateShipToIdentifierSchemeIdentifier
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipToIdentifierSchemeIdentifiers

      public List<LineUltimateShipToIdentifierSchemeIdentifier> getLineUltimateShipToIdentifierSchemeIdentifiers()
    • appendNewLineUltimateShipTo

      public LineUltimateShipTo appendNewLineUltimateShipTo()
      Creates, appends and returns a new LineUltimateShipTo (BG-X-11 ULTIMATE SHIP TO Contact).
      Returns:
      the new LineUltimateShipTo
      Since:
      1.09.2/2.5.2
    • getLineUltimateShipTos

      public List<LineUltimateShipTo> getLineUltimateShipTos()
    • appendNewUltimateShipToTaxID

      public UltimateShipToTaxID appendNewUltimateShipToTaxID(Codes.SchemeIdentifierAttribute lineUltimateShipToVATIdentifierSchemeIdentifier, String lineUltimateShipToVATIdentifier)
      Creates, appends and returns a new UltimateShipToTaxID (BT-X-84-00 ULTIMATE SHIP TO Tax ID).
      Parameters:
      lineUltimateShipToVATIdentifierSchemeIdentifier - BT-X-84-0 Tax Scheme identifier

      Usage: Value = VA (VAT ID)

      Rule: Value = VA

      FR: Type d'identifiant fiscal

      lineUltimateShipToVATIdentifier - BT-X-84 VAT ID

      FR: Identifiant fiscal (local)Identifiant à la TVA

      Returns:
      the new UltimateShipToTaxID
      Since:
      1.09.2/2.5.2
    • getUltimateShipToTaxIDs

      public List<UltimateShipToTaxID> getUltimateShipToTaxIDs()
    • appendNewDespatchAdviceReferencedDocumentForThisLine

      public DespatchAdviceReferencedDocumentForThisLine appendNewDespatchAdviceReferencedDocumentForThisLine()
      Creates, appends and returns a new DespatchAdviceReferencedDocumentForThisLine (BG-X-13 DESPATCH ADVICE REFERENCED DOCUMENT FOR THIS LINE).
      Returns:
      the new DespatchAdviceReferencedDocumentForThisLine
      Since:
      1.0.06/2.2
    • getDespatchAdviceReferencedDocumentForThisLines

      public List<DespatchAdviceReferencedDocumentForThisLine> getDespatchAdviceReferencedDocumentForThisLines()
    • appendNewReceivingAdviceReferencedDocumentForThisLine

      public ReceivingAdviceReferencedDocumentForThisLine appendNewReceivingAdviceReferencedDocumentForThisLine()
      Creates, appends and returns a new ReceivingAdviceReferencedDocumentForThisLine (BG-X-82 RECEIVING ADVICE REFERENCED DOCUMENT FOR THIS LINE).
      Returns:
      the new ReceivingAdviceReferencedDocumentForThisLine
      Since:
      1.0.06/2.2
    • getReceivingAdviceReferencedDocumentForThisLines

      public List<ReceivingAdviceReferencedDocumentForThisLine> getReceivingAdviceReferencedDocumentForThisLines()
    • appendNewDeliveryNoteReferencedDocumentForThisLine

      public DeliveryNoteReferencedDocumentForThisLine appendNewDeliveryNoteReferencedDocumentForThisLine()
      Creates, appends and returns a new DeliveryNoteReferencedDocumentForThisLine (BG-X-83 DELIVERY NOTE REFERENCED DOCUMENT FOR THIS LINE).
      Returns:
      the new DeliveryNoteReferencedDocumentForThisLine
      Since:
      1.09.2/2.5.2
    • getDeliveryNoteReferencedDocumentForThisLines

      public List<DeliveryNoteReferencedDocumentForThisLine> getDeliveryNoteReferencedDocumentForThisLines()
    • appendNewLineVATInformation

      public LineVATInformation appendNewLineVATInformation()
      Creates, appends and returns a new LineVATInformation (BG-30 LINE VAT INFORMATION).
      Returns:
      the new LineVATInformation
      Since:
      1.09.2/2.5.2
    • getLineVATInformationList

      public List<LineVATInformation> getLineVATInformationList()
    • appendNewInvoiceLineAllowance

      public InvoiceLineAllowances appendNewInvoiceLineAllowance()
    • getInvoiceLineAllowances

      public List<InvoiceLineAllowances> getInvoiceLineAllowances()
    • appendNewInvoiceLineCharge

      public InvoiceLineCharges appendNewInvoiceLineCharge()
    • getInvoiceLineCharges

      public List<InvoiceLineCharges> getInvoiceLineCharges()
    • appendNewLineTotalTaxAmountInInvoiceCurrency

      public LineTotalTaxAmountInInvoiceCurrency appendNewLineTotalTaxAmountInInvoiceCurrency(Decimal lineTotalTaxAmountInInvoiceCurrency)
      Creates, appends and returns a new LineTotalTaxAmountInInvoiceCurrency (BT-X-329 Line Total Tax amount in invoice currency).
      Parameters:
      lineTotalTaxAmountInInvoiceCurrency - BT-X-329 Line Total Tax amount in invoice currency

      FR: Montant total deTVA en ligne — Montant total de TVA en ligne

      Returns:
      the new LineTotalTaxAmountInInvoiceCurrency
      Since:
      1.09.2/2.5.2
    • getLineTotalTaxAmountInInvoiceCurrencys

      public List<LineTotalTaxAmountInInvoiceCurrency> getLineTotalTaxAmountInInvoiceCurrencys()
    • setNewLineTotalTaxAmountInAccountingCurrency

      public LineTotalTaxAmountInAccountingCurrency setNewLineTotalTaxAmountInAccountingCurrency()
    • getLineTotalTaxAmountInAccountingCurrency

      public LineTotalTaxAmountInAccountingCurrency getLineTotalTaxAmountInAccountingCurrency()
    • appendNewExtendedPrecedingInvoiceReference

      public ExtendedPrecedingInvoiceReference appendNewExtendedPrecedingInvoiceReference()
      Creates, appends and returns a new ExtendedPrecedingInvoiceReference (BG-X-48 PRECEDING INVOICE REFERENCE).
      Returns:
      the new ExtendedPrecedingInvoiceReference
      Since:
      1.0.06/2.2
    • getExtendedPrecedingInvoiceReferences

      public List<ExtendedPrecedingInvoiceReference> getExtendedPrecedingInvoiceReferences()
    • appendNewInvoiceLineObjectIdentifier

      public InvoiceLineObjectIdentifier appendNewInvoiceLineObjectIdentifier(String invoiceLineObjectIdentifier, Codes.InvoiceTypeCode130 typeCode)
      Creates, appends and returns a new InvoiceLineObjectIdentifier (BT-128-00 (Invoice line object identifier)).
      Parameters:
      invoiceLineObjectIdentifier - BT-128 Invoice line object identifier — An identifier for an object on which the invoice line is based, given by the Seller.

      Usage: It may be a subscription number, telephone number, meter point etc., as applicable.

      FR: Identifiant de l'objet à la ligne — Identifiant d'un objet sur lequel la ligne de facturation est basée, attribué par le vendeur.

      typeCode - BT-128-0 0

      Usage: Value = 130

      Rule: Use with TypeCode "130"

      Returns:
      the new InvoiceLineObjectIdentifier
      Since:
      1.09.2/2.5.2
    • appendNewInvoiceLineObjectIdentifier

      @Deprecated public InvoiceLineObjectIdentifier appendNewInvoiceLineObjectIdentifier()
      Deprecated.
    • getInvoiceLineObjectIdentifiers

      public List<InvoiceLineObjectIdentifier> getInvoiceLineObjectIdentifiers()
    • appendNewInvoiceLineBuyerAccountingReference

      public InvoiceLineBuyerAccountingReference appendNewInvoiceLineBuyerAccountingReference(String invoiceLineBuyerAccountingReference)
      Creates, appends and returns a new InvoiceLineBuyerAccountingReference (BT-133-00 (Invoice line Buyer accounting reference)).
      Parameters:
      invoiceLineBuyerAccountingReference - BT-133 Invoice line Buyer accounting reference — A textual value that specifies where to book the relevant data into the Buyer's financial accounts.

      Usage: If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice.

      FR: Référence comptable de l'acheteur — Valeur textuelle spécifiant où imputer les données pertinentes dans les comptes comptables de l'Acheteur.

      Returns:
      the new InvoiceLineBuyerAccountingReference
      Since:
      1.09.2/2.5.2
    • getInvoiceLineBuyerAccountingReferences

      public List<InvoiceLineBuyerAccountingReference> getInvoiceLineBuyerAccountingReferences()
    • addBatchID

      public InvoiceLine addBatchID(String value)
    • getBatchIDs

      public List<String> getBatchIDs()
    • addManufacturerIdentifier

      public InvoiceLine addManufacturerIdentifier(String value)
    • getManufacturerIdentifiers

      public List<String> getManufacturerIdentifiers()
    • addItemSellerIdentifier

      public InvoiceLine addItemSellerIdentifier(String value)
    • getItemSellerIdentifiers

      public List<String> getItemSellerIdentifiers()
    • getItemNetPrice

      public UnitPriceAmount getItemNetPrice() throws ComputationException
      Returns BT-146 Item net price — The price of an item, exclusive of VAT, after subtracting item price discount.

      Usage: The Item net price has to be equal with the Item gross price less the Item price discount.

      Conditions (CIUS): The Item net price MUST NOT be negative

      Rule: BR-26: Each Invoice line (BG-25) shall contain the Item net price (BT-146).BR-27: The Item net price (BT-146) shall NOT be negative.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount

      FR: Prix net de l'article — Prix d'un article, hors TVA, après application du Rabais sur le prix de l'article.

      Returns:
      the BT-146 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed by the API. A value assigned through the corresponding setter is always returned here (and written by toXML()); unlike the other computed fields, recomputation never overrides an explicitly set value.
    • getItemGrossPrice

      public UnitPriceAmount getItemGrossPrice() throws ComputationException
      Returns BT-148 Item gross price — The unit price, exclusive of VAT, before subtracting Item price discount.

      Conditions (CIUS): The Item gross price MUST NOT be negative

      Rule: BR-28: The Item gross price (BT-148) shall NOT be negative.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:ChargeAmount

      FR: Prix brut de l'article — Prix unitaire, hors TVA, avant application du Rabais sur le prix de l'article.

      Returns:
      the BT-148 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed by the API. A value assigned through the corresponding setter is always returned here (and written by toXML()); unlike the other computed fields, recomputation never overrides an explicitly set value.
    • getInvoiceLineNetAmount

      public Amount getInvoiceLineNetAmount() throws ComputationException
      Returns BT-131 Invoice line net amount — The total amount of the Invoice line.

      Usage: The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.

      Rule: BR-24: Each Invoice line (BG-25) shall have an Invoice line net amount (BT-131).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount

      FR: Montant net de ligne de facture — Montant total de la ligne de Facture.

      Returns:
      the BT-131 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed by the API. A value assigned through the corresponding setter is returned here only if Invoice.setRecompute(false) is in effect, or line-amount computation has been disabled (the facturx.computeBT131 system property set to false), at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also what toXML() writes.