Item

Return, update, create and delete inventory items.

Date Released: Dec 2013 Date Updated: Sep 2022
URLSupports
/{cf_uri}/Inventory/Item GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials and AccountRight Browser

The elements list below details information for Item. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

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.

Example json GET response

  • {
  • "UID" : "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda",
  • "Number" : "120",
  • "Name" : "Cooler Filter Large",
  • "IsActive" : true,
  • "Description" : "Using the description posted to the API",
  • "UseDescription" : true,
  • "CustomList1" : null,
  • "CustomList2" : null,
  • "CustomList3" : null,
  • "CustomField1" : null,
  • "CustomField2" : null,
  • "CustomField3" : null,
  • "QuantityOnHand" : 133,
  • "QuantityCommitted" : 0,
  • "QuantityOnOrder" : 0,
  • "QuantityAvailable" : 133,
  • "AverageCost" : 45.3924,
  • "CurrentValue" : 6037.19,
  • "BaseSellingPrice" : 67.95,
  • "IsBought" : true,
  • "IsSold" : true,
  • "IsInventoried" : true,
  • "ExpenseAccount" : null,
  • "CostOfSalesAccount" : {
    • "UID" : "59aa54c8-6793-4a63-bda9-55451fa3976e",
    • "Name" : "Inventory Cooler",
    • "DisplayID" : "5-2500",
    • "URI" : "{cf_uri}/GeneralLedger/Account/59aa54c8-6793-4a63-bda9-55451fa3976e"
    • },
  • "IncomeAccount" : {
    • "UID" : "62629f23-a49d-4c6b-9d49-8bcb5bb05e6a",
    • "Name" : "Cooler Filter Income",
    • "DisplayID" : "4-1700",
    • "URI" : "{cf_uri}/GeneralLedger/Account/62629f23-a49d-4c6b-9d49-8bcb5bb05e6a"
    • },
  • "AssetAccount" : {
    • "UID" : "62629f23-a49d-4c6b-9d49-8bcb5bb05e6a",
    • "Name" : "Inventory",
    • "DisplayID" : "1-1400",
    • "URI" : "{cf_uri}/GeneralLedger/Account/e788b7f0-8a1c-4cdb-93cf-4343afedde84"
    • },
  • "BuyingDetails" : {
    • "LastPurchasePrice" : 0,
    • "StandardCost" : 37.99,
    • "BuyingUnitOfMeasure" : "case",
    • "ItemsPerBuyingUnit" : 1,
    • "TaxCode" : {
      • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
      • "Code" : "GST",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      • },
    • "RestockingInformation" : {
      • "MinimumLevelForRestockingAlert" : 4,
      • "Supplier" : {
        • "UID" : "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
        • "Name" : "Huston & Huston Packaging",
        • "DisplayID" : "SUPP000004",
        • "URI" : "{cf_uri}/Contact/Supplier/63b984e5-241e-4c1a-bfe1-7868a69f5e29"
        • },
      • "SupplierItemNumber" : 155,
      • "DefaultOrderQuantity" : 1
      • },
    • "StandardCostTaxInclusive" : true
    • },
  • "SellingDetails" : {
    • "BaseSellingPrice" : 67.95,
    • "SellingUnitOfMeasure" : "case",
    • "ItemsPerBuyingUnit" : 1,
    • "TaxCode" : {
      • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
      • "Code" : "GST",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      • },
    • "IsTaxInclusive" : false,
    • "CalculateSalesTaxOn" : "ActualSellingPrice".
    • "PriceMatrixURI" : "{cf_uri}/Inventory/ItemPriceMatrix/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda"
    • },
  • "LocationDetails" : [
    • {
      • "UID" : "5b854f1f-8921-4ad1-93ee-565b31790334",
      • "Identifier" : "Location1",
      • "Name" : "Primary Location",
      • "URI" : "{cf_uri}Inventory/Location/c7f0a9cd-2a85-4a56-b4de-e74bac885c12"
      • },
    • "QuantityOnHand" : "7.0",
    • }
  • ],
  • "DefaultSellLocation" : {
    • "UID" : "5b854f1f-8921-4ad1-93ee-565b31790334",
    • "Identifier" : "Location1",
    • "Name" : "Primary Location",
    • "URI" : "{cf_uri}Inventory/Location/c7f0a9cd-2a85-4a56-b4de-e74bac885c12"
    • },
  • "DefaultReceiveLocation" : {
    • "UID" : "5b854f1f-8921-4ad1-93ee-565b31790334",
    • "Identifier" : "Location1",
    • "Name" : "Primary Location",
    • "URI" : "{cf_uri}Inventory/Location/c7f0a9cd-2a85-4a56-b4de-e74bac885c12"
    • },
  • "LastModified" : "2019-05-01T00:47:43.757",
  • "PhotoURI" : "{cf_uri}"/Inventory/Item/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda/Photo",
  • "URI" : "{cf_uri}/Inventory/Item/d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda/",
  • "RowVersion" : "-5650610157466419200"
  • }
  • Hypermedia in the MYOB Business API

    The {cf_uri} is provided by the Company File endpoint.

    Read more about Hypermedia in the MYOB Business API in our best practice guide.