Package com.xero.models.accounting

Class LineItem

java.lang.Object

com.xero.models.accounting.LineItem

public class LineItem
extends Object

LineItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LineItem.TaxabilityEnum	The type of taxability

Constructor Summary

Constructors

Constructor	Description
LineItem()

Method Summary

Modifier and Type	Method	Description
LineItem	accountCode(String accountCode)	See Accounts
LineItem	accountID(UUID accountID)	The associated account ID related to this line item
LineItem	addTaxBreakdownItem(TaxBreakdownComponent taxBreakdownItem)	An array of tax components defined for this line item
LineItem	addTrackingItem(LineItemTracking trackingItem)	Optional Tracking Category – see Tracking.
LineItem	description(String description)	Description needs to be at least 1 char long.
LineItem	discountAmount(Double discountAmount)	Discount amount being applied to a line item.
LineItem	discountRate(Double discountRate)	Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts
boolean	equals(Object o)
String	getAccountCode()	See Accounts
UUID	getAccountID()	The associated account ID related to this line item
String	getDescription()	Description needs to be at least 1 char long.
Double	getDiscountAmount()	Discount amount being applied to a line item.
Double	getDiscountRate()	Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts
LineItemItem	getItem()	Get item
String	getItemCode()	See Items
Double	getLineAmount()	If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you.
UUID	getLineItemID()	LineItem unique ID
Double	getQuantity()	LineItem Quantity
UUID	getRepeatingInvoiceID()	The Xero identifier for a Repeating Invoice
BigDecimal	getSalesTaxCodeId()	The ID of the sales tax code
LineItem.TaxabilityEnum	getTaxability()	The type of taxability
Double	getTaxAmount()	The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate.
List<TaxBreakdownComponent>	getTaxBreakdown()	An array of tax components defined for this line item
String	getTaxType()	The tax type from TaxRates
List<LineItemTracking>	getTracking()	Optional Tracking Category – see Tracking.
Double	getUnitAmount()	LineItem Unit Amount
int	hashCode()
LineItem	item(LineItemItem item)	item
LineItem	itemCode(String itemCode)	See Items
LineItem	lineAmount(Double lineAmount)	If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you.
LineItem	lineItemID(UUID lineItemID)	LineItem unique ID
LineItem	quantity(Double quantity)	LineItem Quantity
LineItem	repeatingInvoiceID(UUID repeatingInvoiceID)	The Xero identifier for a Repeating Invoice
LineItem	salesTaxCodeId(BigDecimal salesTaxCodeId)	The ID of the sales tax code
void	setAccountCode(String accountCode)	See Accounts
void	setAccountID(UUID accountID)	The associated account ID related to this line item
void	setDescription(String description)	Description needs to be at least 1 char long.
void	setDiscountAmount(Double discountAmount)	Discount amount being applied to a line item.
void	setDiscountRate(Double discountRate)	Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts
void	setItem(LineItemItem item)	item
void	setItemCode(String itemCode)	See Items
void	setLineAmount(Double lineAmount)	If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you.
void	setLineItemID(UUID lineItemID)	LineItem unique ID
void	setQuantity(Double quantity)	LineItem Quantity
void	setRepeatingInvoiceID(UUID repeatingInvoiceID)	The Xero identifier for a Repeating Invoice
void	setSalesTaxCodeId(BigDecimal salesTaxCodeId)	The ID of the sales tax code
void	setTaxability(LineItem.TaxabilityEnum taxability)	The type of taxability
void	setTaxAmount(Double taxAmount)	The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate.
void	setTaxBreakdown(List<TaxBreakdownComponent> taxBreakdown)	An array of tax components defined for this line item
void	setTaxType(String taxType)	The tax type from TaxRates
void	setTracking(List<LineItemTracking> tracking)	Optional Tracking Category – see Tracking.
void	setUnitAmount(Double unitAmount)	LineItem Unit Amount
LineItem	taxability(LineItem.TaxabilityEnum taxability)	The type of taxability
LineItem	taxAmount(Double taxAmount)	The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate.
LineItem	taxBreakdown(List<TaxBreakdownComponent> taxBreakdown)	An array of tax components defined for this line item
LineItem	taxType(String taxType)	The tax type from TaxRates
String	toString()
LineItem	tracking(List<LineItemTracking> tracking)	Optional Tracking Category – see Tracking.
LineItem	unitAmount(Double unitAmount)	LineItem Unit Amount

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LineItem

