Item

Attribute Details

• UIDGuid (36)
• Unique item identifier in the form of a guid.
  ONLY required for updating an existing item.
  NOT required when creating a new item.
• NumberString (30)
• Item number.
• NameString (30)
• Name of the item.
• IsActiveBoolean
• Please note: Defaults to true if left blank on POST.
  True indicates the item is active.
  False indicates the item is inactive.
• DescriptionString (255)
• A description of the item.
• UseDescriptionBoolean
• True indicates to use the description text instead of item name on sale invoices and purchase orders.
  False indicates not to use the item description on sales and purchases.
• CustomList1
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList1 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 1 could be changed to Melbourne, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList1.
• CustomList2
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList2 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 2 could be changed to Sydney, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList2.
• CustomList3
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList3 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 3 could be changed to Tasmania, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList3.
• CustomField1
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField1 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
    For example CustomField # 1 could be changed to South Australia, click here for more information on how to edit labels
  • ValueString (30)
  • Custom field text entry populated for CustomField1.
• CustomField2
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField2 applicable to the custom field text, labels can be edited, for example CustomField # 2 could be changed to Queensland
  • ValueString (30)
  • Custom field text entry populated for CustomField2.
• CustomField3
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField3 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
    For example CustomField # 3 could be changed to ACT, click here for more information on how to edit labels
  • ValueString (30)
  • Custom field text entry populated for CustomField3.
• QuantityOnHandDecimal (13.3)
• Quantity of units held in inventory
• QuantityCommittedDecimal (13.3)
• Quantity of the item held in pending sale invoices.
• QuantityOnOrderDecimal (13.3)
• Quantity of the item held in pending purchase orders.
• QuantityAvailableDecimal (13.3)
• Calculated quantity of the item available for sale.
• AverageCostDecimal (13.6)
• Item's average cost when the quantity on hand is equal to or greater than zero.
• CurrentValueDecimal (13.6)
• Dollar value of units held in inventory.
• BaseSellingPriceDecimal (13.6)
• Item's base selling price inclusive of tax.
• IsBoughtBoolean
• True indicates the item is bought.
  False indicates the item is not bought.
• IsSoldBoolean
• True indicates the item is sold.
  False indicates the item is not sold.
• IsInventoriedBoolean
• True indicates the item is inventoried.
  False indicates the item is not inventoried.
• ExpenseAccount
• The following set of information pulls through details for an Expense account
• • UIDGuid (36)
  • Please note: Passing the Account UID is required if IsBought = true AND IsInventoried = false
    
    Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (60)
  • Account name belonging to the expense account record.
  • DisplayIDString (6)
  • Account code format includes separator ie 6-1100{ 'DisplayID': '6-1100' }
  • URIString
  • Uniform resource identifier associated with the expense account object.
• CostOfSalesAccount
• The following set of information pulls through details for a CostOfSales account
• • UIDGuid (36)
  • Please note: Passing the Account UID is required if IsSold = true AND IsInventoried = true
    
    Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (60)
  • Account name belonging to the cost of sales account record.
  • DisplayIDString (6)
  • Account code format includes separator ie 5-1100{ 'DisplayID': '5-1100' }
  • URIString
  • Uniform resource identifier associated with the cost of sales account object.
• IncomeAccount
• The following set of information pulls through details for an Icome account
• • UIDGuid (36)
  • Please note: Passing the Account UID is required if IsSold = true
    Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (60)
  • Account name belonging to the income account record.
  • DisplayIDString (6)
  • Account code format includes separator ie 4-1100{ 'DisplayID': '4-1100' }
  • URIString
  • Uniform resource identifier associated with the income account object.
• AssetAccount
• The following set of information pulls through details for an Asset account
• • UIDGuid (36)
  • Please note: Passing the Account UID is required if IsInventoried = true
    Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (60)
  • Account name belonging to the asset account record.
  • DisplayIDString (6)
  • Account code format includes separator ie 1-1100{ 'DisplayID': '1-1100' }
  • URIString
  • Uniform resource identifier associated with the asset account object.
• BuyingDetails
• The following set of information pulls through Buying details for an item.
  Note: If IsBought = false null is returned.
