Invoice (java-en16931 API)

java.lang.Object
- en16931.Invoice

```
public class Invoice
extends java.lang.Object
```
Class to represent an Invoice in EN16931 format.
The EN16931 format is an European Standard that establishes a semantic data model of the core elements of an electronic invoice. The semantic model includes only the essential information elements that an electronic invoice needs to ensure legal (including fiscal) compliance and to enable interoperability for cross-border, cross sector and for domestic trade.

Constructor Summary

Constructors
Constructor and Description

Invoice(java.lang.String invoiceId, java.lang.String currency, boolean importedFromXml)

Constructors
Constructor and Description
`Invoice(java.lang.String invoiceId, java.lang.String currency, boolean importedFromXml)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLine(InvoiceLine line)` Adds an invoice line to the invoice
`java.lang.String`	`dateToString(java.util.Date date)` Returns a string representation of a date in ISO-8601 format.
`Entity`	`getBuyerParty()` Returns the entity playing the role of seller party in the transaction represented by the invoice.
`javax.money.MonetaryAmount`	`getChargeAmount()` Returns the Charge amount of the invoice.
`java.lang.String`	`getChargeBaseAmount()` Returns the Charge base amount of the invoice.
`double`	`getChargePercent()` Returns the Charge percent of the invoice
`javax.money.CurrencyUnit`	`getCurrency()` Returns the currency of the invoice.
`javax.money.MonetaryAmount`	`getDiscountAmount()` Returns the discount amount of the invoice.
`java.lang.String`	`getDiscountBaseAmount()` Returns the discount base amount of the invoice.
`double`	`getDiscountPercent()` Returns the discount percentage of the invoice.
`java.util.Date`	`getDueDate()` Return the due date of the invoice.
`java.lang.String`	`getInvoiceId()` Returns the invoice identifier.
`java.util.Date`	`getIssueDate()` Returns the issued date of the invoice.
`java.lang.String`	`getLineExtensionAmount()` Returns the line extension amount of the invoice.
`java.util.ArrayList<InvoiceLine>`	`getLines()` Returns an ArrayList with the invoice lines
`java.lang.String`	`getOriginalXml()` Returns the original XML if the Invoice was created from an XML file.
`java.lang.String`	`getPayableAmount()` Returns the payable amount of the invoice.
`java.lang.String`	`getPaymentMeansCode()` Returns the payment means code for the transaction represented by the invoice.
`Entity`	`getSellerParty()` Returns the entity playing the role of seller party in the transaction represented by the invoice.
`java.lang.String`	`getStringChargePercent()` Returns a suitabñle string representation of the Charge percent of the invoice.
`java.lang.String`	`getStringDiscountPercent()` Returns a suitable string representation of the discount percentage of the invoice.
`java.lang.String`	`getTaxExclusiveAmount()` Returns the tax exclusive amount of the invoice.
`java.lang.String`	`getTaxInclusiveAmount()` Returns the tax inclusive amount of the invoice.
`javax.money.MonetaryAmount`	`grossSubtotal(Tax tax)` Returns the gross subtotal of the invoice.
`boolean`	`isChargeSet()` Returns true if the invoice has a charge.
`boolean`	`isDiscountSet()` Returns true if the invoice has a discount sent.
`java.util.ArrayList<InvoiceLine>`	`linesWithTaxes(Tax tax)` Returns an ArrayList with all InvoiceLines that have the tax passed as argument.
`java.lang.String`	`moneyToString(javax.money.MonetaryAmount amount)` Returns a suitable string representation of a monetary amount.
`void`	`save(java.lang.String path)` Saves the XML representation of the Invoice to a file.
`void`	`setBuyerParty(Entity buyerParty)` Sets the entity playing the role of seller party in the transaction represented by the invoice.
`void`	`setChargeAmount(double chargeAmount)` Sets the charge amount of the invoice.
`void`	`setChargePercent(double percent)` Sets the Cherge percentage
`void`	`setCurrency(java.lang.String currency)` Sets the currency of the invoice.
`void`	`setDiscountAmount(double discountAmount)` Sets the discount amount of the invoice.
`void`	`setDiscountPercent(double percent)` Sets the dicount percentage of the invoice.
`void`	`setDueDate(java.util.Date dueDate)` Sets the due date of the invoice
`void`	`setInvoiceId(java.lang.String invoiceId)` Sets the invoice identifier.
`void`	`setIssueDate(java.util.Date issueDate)` Sets the issue date of the invoice.
`void`	`setLineExtensionAmount(java.lang.String lineExtensionAmount)` Sets the line extension amount of the invoice.
`void`	`setOriginalXml(java.lang.String originalXml)` Sets the original XML file.
`void`	`setPayableAmount(java.lang.String payableAmount)` Sets the payable amount of the invoice.
`void`	`setPaymentMeansCode(java.lang.String paymentMeansCode)` Sets the payment means code for the transaction represented by the invoice.
`void`	`setSellerParty(Entity sellerParty)` Sets the the entity playing the role of seller party in the transaction represented by the invoice.
`void`	`setTaxExclusiveAmount(java.lang.String taxExclusiveAmount)` Sets the tax exclusive amount of the invoice.
`void`	`setTaxInclusiveAmount(java.lang.String taxInclusiveAmount)` Sets the tax inclusive amount of the invoice.
`javax.money.MonetaryAmount`	`subtotal(Tax tax)` Returns the subtotal of the invoice.
`javax.money.MonetaryAmount`	`taxableBase(Tax tax)` Returns the taxable base of the invoice.
`javax.money.MonetaryAmount`	`taxAmount(Tax tax)` Returns the monetary amount of the invoice.
`javax.money.MonetaryAmount`	`total()` Returns the total for the invoice
`java.lang.String`	`toXml()` Returns the XML representation in EN16931 format of the invoice.
`java.util.ArrayList<Tax>`	`uniqueTaxes()` Returns a HashSet with all taxes in the invoice.

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

