com.xero.models.accounting

Class Item

java.lang.Object

com.xero.models.accounting.Item

public class Item
extends Object

Item

Constructor Summary

Constructors

Constructor and Description
Item()

Method Summary

Modifier and Type	Method and Description
Item	code(String code)
Item	description(String description)
boolean	equals(Object o)
String	getCode() User defined item code (max length = 30)
String	getDescription() The sales description of the item (max length = 4000)
String	getInventoryAssetAccountCode() The inventory asset account for the item.
Boolean	getIsPurchased() Boolean value, defaults to true.
Boolean	getIsSold() Boolean value, defaults to true.
Boolean	getIsTrackedAsInventory() True for items that are tracked as inventory.
UUID	getItemID() The Xero identifier for an Item
String	getName() The name of the item (max length = 50)
String	getPurchaseDescription() The purchase description of the item (max length = 4000)
Purchase	getPurchaseDetails() Get purchaseDetails
Float	getQuantityOnHand() The quantity of the item on hand
Purchase	getSalesDetails() Get salesDetails
Float	getTotalCostPool() The value of the item on hand.
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() Last modified date in UTC format
int	hashCode()
Item	inventoryAssetAccountCode(String inventoryAssetAccountCode)
Item	isPurchased(Boolean isPurchased)
Item	isSold(Boolean isSold)
Item	isTrackedAsInventory(Boolean isTrackedAsInventory)
Item	itemID(UUID itemID)
Item	name(String name)
Item	purchaseDescription(String purchaseDescription)
Item	purchaseDetails(Purchase purchaseDetails)
Item	quantityOnHand(Float quantityOnHand)
Item	salesDetails(Purchase salesDetails)
void	setCode(String code)
void	setDescription(String description)
void	setInventoryAssetAccountCode(String inventoryAssetAccountCode)
void	setIsPurchased(Boolean isPurchased)
void	setIsSold(Boolean isSold)
void	setIsTrackedAsInventory(Boolean isTrackedAsInventory)
void	setItemID(UUID itemID)
void	setName(String name)
void	setPurchaseDescription(String purchaseDescription)
void	setPurchaseDetails(Purchase purchaseDetails)
void	setQuantityOnHand(Float quantityOnHand)
void	setSalesDetails(Purchase salesDetails)
void	setTotalCostPool(Float totalCostPool)
void	setUpdatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)
String	toString()
Item	totalCostPool(Float totalCostPool)
Item	updatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item()

Method Detail

code

public Item code(String code)

getCode

public String getCode()

User defined item code (max length = 30)

Returns:

code

setCode

public void setCode(String code)

inventoryAssetAccountCode

public Item inventoryAssetAccountCode(String inventoryAssetAccountCode)

getInventoryAssetAccountCode

public String getInventoryAssetAccountCode()

The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item

Returns:

inventoryAssetAccountCode

setInventoryAssetAccountCode

public void setInventoryAssetAccountCode(String inventoryAssetAccountCode)

name

public Item name(String name)

getName

public String getName()

The name of the item (max length = 50)

Returns:

name

setName

public void setName(String name)

isSold

public Item isSold(Boolean isSold)

getIsSold

public Boolean getIsSold()

Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.

Returns:

isSold

setIsSold

public void setIsSold(Boolean isSold)

isPurchased

public Item isPurchased(Boolean isPurchased)

getIsPurchased

public Boolean getIsPurchased()

Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.

Returns:

isPurchased

setIsPurchased

public void setIsPurchased(Boolean isPurchased)

description

public Item description(String description)

getDescription

public String getDescription()

The sales description of the item (max length = 4000)

Returns:

description

setDescription

public void setDescription(String description)

purchaseDescription

public Item purchaseDescription(String purchaseDescription)

getPurchaseDescription

public String getPurchaseDescription()

The purchase description of the item (max length = 4000)

Returns:

purchaseDescription

setPurchaseDescription

public void setPurchaseDescription(String purchaseDescription)

purchaseDetails

public Item purchaseDetails(Purchase purchaseDetails)

getPurchaseDetails

public Purchase getPurchaseDetails()

Get purchaseDetails

Returns:

purchaseDetails

setPurchaseDetails

public void setPurchaseDetails(Purchase purchaseDetails)

salesDetails

public Item salesDetails(Purchase salesDetails)

getSalesDetails

public Purchase getSalesDetails()

Get salesDetails

Returns:

salesDetails

setSalesDetails

public void setSalesDetails(Purchase salesDetails)

isTrackedAsInventory

public Item isTrackedAsInventory(Boolean isTrackedAsInventory)

getIsTrackedAsInventory

public Boolean getIsTrackedAsInventory()

True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.

Returns:

isTrackedAsInventory

setIsTrackedAsInventory

public void setIsTrackedAsInventory(Boolean isTrackedAsInventory)

totalCostPool

public Item totalCostPool(Float totalCostPool)

getTotalCostPool

public Float getTotalCostPool()

The value of the item on hand. Calculated using average cost accounting.

Returns:

totalCostPool

setTotalCostPool

public void setTotalCostPool(Float totalCostPool)

quantityOnHand

public Item quantityOnHand(Float quantityOnHand)

getQuantityOnHand

public Float getQuantityOnHand()

The quantity of the item on hand

Returns:

quantityOnHand

setQuantityOnHand

public void setQuantityOnHand(Float quantityOnHand)

updatedDateUTC

public Item updatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

Last modified date in UTC format

Returns:

updatedDateUTC

setUpdatedDateUTC

public void setUpdatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

itemID

public Item itemID(UUID itemID)

getItemID

public UUID getItemID()

The Xero identifier for an Item

Returns:

itemID

setItemID

public void setItemID(UUID itemID)

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