Item

An item [Item] is a category of merchandise or service purchased, utilized or supplied in the delivery of your business activity. Items may be inventory items or expense items.

Review the Usage Guidelines for the Item object.

—	XML	SOAP	REST	Database table
Object	`Item`	`oaItem`	—	`item`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Item

oaItem

—

item

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

An Item object has the following properties:

Note:

Item object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	XML / SOAP	Description
`active`	`active`	A 1/0 field indicating whether this is designated as an active item. Defaults to 1 if not set when adding an item.
`code`	`acct_code`	Optional accounting system code for integration with external accounting systems.
`cost`	`cost`	The default cost per unit of measure for the item. 3 decimal places to handle items like mileage at 32.5 cents.
`cost_centerid`	`cost_center_id`	The ID of the associated cost center.
`cost_is_fixed`	`cost_is_fixed`	A 1/0 field indicating whether the user is allowed to change the cost on a receipt.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	Currency for the money fields in the record.
`externalid`	`external_id`	If the record was imported from an external system you store the unique external record ID here.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`name`	`name`	[Required] The item name.
`picklist_label`	—	Label as shown on form picklist.
`tax_location_id`	`tax_location_id`	The ID of the associated tax location.
`taxable`	`taxable`	A 1/0 field indicating whether this item is taxable, VAT-able, etc.
`tp_comp`	`tp_comp`	Ticket policy comparison: ge - greater than or equal to gt - greater than
`tp_cost`	`tp_cost`	The policy threshold amount.
`tp_notes_required`	`tp_notes_required`	Notes are required if the ticket triggers the policy.
`tp_unit_or_total`	`tp_unit_or_total`	The ticket policy is applied against: U - Unit price T - Total
`type`	`type`	The type of item. Add new types when type-specific information can be captured for the slip or ticket templated from this item: R - for regular item. M - for mileage item.
`unitm`	`um`	The unit of measure for the item, i.e., EA.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Description

active

A 1/0 field indicating whether this is designated as an active item. Defaults to 1 if not set when adding an item.

code

acct_code

Optional accounting system code for integration with external accounting systems.

cost

The default cost per unit of measure for the item. 3 decimal places to handle items like mileage at 32.5 cents.

cost_centerid

cost_center_id

The ID of the associated cost center.

cost_is_fixed

A 1/0 field indicating whether the user is allowed to change the cost on a receipt.

created

[Read-only] Time the record was created. See Date Fields.

currency

Currency for the money fields in the record.

externalid

external_id

If the record was imported from an external system you store the unique external record ID here.

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

name

[Required] The item name.

picklist_label

—

Label as shown on form picklist.

tax_location_id

The ID of the associated tax location.

taxable

A 1/0 field indicating whether this item is taxable, VAT-able, etc.

tp_comp

Ticket policy comparison:

ge - greater than or equal to
gt - greater than

tp_cost

The policy threshold amount.

tp_notes_required

Notes are required if the ticket triggers the policy.

tp_unit_or_total

The ticket policy is applied against:

U - Unit price
T - Total

type

The type of item. Add new types when type-specific information can be captured for the slip or ticket templated from this item:

R - for regular item.
M - for mileage item.

unitm

um

The unit of measure for the item, i.e., EA.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

Usage Guidelines

When adding a Item object, the primary filter set for the authenticated user is updated automatically to allow access to the newly added customer.

You cannot delete an Item object if this object is referenced by an object of any of the following type. Delete any dependent objects first before you delete an Item object.