public LineItem()

Method Details

lineItemID

public LineItem lineItemID(UUID lineItemID)

LineItem unique ID

Parameters:

lineItemID - UUID

Returns:

LineItem

getLineItemID

public UUID getLineItemID()

LineItem unique ID

Returns:

lineItemID

setLineItemID

public void setLineItemID(UUID lineItemID)

LineItem unique ID

Parameters:

lineItemID - UUID

description

public LineItem description(String description)

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character

Parameters:

description - String

Returns:

LineItem

getDescription

public String getDescription()

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character

Returns:

description

setDescription

public void setDescription(String description)

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character

Parameters:

description - String

quantity

public LineItem quantity(Double quantity)

LineItem Quantity

Parameters:

quantity - Double

Returns:

LineItem

getQuantity

public Double getQuantity()

LineItem Quantity

Returns:

quantity

setQuantity

public void setQuantity(Double quantity)

LineItem Quantity

Parameters:

quantity - Double

unitAmount

public LineItem unitAmount(Double unitAmount)

LineItem Unit Amount

Parameters:

unitAmount - Double

Returns:

LineItem

getUnitAmount

public Double getUnitAmount()

LineItem Unit Amount

Returns:

unitAmount

setUnitAmount

public void setUnitAmount(Double unitAmount)

LineItem Unit Amount

Parameters:

unitAmount - Double

itemCode

public LineItem itemCode(String itemCode)

See Items

Parameters:

itemCode - String

Returns:

LineItem

getItemCode

public String getItemCode()

See Items

Returns:

itemCode

setItemCode

public void setItemCode(String itemCode)

See Items

Parameters:

itemCode - String

accountCode

public LineItem accountCode(String accountCode)

See Accounts

Parameters:

accountCode - String

Returns:

LineItem

getAccountCode

public String getAccountCode()

See Accounts

Returns:

accountCode

setAccountCode

public void setAccountCode(String accountCode)

See Accounts

Parameters:

accountCode - String

accountID

public LineItem accountID(UUID accountID)

The associated account ID related to this line item

Parameters:

accountID - UUID

Returns:

LineItem

getAccountID

public UUID getAccountID()

The associated account ID related to this line item

Returns:

accountID

setAccountID

public void setAccountID(UUID accountID)

The associated account ID related to this line item

Parameters:

accountID - UUID

taxType

public LineItem taxType(String taxType)

The tax type from TaxRates

Parameters:

taxType - String

Returns:

LineItem

getTaxType

public String getTaxType()

The tax type from TaxRates

Returns:

taxType

setTaxType

public void setTaxType(String taxType)

The tax type from TaxRates

Parameters:

taxType - String

taxAmount

public LineItem taxAmount(Double taxAmount)

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.

Parameters:

taxAmount - Double

Returns:

LineItem

getTaxAmount

public Double getTaxAmount()

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.

Returns:

taxAmount

setTaxAmount

public void setTaxAmount(Double taxAmount)

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.

Parameters:

taxAmount - Double

item

public LineItem item(LineItemItem item)

item

Parameters:

item - LineItemItem

Returns:

LineItem

getItem

public LineItemItem getItem()

Get item

Returns:

item

setItem

public void setItem(LineItemItem item)

item

Parameters:

item - LineItemItem

lineAmount

public LineItem lineAmount(Double lineAmount)

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

