Common ModelsItems

The Item object

The Item object refers to the goods involved in a transaction.

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
namestring or nullOptional
The item's name.
statusenum or nullOptional

The item’s status.

  • ACTIVE - ACTIVE
  • ARCHIVED - ARCHIVED
Allowed values:
typeenum or nullOptional

The item’s type.

  • INVENTORY - INVENTORY
  • NON_INVENTORY - NON_INVENTORY
  • SERVICE - SERVICE
  • UNKNOWN - UNKNOWN
Allowed values:
unit_pricedouble or nullOptional
The item's unit price.
purchase_pricedouble or nullOptional
The price at which the item is purchased from a vendor.
purchase_accountstring or nullOptionalformat: "uuid"
References the default account used to record a purchase of the item.
sales_accountstring or nullOptionalformat: "uuid"
References the default account used to record a sale.
companystring or nullOptionalformat: "uuid"
The company the item belongs to.
purchase_tax_ratestring or nullOptionalformat: "uuid"
The default purchase tax rate for this item.
sales_tax_ratestring or nullOptionalformat: "uuid"
The default sales tax rate for this item.
remote_updated_atdatetime or nullOptional
When the third party's item note was updated.
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional