java.lang.Object
- org.mustangproject.Product

All Implemented Interfaces:

IZUGFeRDExportableProduct
```
public class Product
extends java.lang.Object
implements IZUGFeRDExportableProduct
```
describes a product, good or service used in an invoice item line

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.ArrayList<Allowance>`	`allowances`
`protected java.util.HashMap<java.lang.String,java.lang.String>`	`attributes`
`protected java.lang.String`	`buyerAssignedID`
`protected java.util.ArrayList<Charge>`	`charges`
`protected java.util.List<IDesignatedProductClassification>`	`classifications`
`protected java.lang.String`	`countryOfOrigin`
`protected java.lang.String`	`description`
`protected SchemedID`	`globalId`
`protected boolean`	`isIntraCommunitySupply`
`protected boolean`	`isReverseCharge`
`protected java.lang.String`	`name`
`protected java.lang.String`	`sellerAssignedID`
`protected java.lang.String`	`taxCategoryCode`
`protected java.lang.String`	`taxExemptionReason`
`protected java.lang.String`	`unit`
`protected java.math.BigDecimal`	`VATPercent`

Constructor Summary

Constructors
Constructor	Description
`Product()`	empty constructor just for jackson etc
`Product(java.lang.String name, java.lang.String description, java.lang.String unit, java.math.BigDecimal VATPercent)`	default constructor
`Product(org.w3c.dom.Node node)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Product`	`addAllowance(Allowance a)`
`Product`	`addAttribute(java.lang.String name, java.lang.String value)`
`Product`	`addCharge(Charge e)`
`Product`	`addClassification(IDesignatedProductClassification classification)`	Add a `IDesignatedProductClassification` classification
`Product`	`addGlobalID(SchemedID schemedID)`
`Allowance[]`	`getAllowances()`	product level discounts (AppliedTradeAllowanceCharge, will change net price)
`java.util.HashMap<java.lang.String,java.lang.String>`	`getAttributes()`
`java.lang.String`	`getBuyerAssignedID()`	Get the ID that had been assigned by the buyer to identify the product
`Charge[]`	`getCharges()`	returns the AppliedTradeAllowanceCharges of this product which are actually Charges
`IDesignatedProductClassification[]`	`getClassifications()`	Detailed information about the product
`java.lang.String`	`getCountryOfOrigin()`
`java.lang.String`	`getDescription()`	long description of the product
`java.lang.String`	`getGlobalID()`	customer global identification assigned by the seller
`java.lang.String`	`getGlobalIDScheme()`	customer global identification scheme
`java.lang.String`	`getName()`	Short name of the product
`java.lang.String`	`getSellerAssignedID()`	Get the ID that had been assigned by the seller to identify the product
`java.lang.String`	`getTaxCategoryCode()`
`java.lang.String`	`getTaxExemptionReason()`
`java.lang.String`	`getUnit()`	Unit code of the product Most common ones are C62 one (piece) DAY day HAR hectare HUR hour KGM kilogram KTM kilometre KWH kilowatt hour LS lump sum LTR litre MIN minute MMK square millimetre MMT millimetre MTK square metre MTQ cubic metre MTR metre NAR number of articles NPR number of pairs P1 percent SET set TNE tonne (metric ton) WEE week
`java.math.BigDecimal`	`getVATPercent()`	VAT percent of the product (e.g. 19, or 5.1 if you like)
`boolean`	`isIntraCommunitySupply()`
`boolean`	`isReverseCharge()`
`Product`	`setAllowances(java.util.ArrayList<Allowance> allowances)`	Jackson courtesy function, please use addAllowance if you have the choice
`Product`	`setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)`
`Product`	`setBuyerAssignedID(java.lang.String buyerAssignedID)`	if the buyer provided an ID how he refers to this product
`Product`	`setCharges(java.util.ArrayList<Charge> charges)`	Jackson courtesy function, please use addCharge if you have the choice
`Product`	`setClassifications(IDesignatedProductClassification[] classifications)`	Replace the current set of `IDesignatedProductClassification`s with a new set
`Product`	`setClassificationsClass(DesignatedProductClassification[] classifications)`	Provide Jackson a hint as to use DesignatedProductClassification for the IDesignatedProductClassification product classifications
`Product`	`setCountryOfOrigin(java.lang.String countryOfOrigin)`
`Product`	`setDescription(java.lang.String description)`	description of the product (required)
`Product`	`setIntraCommunitySupply()`	sets intra community supply(=delivery outside the country inside the EU)
`Product`	`setName(java.lang.String name)`	name of the product
`Product`	`setReverseCharge()`	sets reverse charge(=delivery to outside EU)
`Product`	`setSellerAssignedID(java.lang.String sellerAssignedID)`	how the seller identifies this type of product
`Product`	`setTaxCategoryCode(java.lang.String code)`
`Product`	`setTaxExemptionReason(java.lang.String taxExemptionReasonText)`
`Product`	`setUnit(java.lang.String unit)`	sets a UN/ECE rec 20 or 21 code which unit the product ships in, e.g.
`Product`	`setVATPercent(java.math.BigDecimal VATPercent)`	VAT rate of the product

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

- Field Detail
  - unit
```
protected java.lang.String unit
```
  - name
```
protected java.lang.String name
```
  - sellerAssignedID
```
protected java.lang.String sellerAssignedID
```
  - buyerAssignedID
```
protected java.lang.String buyerAssignedID
```
  - description
```
protected java.lang.String description
```
  - taxExemptionReason
```
protected java.lang.String taxExemptionReason
```
  - taxCategoryCode
```
protected java.lang.String taxCategoryCode
```
  - VATPercent
```
protected java.math.BigDecimal VATPercent
```
  - isReverseCharge
```
protected boolean isReverseCharge
```
  - isIntraCommunitySupply
```
protected boolean isIntraCommunitySupply
```
  - globalId
```
protected SchemedID globalId
```
  - countryOfOrigin
```
protected java.lang.String countryOfOrigin
```
  - charges
```
protected java.util.ArrayList<Charge> charges
```
  - allowances
```
protected java.util.ArrayList<Allowance> allowances
```
  - attributes
```
protected java.util.HashMap<java.lang.String,java.lang.String> attributes
```
  - classifications
```
protected java.util.List<IDesignatedProductClassification> classifications
```
- Constructor Detail
  - Product
```
public Product(java.lang.String name,
               java.lang.String description,
               java.lang.String unit,
               java.math.BigDecimal VATPercent)
