public class InvoiceLine
extends java.lang.Object
A group of business terms providing information on individual Invoice lines.
BR-16: An Invoice shall have at least one Invoice line (BG-25).
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem
public InvoiceLineAllowances appendNewInvoiceLineAllowances()
getInvoiceLineAllowances()public java.util.List<InvoiceLineAllowances> getInvoiceLineAllowances()
appendNewInvoiceLineAllowances()public InvoiceLine setInvoiceLineIdentifier(Identifier value)
value - BT-126:Invoice line identifier
A unique identifier for the individual line within the Invoice.
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
public InvoiceLine setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)
value - BT-157-1:Scheme identifier for Item standard identifier
Identifiant du schéma de l'identifiant standard de l'article
If used, the identification scheme identifier shall be chosen 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
public InvoiceLine setItemStandardIdentifier(Identifier value)
value - BT-157:Item standard identifier
An item identifier based on a registered scheme.The identification scheme identifier of the Item standard identifier
The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.
CHORUSPRO: this field is limited to 40 characters
BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID
public InvoiceLine setItemName(java.lang.String value)
value - BT-153:Item name
A name for an item.
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
public InvoiceLine setItemNetPrice(UnitPriceAmount value)
value - BT-146:Item net price
The price of an item, exclusive of VAT, after subtracting item price discount.
The Item net price has to be equal with the Item gross price less the Item price discount.
The Item net price MUST NOT be negative
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
public InvoiceLine setNetItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
value - BT-150:Item price base quantity unit of measure code
The unit of measure that applies to the Item price base quantity.
The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).
In particular, the most common units of measurement are:LTR = Liter (1 dm3)MTQ = cubic meterKGM = KilogramMTR = MeterC62 = UnitTNE = Tonne
Must be equal to the value of BT-130 and BT-150-1 if it exists
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode
public InvoiceLine setNetItemPriceBaseQuantity(Quantity value)
value - BT-149:Item price base quantity
The number of item units to which the price applies.
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
public InvoiceLine setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
value - BT-130:Invoiced quantity unit of measure code
The unit of measure that applies to the invoiced quantity.
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).
In particular, the most common units of measurement are:LTR = Liter (1 dm3)MTQ = cubic meterKGM = KilogramMTR = MeterC62 = UnitTNE = Tonne
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
public InvoiceLine setInvoicedQuantity(Quantity value)
value - BT-129:Invoiced quantity
The quantity of items (goods or services) that is charged in the Invoice line.
CHORUS PRO: Invoiced quantity is fulfilled on 10 digits maximum.
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
public InvoiceLine setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)
value - BT-151:Invoiced item VAT category code
The VAT category code for the invoiced item.
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)
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
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
public InvoiceLine setInvoicedItemVATRate(Percentage value)
value - BT-152:Invoiced item VAT rate
The VAT rate, represented as percentage that applies to the invoiced item.
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:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent
public Identifier getInvoiceLineIdentifier()
A unique identifier for the individual line within the Invoice.
BR-21: Each Invoice line (BG-25) shall have an Invoice line identifier (BT-126).
public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
Identifiant du schéma de l'identifiant standard de l'article
If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
public Identifier getItemStandardIdentifier()
An item identifier based on a registered scheme.The identification scheme identifier of the Item standard identifier
The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.
CHORUSPRO: this field is limited to 40 characters
BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier
public java.lang.String getItemName()
A name for an item.
BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).
public UnitPriceAmount getItemNetPrice()
The price of an item, exclusive of VAT, after subtracting item price discount.
The Item net price has to be equal with the Item gross price less the Item price discount.
The Item net price MUST NOT be negative
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.
public Codes.UnitOfMeasure getNetItemPriceBaseQuantityUnitOfMeasureCode()
The unit of measure that applies to the Item price base quantity.
The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).
In particular, the most common units of measurement are:LTR = Liter (1 dm3)MTQ = cubic meterKGM = KilogramMTR = MeterC62 = UnitTNE = Tonne
Must be equal to the value of BT-130 and BT-150-1 if it exists
public Quantity getNetItemPriceBaseQuantity()
The number of item units to which the price applies.
Optional, if filled and if BT-148 is present (EN16931 and EXTENDED profiles), then it should be the same value than BT-149-1
public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
The unit of measure that applies to the invoiced quantity.
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).
In particular, the most common units of measurement are:LTR = Liter (1 dm3)MTQ = cubic meterKGM = KilogramMTR = MeterC62 = UnitTNE = Tonne
BR-23: An Invoice line (BG-25) shall have an Invoiced quantity unit of measure code (BT-130).
public Quantity getInvoicedQuantity()
The quantity of items (goods or services) that is charged in the Invoice line.
CHORUS PRO: Invoiced quantity is fulfilled on 10 digits maximum.
BR-22: Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).
public Codes.VATTypeCode getVATTypeCodeOnLineLevel()
Value = VAT
Fixed value "VAT"
public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
The VAT category code for the invoiced item.
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)
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
BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).
public Percentage getInvoicedItemVATRate()
The VAT rate, represented as percentage that applies to the invoiced item.
The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)
public Amount getInvoiceLineNetAmount() throws ComputationException
The total amount of the Invoice line.
The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.
BR-24: Each Invoice line (BG-25) shall have an Invoice line net amount (BT-131).
Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount is returnedComputationException