- Constructor Detail
  - Invoice
```
public Invoice(java.lang.String invoiceId,
               java.lang.String currency,
               boolean importedFromXml)
```
    Parameters:
    
    invoiceId - the invoice identification
    
    currency - the currency in 3-letter ISO-4217
    
    importedFromXml - whether the invoice was imported from an XML file
- Method Detail
  - getOriginalXml
```
public java.lang.String getOriginalXml()
```
    Returns the original XML if the Invoice was created from an XML file.
    
    Returns:
    
    the original XML file.
  - setOriginalXml
```
public void setOriginalXml(java.lang.String originalXml)
```
    Sets the original XML file.
    
    Parameters:
    
    originalXml - the original XML file as a String.
  - toXml
```
public java.lang.String toXml()
```
    Returns the XML representation in EN16931 format of the invoice.
    
    Returns:
    
    a string with the XML in EN16931 format.
  - save
```
public void save(java.lang.String path)
```
    Saves the XML representation of the Invoice to a file.
    
    Parameters:
    
    path - string with a valid path
  - getInvoiceId
```
public java.lang.String getInvoiceId()
```
    Returns the invoice identifier.
    
    Returns:
    
    the invoice ID.
  - setInvoiceId
```
public void setInvoiceId(java.lang.String invoiceId)
```
    Sets the invoice identifier.
    
    Parameters:
    
    invoiceId - the invoice identification
  - getCurrency
```
public javax.money.CurrencyUnit getCurrency()
```
    Returns the currency of the invoice.
    
    Returns:
    
    the currency of the invoice
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Sets the currency of the invoice.
    
    Parameters:
    
    currency - a three character string representing the invoice in ISO-4217
  - getIssueDate
```
public java.util.Date getIssueDate()
```
    Returns the issued date of the invoice.
    
    Returns:
    
    the issued date
  - setIssueDate
```
public void setIssueDate(java.util.Date issueDate)
```
    Sets the issue date of the invoice.
    
    Parameters:
    
    issueDate - the issue date
  - getDueDate
```
public java.util.Date getDueDate()
```
    Return the due date of the invoice.
    
    Returns:
    
    date the due date of the invoice
  - setDueDate
```
public void setDueDate(java.util.Date dueDate)
```
    Sets the due date of the invoice
    
    Parameters:
    
    dueDate - the due date
  - dateToString
```
public java.lang.String dateToString(java.util.Date date)
```
    Returns a string representation of a date in ISO-8601 format.
    
    Parameters:
    
    date - the date to be converted
    
    Returns:
    
    string the fate in ISO-8601 format.
  - getSellerParty
```
public Entity getSellerParty()
```
    Returns the entity playing the role of seller party in the transaction represented by the invoice.
    
    Returns:
    
    Entity the seller party
  - setSellerParty
```
public void setSellerParty(Entity sellerParty)
```
    Sets the the entity playing the role of seller party in the transaction represented by the invoice.
    
    Parameters:
    
    sellerParty - an Entity
  - getBuyerParty