```
    default constructor
    
    Parameters:
    
    name - product short name
    
    description - product long name
    
    unit - a two/three letter UN/ECE rec 20 unit code, e.g. "C62" for piece
    
    VATPercent - product vat rate
  - Product
```
public Product(org.w3c.dom.Node node)
```
  - Product
```
public Product()
```
    empty constructor just for jackson etc
- Method Detail
  - getGlobalID
```
public java.lang.String getGlobalID()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    customer global identification assigned by the seller
    
    Specified by:
    
    getGlobalID in interface IZUGFeRDExportableProduct
    
    Returns:
    
    customer identification
  - getGlobalIDScheme
```
public java.lang.String getGlobalIDScheme()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    customer global identification scheme
    
    Specified by:
    
    getGlobalIDScheme in interface IZUGFeRDExportableProduct
    
    Returns:
    
    customer identification
  - addGlobalID
```
public Product addGlobalID(SchemedID schemedID)
```
  - getTaxExemptionReason
```
public java.lang.String getTaxExemptionReason()
```
    Specified by:
    
    getTaxExemptionReason in interface IZUGFeRDExportableProduct
    
    Returns:
    
    e.g. intra-commnunity supply or small business
  - setTaxExemptionReason
```
public Product setTaxExemptionReason(java.lang.String taxExemptionReasonText)
```
    Parameters:
    
    taxExemptionReasonText - String e.g. Kleinunternehmer gemäß §19 UStG https://github.com/ZUGFeRD/mustangproject/issues/463
    
    Returns:
    
    fluent setter
  - getTaxCategoryCode
```
public java.lang.String getTaxCategoryCode()
```
    Specified by:
    
    getTaxCategoryCode in interface IZUGFeRDExportableProduct
    
    Returns:
    
    e.g. S (normal tax), Z=zero rated, E (e.g. small business) or K (intrra community supply)
  - setTaxCategoryCode
```
public Product setTaxCategoryCode(java.lang.String code)
```
    Parameters:
    
    code - e.g. S (normal tax), Z=zero rated, E (e.g. small business) or K (intrra community supply) see also https://github.com/ZUGFeRD/mustangproject/issues/463
    
    Returns:
    
    fluent setter
  - getSellerAssignedID
```
public java.lang.String getSellerAssignedID()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    Get the ID that had been assigned by the seller to identify the product
    
    Specified by:
    
    getSellerAssignedID in interface IZUGFeRDExportableProduct
    
    Returns:
    
    seller assigned product ID
  - setSellerAssignedID
