Item (Library to write, read and validate e-invoices (Factur-X, ZUGFeRD, Order-X, XRechnung/CII) 2.7.0 API)

java.lang.Object
- org.mustangproject.Item

All Implemented Interfaces:

IAbsoluteValueProvider, IZUGFeRDExportableItem
```
public class Item
extends java.lang.Object
implements IZUGFeRDExportableItem
```
describes any invoice line

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<IZUGFeRDAllowanceCharge>`	`Allowances`
`protected java.util.ArrayList<IZUGFeRDAllowanceCharge>`	`Charges`
`protected java.util.Date`	`detailedDeliveryPeriodFrom`
`protected java.util.Date`	`detailedDeliveryPeriodTo`
`protected java.math.BigDecimal`	`grossPrice`
`protected java.lang.String`	`id`
`protected java.math.BigDecimal`	`lineTotalAmount`
`protected java.util.ArrayList<java.lang.String>`	`notes`
`protected java.math.BigDecimal`	`price`
`protected Product`	`product`
`protected java.math.BigDecimal`	`quantity`
`protected java.util.ArrayList<ReferencedDocument>`	`referencedDocuments`
`protected java.lang.String`	`referencedLineID`
`protected java.math.BigDecimal`	`tax`

Constructor Summary

Constructors
Constructor and Description
`Item()` empty constructor do not use, but might be used e.g. by jackson
`Item(Product product, java.math.BigDecimal price, java.math.BigDecimal quantity)` default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Item`	`addAllowance(IZUGFeRDAllowanceCharge izac)` Adds a item level reduction the price (will be multiplied by quantity)
`Item`	`addCharge(IZUGFeRDAllowanceCharge izac)` Adds a item level addition to the price (will be multiplied by quantity)
`Item`	`addNote(java.lang.String text)` adds item level freetext fields (includednote)
`Item`	`addReferencedDocument(ReferencedDocument doc)` adds item level Referenced documents along with their typecodes and issuerassignedIDs
`Item`	`addReferencedLineID(java.lang.String s)`
`java.lang.String`	`getBuyerOrderReferencedDocumentLineID()` BT 132 (issue https://github.com/ZUGFeRD/mustangproject/issues/247)
`java.util.Date`	`getDetailedDeliveryPeriodFrom()` specifies the item level delivery period (there is also one on document level), this will be included in a BillingSpecifiedPeriod element
`java.util.Date`	`getDetailedDeliveryPeriodTo()` specifies the item level delivery period (there is also one on document level), this will be included in a BillingSpecifiedPeriod element
`java.math.BigDecimal`	`getGrossPrice()`
`java.lang.String`	`getId()`
`IZUGFeRDAllowanceCharge[]`	`getItemAllowances()` item level discounts
`IZUGFeRDAllowanceCharge[]`	`getItemCharges()` item level price additions
`java.math.BigDecimal`	`getLineTotalAmount()`
`java.lang.String[]`	`getNotes()` descriptive texts
`java.math.BigDecimal`	`getPrice()` The price of one item excl. taxes
`Product`	`getProduct()`
`java.math.BigDecimal`	`getQuantity()` how many get billed
`IReferencedDocument[]`	`getReferencedDocuments()` allows to specify multiple(!)
`java.math.BigDecimal`	`getTax()`
`Item`	`setDetailedDeliveryPeriod(java.util.Date from, java.util.Date to)` specify a item level delivery period (apart from the document level delivery period, and the document level delivery day, which is probably anyway required)
`Item`	`setGrossPrice(java.math.BigDecimal grossPrice)` the list price without VAT (sic!)
`Item`	`setId(java.lang.String id)`
`Item`	`setLineTotalAmount(java.math.BigDecimal lineTotalAmount)` should only be set by calculator classes or maybe when reading from XML
`Item`	`setPrice(java.math.BigDecimal price)`
`Item`	`setProduct(Product product)`
`Item`	`setQuantity(java.math.BigDecimal quantity)`
`Item`	`setTax(java.math.BigDecimal tax)`

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

Methods inherited from interface org.mustangproject.ZUGFeRD.IZUGFeRDExportableItem
getAdditionalReferencedDocumentID, getBasisQuantity, getItemTotalAllowances, getValue

- Field Detail
  - price
```
protected java.math.BigDecimal price
```
  - quantity
```
protected java.math.BigDecimal quantity
```
  - tax
```
protected java.math.BigDecimal tax
```
  - grossPrice
```
protected java.math.BigDecimal grossPrice
```
  - lineTotalAmount
```
protected java.math.BigDecimal lineTotalAmount
```
  - detailedDeliveryPeriodFrom
```
protected java.util.Date detailedDeliveryPeriodFrom
```
  - detailedDeliveryPeriodTo
```
protected java.util.Date detailedDeliveryPeriodTo
```
  - id
```
protected java.lang.String id
```
  - referencedLineID
```
protected java.lang.String referencedLineID
```
  - product
```
protected Product product
```
  - notes
```
protected java.util.ArrayList<java.lang.String> notes
```
  - referencedDocuments
```
protected java.util.ArrayList<ReferencedDocument> referencedDocuments
```
  - Allowances
```
protected java.util.ArrayList<IZUGFeRDAllowanceCharge> Allowances
```
  - Charges
```
protected java.util.ArrayList<IZUGFeRDAllowanceCharge> Charges
```
- Constructor Detail
  - Item
```
public Item(Product product,
            java.math.BigDecimal price,
            java.math.BigDecimal quantity)
```
    default constructor
    
    Parameters:
    
    product - contains the products name, tax rate, and unit
    
    price - the base price of one item the product
    
    quantity - the number, dimensions or the weight of the delivered product or good in this context
  - Item
```
public Item()
```
    empty constructor do not use, but might be used e.g. by jackson
- Method Detail
  - addReferencedLineID
```
public Item addReferencedLineID(java.lang.String s)
```
  - getBuyerOrderReferencedDocumentLineID
```
public java.lang.String getBuyerOrderReferencedDocumentLineID()
```
    BT 132 (issue https://github.com/ZUGFeRD/mustangproject/issues/247)
    
    Specified by:
    
    getBuyerOrderReferencedDocumentLineID in interface IZUGFeRDExportableItem
    
    Returns:
    
    the line ID of the order (BT132)
  - getLineTotalAmount
```
public java.math.BigDecimal getLineTotalAmount()
```
  - setLineTotalAmount
```
public Item setLineTotalAmount(java.math.BigDecimal lineTotalAmount)
```
    should only be set by calculator classes or maybe when reading from XML
    
    Parameters:
    
    lineTotalAmount - price*quantity of this line
    
    Returns:
    
    fluent setter
  - getGrossPrice
```
public java.math.BigDecimal getGrossPrice()
```
  - setGrossPrice
```
public Item setGrossPrice(java.math.BigDecimal grossPrice)
```
    the list price without VAT (sic!), refer to EN16931-1 for definition
    
    Parameters:
    
    grossPrice - the list price without VAT
    
    Returns:
    
    fluent setter
  - getTax
```
public java.math.BigDecimal getTax()
```
  - setTax
```
public Item setTax(java.math.BigDecimal tax)
```
  - setId
```
public Item setId(java.lang.String id)
```
  - getId
```
public java.lang.String getId()
```
  - getPrice
```
public java.math.BigDecimal getPrice()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    The price of one item excl. taxes
    
    Specified by:
    
    getPrice in interface IZUGFeRDExportableItem
    
    Returns:
    
    The price of one item excl. taxes
  - setPrice
```
public Item setPrice(java.math.BigDecimal price)
```
  - getQuantity
```
public java.math.BigDecimal getQuantity()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    how many get billed
    
    Specified by:
    
    getQuantity in interface IZUGFeRDExportableItem
    
    Returns:
    
    the quantity of the item
  - setQuantity
```
public Item setQuantity(java.math.BigDecimal quantity)
```
  - getProduct
```
public Product getProduct()
```
    Specified by:
    
    getProduct in interface IZUGFeRDExportableItem
  - getItemAllowances
```
public IZUGFeRDAllowanceCharge[] getItemAllowances()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    item level discounts
    
    Specified by:
    
    getItemAllowances in interface IZUGFeRDExportableItem
    
    Returns:
    
    array of the discounts on a single item
  - getItemCharges
```
public IZUGFeRDAllowanceCharge[] getItemCharges()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    item level price additions
    
    Specified by:
    
    getItemCharges in interface IZUGFeRDExportableItem
    
    Returns:
    
    array of the additional charges on the item
  - getNotes
```
public java.lang.String[] getNotes()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    descriptive texts
    
    Specified by:
    
    getNotes in interface IZUGFeRDExportableItem
    
    Returns:
    
    an array of strings of item specific "includedNotes", text values
  - setProduct
```
public Item setProduct(Product product)
```
  - addCharge
```
public Item addCharge(IZUGFeRDAllowanceCharge izac)
```
    Adds a item level addition to the price (will be multiplied by quantity)
    
    Parameters:
    
    izac - a relative or absolute charge
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Charge
  - addAllowance
```
public Item addAllowance(IZUGFeRDAllowanceCharge izac)
```
    Adds a item level reduction the price (will be multiplied by quantity)
    
    Parameters:
    
    izac - a relative or absolute allowance
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Allowance
  - addNote
```
public Item addNote(java.lang.String text)
```
    adds item level freetext fields (includednote)
    
    Parameters:
    
    text - UTF8 plain text
    
    Returns:
    
    fluent setter
  - addReferencedDocument
```
public Item addReferencedDocument(ReferencedDocument doc)
```
    adds item level Referenced documents along with their typecodes and issuerassignedIDs
    
    Parameters:
    
    doc - the ReferencedDocument to add
    
    Returns:
    
    fluent setter
  - getReferencedDocuments
```
public IReferencedDocument[] getReferencedDocuments()
```
    Description copied from interface: IZUGFeRDExportableItem
    
    allows to specify multiple(!) referenced documents along with e.g. their typecodes
    
    Specified by:
    
    getReferencedDocuments in interface IZUGFeRDExportableItem
    
    Returns:
    
    the referenced documents
  - setDetailedDeliveryPeriod
```
public Item setDetailedDeliveryPeriod(java.util.Date from,
                                      java.util.Date to)
```
    specify a item level delivery period (apart from the document level delivery period, and the document level delivery day, which is probably anyway required)
    
    Parameters:
    
    from - start date
    
    to - end date
    
    Returns:
    
    fluent setter
  - getDetailedDeliveryPeriodFrom
```
public java.util.Date getDetailedDeliveryPeriodFrom()
```
    specifies the item level delivery period (there is also one on document level), this will be included in a BillingSpecifiedPeriod element
    
    Specified by:
    
    getDetailedDeliveryPeriodFrom in interface IZUGFeRDExportableItem
    
    Returns:
    
    the beginning of the delivery period
  - getDetailedDeliveryPeriodTo
```
public java.util.Date getDetailedDeliveryPeriodTo()
```
    specifies the item level delivery period (there is also one on document level), this will be included in a BillingSpecifiedPeriod element
    
    Specified by:
    
    getDetailedDeliveryPeriodTo in interface IZUGFeRDExportableItem
    
    Returns:
    
    the end of the delivery period

Class Item

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.mustangproject.ZUGFeRD.IZUGFeRDExportableItem

Field Detail

price

quantity

tax

grossPrice

lineTotalAmount

detailedDeliveryPeriodFrom

detailedDeliveryPeriodTo

id

referencedLineID

product

notes

referencedDocuments

Allowances

Charges

Constructor Detail

Item

Item

Method Detail

addReferencedLineID

getBuyerOrderReferencedDocumentLineID

getLineTotalAmount

setLineTotalAmount

getGrossPrice

setGrossPrice

getTax

setTax

setId

getId

getPrice

setPrice

getQuantity

setQuantity

getProduct

getItemAllowances

getItemCharges

getNotes

setProduct

addCharge

addAllowance

addNote

addReferencedDocument

getReferencedDocuments

setDetailedDeliveryPeriod

getDetailedDeliveryPeriodFrom

getDetailedDeliveryPeriodTo