Name | Description | Type | Additional information |
---|---|---|---|
Id |
Read-only. Item unique id - auto generated by the system. |
integer |
None. |
Name |
Item Name. Must be unique. |
string |
Required |
ItemNumber |
Item Number. |
string |
None. |
ItemType |
Item Type. Read-only for existing items. Available types: Inventory, Non Inventory, Service, Item Group, Discount, Fixed Asset, and Manufactured. |
IdNamePair |
Required |
Category |
Item Category. |
IdNamePair |
None. |
Division |
Division. |
IdNamePair |
None. |
PreferredVendor |
Preferred Vendor. Available for Inventory and Non Inventory item types only. |
VendorRef |
None. |
Manufacturer |
Manufacturer. Available for Inventory, Non Inventory, and Manufactured item types only. |
VendorRef |
None. |
ManufacturePartNumber |
Manufacturer Part Number. Available for Inventory, Non Inventory, and Manufactured item types only. |
string |
None. |
Description |
Description. Used on transaction line items when item is selected. |
string |
None. |
InternalNotes |
Internal Notes. |
Note |
None. |
Price |
Item Price. Available for Inventory, Non Inventory, Service, and Manufactured item types only. |
decimal number |
None. |
Cost |
Item Cost. Available for Inventory, Non Inventory, Service, and Manufactured item types only. |
decimal number |
None. |
Taxable |
Taxable. Available for Inventory, Non Inventory, Service, Item Group, and Manufactured item types only. |
boolean |
None. |
Weight |
Weight. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only. |
decimal number |
Range: inclusive between 0 and 1.79769313486232E+308 |
IsShippingRequired |
Is Shipping Required. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only. |
boolean |
None. |
ShippingPrice |
Shipping Price. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only. |
decimal number |
None. |
ShippingPerc |
Shipping Perc. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only. |
decimal number |
None. |
IncomeGLAccount |
Income GL Account. Available for Inventory, Non Inventory, Service, Discount, Fixed Asset and Manufactured item types only. The default GL Account will be used if not provided. |
IdNamePair |
None. |
InventoryAssetGLAccount |
Inventory Asset GL Account. Available for Inventory and Manufactured item types only. The default Asset Account will be used if not provided. |
IdNamePair |
None. |
COGSGLAccount |
COGS GL Account. Available for Inventory and Manufactured item types only. The default COGS Account will be used if not provided. |
IdNamePair |
None. |
ExpenseGLAccount |
Expense GL Account. Available for Non Inventory, Service item types only. The default Expense Account will be used if not provided. |
IdNamePair |
None. |
DefaultGLCategory |
Default GL Category. Available for Inventory, Non Inventory, Service, Discount, Fixed Asset and Manufactured item types only. |
IdNamePair |
None. |
DefaultInventoryLocation |
Default Inventory Location. Available for Inventory and Manufactured item types only. |
IdNamePair |
None. |
RelatedAsset |
Related Asset. Available for Fixed Asset item type only. |
IdNamePair |
None. |
AllowVendorToIncludeInBill |
Allow Vendor To Include In Bill. |
boolean |
None. |
ReorderPoint |
Reorder Point. Available for Inventory and Manufactured item types only. |
decimal number |
None. |
ReorderAmount |
Reorder Amount. Available for Inventory and Manufactured item types only. |
decimal number |
None. |
QtyOnHand |
Read-only. Available for Inventory and Manufactured item types only. The quantity is calculated as of today and is not location specific. |
decimal number |
None. |
QtyAvailable |
Read-only. Available for Inventory and Manufactured item types only. The quantity is calculated as of today and is not location specific. |
decimal number |
None. |
BaseUnitOfMeasure |
Read-only. Base Unit of Measure. Available for Inventory, Non-Inventory, Service, Fixed Asset, Manufactured, and Deposit item types and only applicable if Unit of Measure tracking is enabled Id: Base Unit of Measure Id of the Unit of Measure set configured at the item level Name: Base Unit of Measure Abbreviation ExtendedName: Base Unit of Measure full name |
LongIdNameExtended |
None. |
BarcodeValue |
Barcode value. Must be unique. |
string |
None. |
MaxQuantity |
Max Quantity to stock. Available for Inventory and Manufactured item types only. |
decimal number |
None. |
GroupItems |
Component items of the group. Available for Item Group and Manufactured item types only. |
Collection of GroupItem |
None. |
CustomFields |
Item Custom Fields. |
Collection of CustomField |
None. |
Active |
Read-only. Indicates whether the item is active or not. |
boolean |
None. |
DateCreated |
Read-only. The date and time (in company time zone) when the item was created. |
date |
None. |
CreatedBy |
The person who created the item. |
IdNamePair |
None. |
LastUpdatedDate |
Read-only. The date and time (in company time zone) when the bill was last updated. |
date |
None. |
LastUpdatedBy |
The person who last updated the item. |
IdNamePair |
None. |