Class InvoiceLine

java.lang.Object
com.fourjs.report.facturx.profiles.en16931.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-29, BG-30, BG-30-00, BG-31, BT-126-00, BT-129-00, BT-131-00, BT-146-00
Business terms (value fields)BT-126, BT-127, BT-129, BT-130, BT-131, BT-133, BT-134, BT-134-0, BT-135, BT-135-0, BT-146, BT-147, BT-147-02, BT-148, BT-149, BT-149-1, BT-150, BT-150-1, BT-151, BT-151-0, BT-152, BT-153, BT-154, BT-155, BT-156, BT-157, BT-157-1, BT-159
Business groups (object lists)BG-27, BG-28, BG-32, BT-128-00, BT-132-00, BT-158-00

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
    • setInvoiceLineNote

      public InvoiceLine setInvoiceLineNote(String value)
      Sets BT-127 Invoice line note — A textual note that gives unstructured information that is relevant to the Invoice line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:IncludedNote/ram:Content

      FR: Note de ligne de facture — Commentaire fournissant des informations non structurées concernant la ligne de Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.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.

    • setInvoiceLineBuyerAccountingReference

      public InvoiceLine setInvoiceLineBuyerAccountingReference(String value)
      Sets 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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID

      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.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • 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.

    • setItemPriceDiscount

      public InvoiceLine setItemPriceDiscount(UnitPriceAmount value)
      Sets 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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount

      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.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceLine for chaining
      Since:
      1.0.06/2.2
    • 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
    • setInvoicedItemVATCategoryCode

      public InvoiceLine setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)
      Sets BT-151 Invoiced item VAT category code — The VAT category code for the invoiced item.

      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

      Rule: BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode

      FR: Code de type de TVA de l'article facturé — Code de type de TVA applicable à l'article facturé.

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

      public InvoiceLine setInvoicedItemVATRate(Percentage value)
      Sets BT-152 Invoiced item VAT rate — The VAT rate, represented as percentage that applies to the invoiced item.

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

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de l'article facturé — Taux de TVA, exprimé sous forme de pourcentage, applicable à l'article facturé.

      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
    • 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
    • getInvoiceLineNote

      public String getInvoiceLineNote()
      Returns BT-127 Invoice line note — A textual note that gives unstructured information that is relevant to the Invoice line.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:IncludedNote/ram:Content

      FR: Note de ligne de facture — Commentaire fournissant des informations non structurées concernant la ligne de Facture.

      Returns:
      the BT-127 value
      Since:
      1.0.06/2.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
    • getInvoiceLineBuyerAccountingReference

      public String getInvoiceLineBuyerAccountingReference()
      Returns 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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID

      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 BT-133 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
    • getItemPriceDiscount

      public UnitPriceAmount getItemPriceDiscount()
      Returns 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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount

      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 BT-147 value
      Since:
      1.0.06/2.2
    • getItemPriceChargeIndicator

      public Boolean getItemPriceChargeIndicator() throws ComputationException
      Returns BT-147-02 (Item price discount).

      Usage: Price allowance => false

      Rule: Value = false

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator

      FR: (Rabais sur le prix de l'article)

      Returns:
      the BT-147-02 value
      Throws:
      ComputationException
      Since:
      1.09.2/2.5.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.
    • 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
    • getInvoicedItemVATCategoryCode

      public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
      Returns BT-151 Invoiced item VAT category code — The VAT category code for the invoiced item.

      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

      Rule: BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode

      FR: Code de type de TVA de l'article facturé — Code de type de TVA applicable à l'article facturé.

      Returns:
      the BT-151 value
      Since:
      1.0.06/2.2
    • getVATTypeCodeOnLineLevel

      public Codes.VATTypeCode getVATTypeCodeOnLineLevel() throws ComputationException
      Returns BT-151-0 VAT type code on line level — The VAT category code for the invoiced item.

      Usage: For more information on the recommended codes, please refer to subclause 6.3.3.2 - Specification of VAT category codes.Fixed value = "VAT"

      Rule: Fixed value "VAT"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode

      FR: Code de type de TVAInvoiced item VAT category code, Content — The VAT category code for the invoiced item.

      Returns:
      the BT-151-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getInvoicedItemVATRate

      public Percentage getInvoicedItemVATRate()
      Returns BT-152 Invoiced item VAT rate — The VAT rate, represented as percentage that applies to the invoiced item.

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

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de l'article facturé — Taux de TVA, exprimé sous forme de pourcentage, applicable à l'article facturé.

      Returns:
      the BT-152 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
    • appendNewItemAttributes

      public ItemAttributes appendNewItemAttributes(String itemAttributeName, String itemAttributeValue)
      Creates, appends and returns a new ItemAttributes (BG-32 ITEM ATTRIBUTES).
      Parameters:
      itemAttributeName - BT-160 Item attribute name — The name of the attribute or property of the item.

      Usage: Such as "Colour".

      Rule: BR-54: Each Item attribute (BG-32) shall contain an Item attribute name (BT-160) and an Item attribute value (BT-161).

      FR: Nom d'attribut d'article — Nom de l'attribut ou de la propriété de l'article.

      itemAttributeValue - BT-161 Item attribute value — The value of the attribute or property of the item.

      Usage: Such as "Red".

      Rule: BR-54: Each Item attribute (BG-32) shall contain an Item attribute name (BT-160) and an Item attribute value (BT-161).

      FR: Valeur d'attribut d'article — Valeur de l'attribut ou de la propriété de l'article.

      Returns:
      the new ItemAttributes
      Since:
      1.09.2/2.5.2
    • appendNewItemAttributes

      @Deprecated public ItemAttributes appendNewItemAttributes()
      Deprecated.
    • 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()
    • 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()
    • appendNewInvoiceLineAllowance

      public InvoiceLineAllowances appendNewInvoiceLineAllowance()
    • getInvoiceLineAllowances

      public List<InvoiceLineAllowances> getInvoiceLineAllowances()
    • appendNewInvoiceLineCharge

      public InvoiceLineCharges appendNewInvoiceLineCharge()
    • getInvoiceLineCharges

      public List<InvoiceLineCharges> getInvoiceLineCharges()
    • 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()
    • 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.
    • 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.