itemresponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-itemresponse-schema.json",
  "title": "itemresponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-item-api-openapi.yml#/components/schemas/itemresponse",
  "type": "object",
  "properties": {
    "Sku": {
      "type": "string",
      "description": "The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true
    },
    "SalesTaxIncluded": {
      "type": "boolean",
      "description": "True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "false"
    },
    "TrackQtyOnHand": {
      "type": "boolean",
      "description": "True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory.\n Not applicable for Service or NonInventory item types.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "false"
    },
    "SalesTaxCodeRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "For non-US companies only. Reference to the sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for SalesTaxCodeRef.value and SalesTaxCodeRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "CustomExtensions": {
      "allOf": [
        {
          "$ref": "#/$defs/customextensions"
        }
      ],
      "description": "Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION. The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.",
      "x-intuit-required": "Optional"
    },
    "Source": {
      "type": "string",
      "description": "The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce",
      "x-intuit-required": "Optional"
    },
    "InvStartDate": {
      "type": "string",
      "format": "date",
      "description": "Date of opening balance for the inventory transaction.\nFor read operations, the date returned in this field is always the originally provided inventory start date.\nFor update operations, the date supplied is interpreted as the inventory adjust date, is stored as such in the underlying data model, and is reflected in the QuickBooks Online UI for the object. The inventory adjust date is not exposed for read operations through the API. Required for Inventory type items.",
      "x-intuit-required": "Conditionally required"
    },
    "Type": {
      "type": "string",
      "description": "Classification that specifies the use of this item. See the description at the top of the Item entity page for details about supported item types.\nThis field is required to be explicitly set with one of the following:\nInventory--Used for goods the company sells and buys that are tracked as inventory. \n\nService--Used for non-tangible goods the company sells and buys that are not tracked as inventory. For example, specialized labor, consulting hours, and professional fees.\n\nNonInventory--Use for goods the company sells and buys that are not tracked as inventory. For example, office supplies or goods bought on behalf of the customer.\n\n.",
      "x-intuit-required": "Conditionally required",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "PurchaseTaxIncluded": {
      "type": "boolean",
      "description": "True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "False"
    },
    "FullyQualifiedName": {
      "type": "string",
      "description": "Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of\nItem:SubItem. Returned from an existing object and not input on a new object.Limited to 5 levels.",
      "x-intuit-filterable": true
    },
    "Description": {
      "type": "string",
      "description": "Description of the item.",
      "x-intuit-required": "Optional"
    },
    "SubItem": {
      "type": "boolean",
      "description": "If true, this is a sub item. If false or null, this is a top-level item.\nCreating inventory hierarchies with traditional inventory items is being phased out in lieu of using categories and sub categories.",
      "x-intuit-required": "Optional"
    },
    "Taxable": {
      "type": "boolean",
      "description": "If true, transactions for this item are taxable. Applicable to US companies, only.",
      "x-intuit-required": "Optional"
    },
    "ReorderPoint": {
      "type": "number",
      "description": "The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates.",
      "x-intuit-required": "Optional"
    },
    "PurchaseDesc": {
      "type": "string",
      "description": "Purchase description for the item.",
      "x-intuit-required": "Optional"
    },
    "MetaData": {
      "allOf": [
        {
          "$ref": "#/$defs/modificationmetadata"
        }
      ],
      "description": "Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    },
    "PrefVendorRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the preferred vendor of this item. Query the Vendor name list resource to determine the appropriate object for this reference. Use Vendor.Id and Vendor.Name from that object for ParentRef.value and ParentRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "Name": {
      "type": "string",
      "description": "Name of the item. This value is unique.",
      "x-intuit-required": "Required",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "Level": {
      "type": "integer",
      "description": "Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be the next level with respect to the parent. Limited to 5 levels.",
      "x-intuit-default": "0"
    },
    "IncomeAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for IncomeAccountRef.value and IncomeAccountRef.name, respectively. Required for Inventory and Service item types.",
      "x-intuit-required": "Conditionally Required"
    },
    "Active": {
      "type": "boolean",
      "description": "If true, the object is currently enabled for use by QuickBooks.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "true",
      "x-intuit-filterable": true
    },
    "ClassRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the Class for the item. Query the Class name list resource to determine the appropriate object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "ExpenseAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for ExpenseAccountRef.value and ExpenseAccountRef.name, respectively. Required for Inventory, NonInventory, and Service item types."
    },
    "TaxClassificationRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Tax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in Malaysia or externally like Exactor. 'Fuel', 'Garments' and 'Soft drinks' are a few examples of tax classification in layman terms. User can choose a specific tax classification for an item while creating it. A level 1 tax classification cannot be associated to an Item."
    },
    "PurchaseTaxCodeRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for PurchaseTaxCodeRef.value and PurchaseTaxCodeRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "SyncToken": {
      "type": "string",
      "description": "Version number of the entity.\nRequired for the update operation.",
      "x-intuit-required": "Required for update"
    },
    "PurchaseCost": {
      "type": "number",
      "description": "Amount paid when buying or ordering the item, as expressed in the home currency.",
      "x-intuit-required": "Optional"
    },
    "QtyOnHand": {
      "type": "number",
      "description": "Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items.",
      "x-intuit-required": "Conditionally required"
    },
    "AssetAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for AssetAccountRef.value and AssetAccountRef.name, respectively. Required for Inventory item types.",
      "x-intuit-required": "Conditionally required"
    },
    "ParentRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "The immediate parent of the sub item in the hierarchical Item:SubItem list. If SubItem is true, then ParenRef is required. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use Item.Id and Item.Name from that object for ParentRef.value and ParentRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "UnitPrice": {
      "type": "number",
      "description": "Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item.\nIf used for unit price, the monetary value of the service or product, as expressed in the home currency.\nIf used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "0",
      "x-intuit-sortable": true
    },
    "Id": {
      "type": "object",
      "x-intuit-type": "IdType",
      "description": "Unique Identifier for an Intuit entity (object).\nRequired for the update operation.",
      "x-intuit-required": "Required for update",
      "x-intuit-filterable": true
    }
  },
  "required": [
    "Name"
  ],
  "$defs": {
    "associatedvalues": {
      "type": "object",
      "title": "associatedvalues",
      "properties": {
        "Value": {
          "type": "string",
          "description": "For ExtensionType=DIMENSION, the unique ID of the selected dimension value.",
          "x-intuit-required": "Required"
        },
        "Key": {
          "type": "string",
          "description": "For ExtensionType=DIMENSION, the unique ID of the dimension definition.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    },
    "customextensions": {
      "type": "object",
      "title": "customextensions",
      "properties": {
        "AssociatedValues": {
          "allOf": [
            {
              "$ref": "#/$defs/associatedvalues"
            }
          ],
          "description": "Array of key/value pairs associated with this extension. For ExtensionType=DIMENSION, each pair maps a dimension definition (Key) to a dimension value (Value).",
          "x-intuit-required": "Required"
        },
        "ExtensionType": {
          "type": "string",
          "description": "The type of extension applied to the line. Currently supported value: DIMENSION.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "AssociatedValues",
        "ExtensionType"
      ]
    },
    "modificationmetadata": {
      "type": "object",
      "title": "modificationmetadata",
      "properties": {
        "CreateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was created in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was last updated in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        }
      }
    },
    "referencetype": {
      "type": "object",
      "title": "referencetype",
      "properties": {
        "name": {
          "type": "string",
          "description": "An identifying name for the object being referenced by value and is derived from the field that holds the common name of that object. This varies by context and specific type of object referenced. For example, references to a Customer object use Customer.DisplayName to populate this field. Optionally returned in responses, implementation dependent.",
          "x-intuit-required": "Optional"
        },
        "value": {
          "type": "string",
          "description": "The ID for the referenced object as found in the Id field of the object payload. The context is set by the type of reference and is specific to the QuickBooks company file.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "value"
      ]
    }
  }
}