```
public Product setSellerAssignedID(java.lang.String sellerAssignedID)
```
    how the seller identifies this type of product
    
    Parameters:
    
    sellerAssignedID - a unique String
    
    Returns:
    
    fluent setter
  - getBuyerAssignedID
```
public java.lang.String getBuyerAssignedID()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    Get the ID that had been assigned by the buyer to identify the product
    
    Specified by:
    
    getBuyerAssignedID in interface IZUGFeRDExportableProduct
    
    Returns:
    
    buyer assigned product ID
  - setBuyerAssignedID
```
public Product setBuyerAssignedID(java.lang.String buyerAssignedID)
```
    if the buyer provided an ID how he refers to this product
    
    Parameters:
    
    buyerAssignedID - a string the buyer provided
    
    Returns:
    
    fluent setter
  - isReverseCharge
```
public boolean isReverseCharge()
```
    Specified by:
    
    isReverseCharge in interface IZUGFeRDExportableProduct
  - isIntraCommunitySupply
```
public boolean isIntraCommunitySupply()
```
    Specified by:
    
    isIntraCommunitySupply in interface IZUGFeRDExportableProduct
  - setReverseCharge
```
public Product setReverseCharge()
```
    sets reverse charge(=delivery to outside EU)
    
    Returns:
    
    fluent setter
  - setIntraCommunitySupply
```
public Product setIntraCommunitySupply()
```
    sets intra community supply(=delivery outside the country inside the EU)
    
    Returns:
    
    fluent setter
  - getUnit
```
public java.lang.String getUnit()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    Unit code of the product Most common ones are C62 one (piece) DAY day HAR hectare HUR hour KGM kilogram KTM kilometre KWH kilowatt hour LS lump sum LTR litre MIN minute MMK square millimetre MMT millimetre MTK square metre MTQ cubic metre MTR metre NAR number of articles NPR number of pairs P1 percent SET set TNE tonne (metric ton) WEE week
    
    Specified by:
    
    getUnit in interface IZUGFeRDExportableProduct
    
    Returns:
    
    a UN/ECE rec 20 unit code see https://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex2e.pdf
  - setUnit
```
public Product setUnit(java.lang.String unit)
```
    sets a UN/ECE rec 20 or 21 code which unit the product ships in, e.g. C62=piece
    
    Parameters:
    
    unit - 2-3 letter UN/ECE rec 20 or 21
    
    Returns:
    
    fluent setter
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    Short name of the product
    
    Specified by:
    
    getName in interface IZUGFeRDExportableProduct
    
    Returns:
    
    Short name of the product
  - setName
```
public Product setName(java.lang.String name)
```
    name of the product
    
    Parameters:
    
    name - short name
    
    Returns:
    
    fluent setter
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    long description of the product
    
    Specified by:
    
    getDescription in interface IZUGFeRDExportableProduct
    
    Returns:
    
    long description of the product
  - setDescription
```
public Product setDescription(java.lang.String description)
```
    description of the product (required)
    
    Parameters:
    
    description - long name
    
    Returns:
    
    fluent setter
  - getVATPercent
