Merge · Schema

PatchedItemRequestRequest

# The Item Object ### Description The `Item` object refers to the goods involved in a transaction. ### Usage Example Fetch from the `LIST Items` endpoint and view a company's items.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
name	stringnull	The item's name.
status	object	The item's status.
type	object	The item's type.
unit_price	numbernull	The item's unit price.
purchase_price	numbernull	The price at which the item is purchased from a vendor.
purchase_account	stringnull	References the default account used to record a purchase of the item.
sales_account	stringnull	References the default account used to record a sale.
company	stringnull	The company the item belongs to.
purchase_tax_rate	stringnull	The default purchase tax rate for this item.
sales_tax_rate	stringnull	The default sales tax rate for this item.
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchedItemRequestRequest",
  "title": "PatchedItemRequestRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The item's name."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Status7d1Enum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The item's status."
    },
    "type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Type2bbEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The item's type."
    },
    "unit_price": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The item's unit price."
    },
    "purchase_price": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The price at which the item is purchased from a vendor."
    },
    "purchase_account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "References the default account used to record a purchase of the item."
    },
    "sales_account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "References the default account used to record a sale."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the item belongs to."
    },
    "purchase_tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The default purchase tax rate for this item."
    },
    "sales_tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The default sales tax rate for this item."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "description": "# The Item Object\n### Description\nThe `Item` object refers to the goods involved in a transaction.\n\n### Usage Example\nFetch from the `LIST Items` endpoint and view a company's items."
}