• • LastPurchasePriceDecimal (12.6)
  • The item’s tax inclusive price per unit when last purchased.
  • StandardCostDecimal (12.6)
  • Standard purchase price for one buying unit of this item.
  • BuyingUnitOfMeasureString
  • Description of the unit type the item is purchased with, ie: kg, hour.
  • ItemsPerBuyingUnitDecimal
  • Number of items per buying unit.
    Note: if is IsInventoried = false null is returned.
  • TaxCode
  • The following set of information pulls through details for the Tax Code
  • • UID GUID (36)
    • Please note: Only required if IsBought = true
      Foreign Key: Unique tax code identifier in the form of a guid
    • Code String (3)
    • 3 digit code assigned to the tax code.
    • URI String
    • Uniform resource identifier associated with the tax code object.
  • RestockingInformation
  • The following set of information pulls through details for item restocking.
  • • MinimumLevelForRestockingAlertDecimal
    • The minimum number of items on hand before needing to reorder.
    • Supplier
    • The following set of information pulls through details for the Supplier contact assigned for as the Primary supplier for reorders.
    • • UIDGuid (36)
      • Please note: Only required if assigning a default supplier contact for restocking.
        Foreign Key: Unique guid identifier belonging to the supplier contact.
      • NameString (30)
      • Name of the supplier.
      • DisplayIDString (15)
      • Supplier contact Card ID, can also be used as a unique supplier contact identifier.
      • URIString
      • Uniform resource identifier associated with the supplier object.
    • SupplierItemNumberString (30)
    • Number or code supplier has assigned to the item.
    • DefaultOrderQuantityString
    • Default number of units to buy on auto reorder.
• StandardCostTaxInclusiveBoolean
• Returns a True or False value to determine if the Standard Cost includes tax
• SellingDetails
• The following set of information pulls through Selling details for an item.
  Note: If IsSold = false null is returned.
• • BaseSellingPriceDecimal (12.6)
  • Standard selling price for one selling unit of this item.
  • SellingUnitOfMeasureString
  • Description of the unit type the item is sold as, ie: kg, hour.
  • ItemsPerSellingUnitDecimal
  • Number of items per selling unit.
    Note: if is IsInventoried = false null is returned.
  • TaxCode
  • The following set of information pulls through details for the Tax Code
  • • UID GUID (36)
    • Please note: Only required if IsSold = true
      Foreign Key: Unique tax code identifier in the form of a guid
    • Code String (3)
    • 3 digit code assigned to the tax code.
    • URI String
    • Uniform resource identifier associated with the tax code object.
  • IsTaxInclusiveBoolean
  • True indicates the selling prices are inclusive of tax.
    False indicates the selling prices are exclusive of tax
  • CalculateSalesTaxOnString
  • ONLY APPLICABLE FOR AU REGION
    
    Sales tax can be calculated on any of the following Enum values:
    ActualSellingPrice
    BaseSellingPrice
    LevelA
    LevelB
    LevelC
    LevelD
    LevelE
    LevelF
    
  • PriceMatrixURIString
  • Please note: Only available if Item IsSold = true more information on ItemPriceMatrix found here
• LocationDetails []
• An item assigned location(s) information.
• • Location
  • The following set of information pulls through details for the item associated location.
  • • UIDGuid (36)
    • Foreign Key: Unique identifier for location in the form of a guid.
    • IdentifierString (10)
    • Identifier assigned to the location.
    • NameString (30)
    • Name assigned to the location.
    • URIString
    • Uniform resource identifier associated with the location object.
  • QuantityOnHandDecimal (13.3)
  • Quantity of units held in inventory
• DefaultSellLocation
• The following set of information pulls through details for the item associated location./li>
• • UIDGuid (36)
  • Foreign Key: Unique identifier for location in the form of a guid.
  • IdentifierString (10)
  • Identifier assigned to the location.
  • NameString (30)
  • Name assigned to the location.
  • URIString
  • Uniform resource identifier associated with the location object.
• DefaultReceiveLocation
• The following set of information pulls through details for the item associated location./li>
• • UIDGuid (36)
  • Foreign Key: Unique identifier for location in the form of a guid.
  • IdentifierString (10)
  • Identifier assigned to the location.
  • NameString (30)
  • Name assigned to the location.
  • URIString
  • Uniform resource identifier associated with the location object.
• LastModifiedDateTime
• DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
• PhotoURIString
• Uniform resource identifier associated with a photo image.
• URIString
• Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
• RowVersionString
• Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
  ONLY required for updating an existing item.
  NOT required when creating a new item.

Paging: default page size is set to 400 with a maximum of 1000 results.