java.lang.Object
- com.fourjs.report.facturx.profiles.basic.InvoiceLine

```
public class InvoiceLine
extends Object
```
BG-25:INVOICE LINE
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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InvoiceLineAllowances`	`appendNewInvoiceLineAllowances()`	Creates an InvoiceLineAllowances object and appends it to the list obtainable by a call to get `getInvoiceLineAllowances()`
`Codes.VATCategoryCode`	`getInvoicedItemVATCategoryCode()`	BT-151:Invoiced item VAT category code
`Percentage`	`getInvoicedItemVATRate()`	BT-152:Invoiced item VAT rate
`Quantity`	`getInvoicedQuantity()`	BT-129:Invoiced quantity
`Codes.UnitOfMeasure`	`getInvoicedQuantityUnitOfMeasureCode()`	BT-130:Invoiced quantity unit of measure code
`List<InvoiceLineAllowances>`	`getInvoiceLineAllowances()`	Returns a list of InvoiceLineAllowances objects previously created by calls to `appendNewInvoiceLineAllowances()`
`Identifier`	`getInvoiceLineIdentifier()`	BT-126:Invoice line identifier
`Amount`	`getInvoiceLineNetAmount()`	BT-131:Invoice line net amount
`String`	`getItemName()`	BT-153:Item name
`UnitPriceAmount`	`getItemNetPrice()`	BT-146:Item net price
`Identifier`	`getItemStandardIdentifier()`	BT-157:Item standard identifier
`Quantity`	`getNetItemPriceBaseQuantity()`	BT-149:Item price base quantity
`Codes.UnitOfMeasure`	`getNetItemPriceBaseQuantityUnitOfMeasureCode()`	BT-150:Item price base quantity unit of measure code
`Codes.SchemeIdentifier`	`getSchemeIdentifierForItemStandardIdentifier()`	BT-157-1:Scheme identifier for Item standard identifier
`Codes.VATTypeCode`	`getVATTypeCodeOnLineLevel()`	BT-151-0:VAT type code on line level
`InvoiceLine`	`setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)`
`InvoiceLine`	`setInvoicedItemVATRate(Percentage value)`
`InvoiceLine`	`setInvoicedQuantity(Quantity value)`
`InvoiceLine`	`setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)`
`InvoiceLine`	`setInvoiceLineIdentifier(Identifier value)`
`InvoiceLine`	`setItemName(String value)`
`InvoiceLine`	`setItemNetPrice(UnitPriceAmount value)`
`InvoiceLine`	`setItemStandardIdentifier(Identifier value)`
`InvoiceLine`	`setNetItemPriceBaseQuantity(Quantity value)`
`InvoiceLine`	`setNetItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)`
`InvoiceLine`	`setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - appendNewInvoiceLineAllowances
```
public InvoiceLineAllowances appendNewInvoiceLineAllowances()
```
    Creates an InvoiceLineAllowances object and appends it to the list obtainable by a call to get getInvoiceLineAllowances()
    
    Returns:
    
    InvoiceLineAllowances
  - getInvoiceLineAllowances
```
public List<InvoiceLineAllowances> getInvoiceLineAllowances()
```
    Returns a list of InvoiceLineAllowances objects previously created by calls to appendNewInvoiceLineAllowances()
  - setInvoiceLineIdentifier
```
public InvoiceLine setInvoiceLineIdentifier(Identifier value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setSchemeIdentifierForItemStandardIdentifier
```
public InvoiceLine setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setItemStandardIdentifier
```
public InvoiceLine setItemStandardIdentifier(Identifier value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setItemName
```
public InvoiceLine setItemName(String value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setItemNetPrice
```
public InvoiceLine setItemNetPrice(UnitPriceAmount value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setNetItemPriceBaseQuantityUnitOfMeasureCode
```
public InvoiceLine setNetItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setNetItemPriceBaseQuantity
```
public InvoiceLine setNetItemPriceBaseQuantity(Quantity value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setInvoicedQuantityUnitOfMeasureCode
```
public InvoiceLine setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setInvoicedQuantity
```
public InvoiceLine setInvoicedQuantity(Quantity value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setInvoicedItemVATCategoryCode
```
public InvoiceLine setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - setInvoicedItemVATRate
```
public InvoiceLine setInvoicedItemVATRate(Percentage value)
```
    Parameters:
    
    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
    
    Returns:
    
    InvoiceLine
  - getInvoiceLineIdentifier
```
public Identifier getInvoiceLineIdentifier()
```
    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).
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID
  - getSchemeIdentifierForItemStandardIdentifier
```
public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
```
    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.
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID
  - getItemStandardIdentifier
```
public Identifier getItemStandardIdentifier()
```
    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
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID
  - getItemName
```
public String getItemName()
```
    BT-153:Item name
    A name for an item.
    BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name
  - getItemNetPrice
```
public UnitPriceAmount getItemNetPrice()
```
    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.
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount
  - getNetItemPriceBaseQuantityUnitOfMeasureCode
```
public Codes.UnitOfMeasure getNetItemPriceBaseQuantityUnitOfMeasureCode()
```
    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
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode
  - getNetItemPriceBaseQuantity
```
public Quantity getNetItemPriceBaseQuantity()
```
    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
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity
  - getInvoicedQuantityUnitOfMeasureCode
```
public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
```
    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).
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode
  - getInvoicedQuantity
```
public Quantity getInvoicedQuantity()
```
    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).
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity
  - getVATTypeCodeOnLineLevel
```
public Codes.VATTypeCode getVATTypeCodeOnLineLevel()
```
    BT-151-0:VAT type code on line level
    Value = VAT
    Fixed value "VAT"
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode
  - getInvoicedItemVATCategoryCode
```
public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
```
    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).
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode
  - getInvoicedItemVATRate
```
public Percentage getInvoicedItemVATRate()
```
    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)
    
    Returns:
    
    the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent
  - getInvoiceLineNetAmount
```
public Amount getInvoiceLineNetAmount()
                               throws ComputationException
```
    BT-131:Invoice line net amount
    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).
    
    Returns:
    
    a computed value unless an explicit value has been set and 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 returned
    
    Throws:
    
    ComputationException

Class InvoiceLine

Method Summary

Methods inherited from class java.lang.Object

Method Detail

appendNewInvoiceLineAllowances

getInvoiceLineAllowances

setInvoiceLineIdentifier

setSchemeIdentifierForItemStandardIdentifier

setItemStandardIdentifier

setItemName

setItemNetPrice

setNetItemPriceBaseQuantityUnitOfMeasureCode

setNetItemPriceBaseQuantity

setInvoicedQuantityUnitOfMeasureCode

setInvoicedQuantity

setInvoicedItemVATCategoryCode

setInvoicedItemVATRate

getInvoiceLineIdentifier

getSchemeIdentifierForItemStandardIdentifier

getItemStandardIdentifier

getItemName

getItemNetPrice

getNetItemPriceBaseQuantityUnitOfMeasureCode

getNetItemPriceBaseQuantity

getInvoicedQuantityUnitOfMeasureCode

getInvoicedQuantity

getVATTypeCodeOnLineLevel

getInvoicedItemVATCategoryCode

getInvoicedItemVATRate

getInvoiceLineNetAmount