```
public java.math.BigDecimal getVATPercent()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    VAT percent of the product (e.g. 19, or 5.1 if you like)
    
    Specified by:
    
    getVATPercent in interface IZUGFeRDExportableProduct
    
    Returns:
    
    VAT percent of the product
  - setVATPercent
```
public Product setVATPercent(java.math.BigDecimal VATPercent)
```
    VAT rate of the product
    
    Parameters:
    
    VATPercent - vat rate of the product
    
    Returns:
    
    fluent setter
  - getCountryOfOrigin
```
public java.lang.String getCountryOfOrigin()
```
    Specified by:
    
    getCountryOfOrigin in interface IZUGFeRDExportableProduct
  - setCountryOfOrigin
```
public Product setCountryOfOrigin(java.lang.String countryOfOrigin)
```
  - getAttributes
```
public java.util.HashMap<java.lang.String,java.lang.String> getAttributes()
```
    Specified by:
    
    getAttributes in interface IZUGFeRDExportableProduct
  - setAttributes
```
public Product setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
```
  - addAttribute
```
public Product addAttribute(java.lang.String name,
                            java.lang.String value)
```
  - getClassifications
```
public IDesignatedProductClassification[] getClassifications()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    Detailed information about the product
    
    Specified by:
    
    getClassifications in interface IZUGFeRDExportableProduct
    
    Returns:
    
    an array containing the product classifications or null if not set
  - setClassifications
```
public Product setClassifications(IDesignatedProductClassification[] classifications)
```
    Replace the current set of IDesignatedProductClassifications with a new set
    
    Parameters:
    
    classifications - the new set of classifications
    
    Returns:
    
    the modified object
  - setClassificationsClass
```
public Product setClassificationsClass(DesignatedProductClassification[] classifications)
```
    Provide Jackson a hint as to use DesignatedProductClassification for the IDesignatedProductClassification product classifications
    
    Parameters:
    
    classifications - the new set of classifications
    
    Returns:
    
    fluent setter
  - addClassification
```
public Product addClassification(IDesignatedProductClassification classification)
```
    Add a IDesignatedProductClassification classification
    
    Parameters:
    
    classification - the classification
    
    Returns:
    
    the modified object
  - addCharge
```
public Product addCharge(Charge e)
```
  - addAllowance
```
public Product addAllowance(Allowance a)
```
  - setCharges
```
public Product setCharges(java.util.ArrayList<Charge> charges)
```
    Jackson courtesy function, please use addCharge if you have the choice
    
    Returns:
    
    array of or null, if none
  - getCharges
```
public Charge[] getCharges()
```
    returns the AppliedTradeAllowanceCharges of this product which are actually Charges
    
    Specified by:
    
    getCharges in interface IZUGFeRDExportableProduct
    
    Returns:
    
    array of or null, if none
  - getAllowances
```
public Allowance[] getAllowances()
```
    Description copied from interface: IZUGFeRDExportableProduct
    
    product level discounts (AppliedTradeAllowanceCharge, will change net price)
    
    Specified by:
    
    getAllowances in interface IZUGFeRDExportableProduct
    
    Returns:
    
    array of the discounts on a single product
  - setAllowances
```
public Product setAllowances(java.util.ArrayList<Allowance> allowances)
```
    Jackson courtesy function, please use addAllowance if you have the choice
    
    Returns:
    
    array of or null, if none

Class Product

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unit

name

sellerAssignedID

buyerAssignedID

description

taxExemptionReason

taxCategoryCode

VATPercent

isReverseCharge

isIntraCommunitySupply

globalId

countryOfOrigin

charges

allowances

attributes

classifications

Constructor Detail

Product

Product

Product

Method Detail

getGlobalID

getGlobalIDScheme

addGlobalID

getTaxExemptionReason

setTaxExemptionReason

getTaxCategoryCode

setTaxCategoryCode

getSellerAssignedID

setSellerAssignedID

getBuyerAssignedID

setBuyerAssignedID

isReverseCharge

isIntraCommunitySupply

setReverseCharge

setIntraCommunitySupply

getUnit

setUnit

getName

setName

getDescription

setDescription

getVATPercent

setVATPercent

getCountryOfOrigin

setCountryOfOrigin

getAttributes

setAttributes

addAttribute

getClassifications

setClassifications

setClassificationsClass

addClassification

addCharge

addAllowance

setCharges

getCharges

getAllowances

setAllowances