```
public Entity getBuyerParty()
```
    Returns the entity playing the role of seller party in the transaction represented by the invoice.
    
    Returns:
    
    Entity the buyer party
  - setBuyerParty
```
public void setBuyerParty(Entity buyerParty)
```
    Sets the entity playing the role of seller party in the transaction represented by the invoice.
    
    Parameters:
    
    buyerParty - an Entity
  - getPaymentMeansCode
```
public java.lang.String getPaymentMeansCode()
```
    Returns the payment means code for the transaction represented by the invoice.
    
    Returns:
    
    string the payment means code
  - setPaymentMeansCode
```
public void setPaymentMeansCode(java.lang.String paymentMeansCode)
```
    Sets the payment means code for the transaction represented by the invoice.
    It must be one of:
    - "10": cash
    - "49": debit
    - "31": transfer
    - "26": cheque
    - "23": cheque_b
    - "48": credit
    - "ZZZ": awarding, reposition, special
    Parameters:
    
    paymentMeansCode - the code
  - getLines
```
public java.util.ArrayList<InvoiceLine> getLines()
```
    Returns an ArrayList with the invoice lines
    
    Returns:
    
    an array with a list of the invoice lines
  - addLine
```
public void addLine(InvoiceLine line)
```
    Adds an invoice line to the invoice
    
    Parameters:
    
    line - an InvoiceLine
  - getChargePercent
```
public double getChargePercent()
```
    Returns the Charge percent of the invoice
    
    Returns:
    
    charge percent
  - getStringChargePercent
```
public java.lang.String getStringChargePercent()
```
    Returns a suitabñle string representation of the Charge percent of the invoice.
    
    Returns:
    
    string representation of the charge percent.
  - setChargePercent
```
public void setChargePercent(double percent)
```
    Sets the Cherge percentage
    
    Parameters:
    
    percent - a percentage value
  - getChargeAmount
```
public javax.money.MonetaryAmount getChargeAmount()
```
    Returns the Charge amount of the invoice.
    
    Returns:
    
    the charge amount
  - isChargeSet
```
public boolean isChargeSet()
```
    Returns true if the invoice has a charge.
    
    Returns:
    
    boolean
  - setChargeAmount
```
public void setChargeAmount(double chargeAmount)
```
    Sets the charge amount of the invoice.
    
    Parameters:
    
    chargeAmount - the charge amount
  - getChargeBaseAmount
```
public java.lang.String getChargeBaseAmount()
```
    Returns the Charge base amount of the invoice.
    
    Returns:
    
    charge base amount
  - getDiscountPercent
```
public double getDiscountPercent()
```
    Returns the discount percentage of the invoice.
    
    Returns:
    
    dicount percentage.
  - getStringDiscountPercent
```
public java.lang.String getStringDiscountPercent()
```
    Returns a suitable string representation of the discount percentage of the invoice.
    
    Returns:
    
    string the discpount percentage
  - setDiscountPercent
```
public void setDiscountPercent(double percent)
```
    Sets the dicount percentage of the invoice.
    
    Parameters:
    
    percent - the discount percentage
  - getDiscountAmount
```
public javax.money.MonetaryAmount getDiscountAmount()
```
    Returns the discount amount of the invoice.
    
    Returns:
    
    discount amount
  - isDiscountSet
```
public boolean isDiscountSet()
```
    Returns true if the invoice has a discount sent.
    
    Returns:
    
    boolean
  - setDiscountAmount
```
public void setDiscountAmount(double discountAmount)
```
    Sets the discount amount of the invoice.
    
    Parameters:
    
    discountAmount - the discount amount
  - getDiscountBaseAmount
```
public java.lang.String getDiscountBaseAmount()
```
    Returns the discount base amount of the invoice.
    
    Returns:
    
    string the discount base amount.
  - linesWithTaxes
```
public java.util.ArrayList<InvoiceLine> linesWithTaxes(Tax tax)
```
    Returns an ArrayList with all InvoiceLines that have the tax passed as argument.
    If the tax is null, all lines are returned
    
    Parameters:
    
    tax - a Tax
    
    Returns:
    
    list with all lines with a tax
  - grossSubtotal
```
public javax.money.MonetaryAmount grossSubtotal(Tax tax)
```
    Returns the gross subtotal of the invoice.
    if a Tax is passed as argument, the gross subtotal for all lines with that Tax.
    
    Parameters:
    
    tax - a Tax
    
    Returns:
    
    the gross subtotal of the invoice.
  - taxableBase