Parameters:

lineAmount - Double

Returns:

LineItem

getLineAmount

public Double getLineAmount()

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

Returns:

lineAmount

setLineAmount

public void setLineAmount(Double lineAmount)

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

Parameters:

lineAmount - Double

tracking

public LineItem tracking(List<LineItemTracking> tracking)

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.

Parameters:

tracking - List<LineItemTracking>

Returns:

LineItem

addTrackingItem

public LineItem addTrackingItem(LineItemTracking trackingItem)

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.

Parameters:

trackingItem - LineItemTracking

Returns:

LineItem

getTracking

public List<LineItemTracking> getTracking()

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.

Returns:

tracking

setTracking

public void setTracking(List<LineItemTracking> tracking)

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.

Parameters:

tracking - List<LineItemTracking>

discountRate

public LineItem discountRate(Double discountRate)

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

Parameters:

discountRate - Double

Returns:

LineItem

getDiscountRate

public Double getDiscountRate()

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

Returns:

discountRate

setDiscountRate

public void setDiscountRate(Double discountRate)

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

Parameters:

discountRate - Double

discountAmount

public LineItem discountAmount(Double discountAmount)

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Parameters:

discountAmount - Double

Returns:

LineItem

getDiscountAmount

public Double getDiscountAmount()

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Returns:

discountAmount

setDiscountAmount

public void setDiscountAmount(Double discountAmount)

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Parameters:

discountAmount - Double

repeatingInvoiceID

public LineItem repeatingInvoiceID(UUID repeatingInvoiceID)

The Xero identifier for a Repeating Invoice

Parameters:

repeatingInvoiceID - UUID

Returns:

LineItem

getRepeatingInvoiceID

public UUID getRepeatingInvoiceID()

The Xero identifier for a Repeating Invoice

Returns:

repeatingInvoiceID

setRepeatingInvoiceID

public void setRepeatingInvoiceID(UUID repeatingInvoiceID)

The Xero identifier for a Repeating Invoice

Parameters:

repeatingInvoiceID - UUID

taxability

public LineItem taxability(LineItem.TaxabilityEnum taxability)

The type of taxability

Parameters:

taxability - TaxabilityEnum

Returns:

LineItem

getTaxability

public LineItem.TaxabilityEnum getTaxability()

The type of taxability

Returns:

taxability

setTaxability

public void setTaxability(LineItem.TaxabilityEnum taxability)

The type of taxability

Parameters:

taxability - TaxabilityEnum

salesTaxCodeId

public LineItem salesTaxCodeId(BigDecimal salesTaxCodeId)

The ID of the sales tax code

Parameters:

salesTaxCodeId - BigDecimal

Returns:

LineItem

getSalesTaxCodeId

public BigDecimal getSalesTaxCodeId()

The ID of the sales tax code

Returns:

salesTaxCodeId

setSalesTaxCodeId

public void setSalesTaxCodeId(BigDecimal salesTaxCodeId)

The ID of the sales tax code

Parameters:

salesTaxCodeId - BigDecimal

taxBreakdown

public LineItem taxBreakdown(List<TaxBreakdownComponent> taxBreakdown)

An array of tax components defined for this line item

Parameters:

taxBreakdown - List<TaxBreakdownComponent>

Returns:

LineItem

addTaxBreakdownItem

public LineItem addTaxBreakdownItem(TaxBreakdownComponent taxBreakdownItem)

An array of tax components defined for this line item

Parameters:

taxBreakdownItem - TaxBreakdownComponent

Returns:

LineItem

getTaxBreakdown

public List<TaxBreakdownComponent> getTaxBreakdown()

An array of tax components defined for this line item

Returns:

taxBreakdown

setTaxBreakdown

public void setTaxBreakdown(List<TaxBreakdownComponent> taxBreakdown)

An array of tax components defined for this line item

Parameters:

taxBreakdown - List<TaxBreakdownComponent>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object