```
public javax.money.MonetaryAmount taxableBase(Tax tax)
```
    Returns the taxable base of the invoice.
    if a Tax is passed as argument, returns the taxable base for all lines with that tax.
    
    Parameters:
    
    tax - a Tax
    
    Returns:
    
    taxable base
  - uniqueTaxes
```
public java.util.ArrayList<Tax> uniqueTaxes()
```
    Returns a HashSet with all taxes in the invoice.
    
    Returns:
    
    a set of unique taxes.
  - taxAmount
```
public javax.money.MonetaryAmount taxAmount(Tax tax)
```
    Returns the monetary amount of the invoice.
    if a Tax is passed as argument, the monetary amount for all lines with that Tax
    
    Parameters:
    
    tax - a Tax
    
    Returns:
    
    monetary amount
  - subtotal
```
public javax.money.MonetaryAmount subtotal(Tax tax)
```
    Returns the subtotal of the invoice.
    if a Tax is passed as argument, the subtotal for all lines with that Tax.
    
    Parameters:
    
    tax - a Tax
    
    Returns:
    
    subtotal
  - total
```
public javax.money.MonetaryAmount total()
```
    Returns the total for the invoice
    
    Returns:
    
    total
  - moneyToString
```
public java.lang.String moneyToString(javax.money.MonetaryAmount amount)
```
    Returns a suitable string representation of a monetary amount.
    
    Parameters:
    
    amount - the amount of money to be converted
    
    Returns:
    
    a string representation of a monetary amount
  - getLineExtensionAmount
```
public java.lang.String getLineExtensionAmount()
```
    Returns the line extension amount of the invoice.
    If the Invoice object was imported from an XML this quantity is not computed but extracted directly from the original XML.
    
    Returns:
    
    line extension amount
  - setLineExtensionAmount
```
public void setLineExtensionAmount(java.lang.String lineExtensionAmount)
```
    Sets the line extension amount of the invoice.
    
    Parameters:
    
    lineExtensionAmount - an amount of money
  - getTaxExclusiveAmount
```
public java.lang.String getTaxExclusiveAmount()
```
    Returns the tax exclusive amount of the invoice.
    If the Invoice object was imported from an XML this quantity is not computed but extracted directly from the original XML.
    
    Returns:
    
    tax exclusive amount
  - setTaxExclusiveAmount
```
public void setTaxExclusiveAmount(java.lang.String taxExclusiveAmount)
```
    Sets the tax exclusive amount of the invoice.
    
    Parameters:
    
    taxExclusiveAmount - an amount of money
  - getTaxInclusiveAmount
```
public java.lang.String getTaxInclusiveAmount()
```
    Returns the tax inclusive amount of the invoice.
    If the Invoice object was imported from an XML this quantity is not computed but extracted directly from the original XML.
    
    Returns:
    
    tax inclusive amount
  - setTaxInclusiveAmount
```
public void setTaxInclusiveAmount(java.lang.String taxInclusiveAmount)
```
    Sets the tax inclusive amount of the invoice.
    
    Parameters:
    
    taxInclusiveAmount - an amount of money
  - getPayableAmount
```
public java.lang.String getPayableAmount()
```
    Returns the payable amount of the invoice.
    If the Invoice object was imported from an XML this quantity is not computed but extracted directly from the original XML.
    
    Returns:
    
    payable amount
  - setPayableAmount
```
public void setPayableAmount(java.lang.String payableAmount)
```
    Sets the payable amount of the invoice.
    
    Parameters:
    
    payableAmount - an amount of money

Class Invoice

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invoice

Method Detail

getOriginalXml

setOriginalXml

toXml

save

getInvoiceId

setInvoiceId

getCurrency

setCurrency

getIssueDate

setIssueDate

getDueDate

setDueDate

dateToString

getSellerParty

setSellerParty

getBuyerParty

setBuyerParty

getPaymentMeansCode

setPaymentMeansCode

getLines

addLine

getChargePercent

getStringChargePercent

setChargePercent

getChargeAmount

isChargeSet

setChargeAmount

getChargeBaseAmount

getDiscountPercent

getStringDiscountPercent

setDiscountPercent

getDiscountAmount

isDiscountSet

setDiscountAmount

getDiscountBaseAmount

linesWithTaxes

grossSubtotal

taxableBase

uniqueTaxes

taxAmount

subtotal

total

moneyToString

getLineExtensionAmount

setLineExtensionAmount

getTaxExclusiveAmount

setTaxExclusiveAmount

getTaxInclusiveAmount

setTaxInclusiveAmount

getPayableAmount

setPayableAmount