Category

A service (category, activity, or time type) [Category] is a specific economic activity offered to your customers and used on invoices to customers. A service can be set up to bill at an hourly rate, at a set amount per day, week, or month, or at a flat rate. Services are available in the Timesheets, Projects (tasks, billing rules, and recognition rules), Invoices, and Opportunity applications.

Review the Usage Guidelines for the Category object

—	XML	SOAP	REST	Database table
Object	`Category`	`oaCategory`	—	`category`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Category

oaCategory

—

category

Supported Commands

Add, Read, Modify, Delete

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

—

The Category object has the following standard properties:

Note:

Category 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	Database	Description
`active`	`active`	A 1/0 field indicating whether this is designated as an active category. Set to `1` if omitted when adding an object.
`code`	`acct_code`	Optional accounting system code for integration with external accounting systems.
`cost_centerid`	`cost_center_id`	The ID of the associated cost center.
`cost_rate`	`cost_rate`	The hourly cost rate
`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.
`fixed_fee`	`fixed_fee`	The fixed fee value of this service.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`name`	`name`	[Required] The category name.
`notes`	`notes`	Category notes.
`other_rate`	`other_rate`	The rate for another time billing metric.
`other_rate_type`	`other_rate_type`	The time the `other_rate` field applies to. Valid entries are Day, Week, Month, Quarter, Year and Session.
`picklist_label`	—	Label as shown on form picklist.
`rate`	`rate`	The hourly billing rate.
`taxable`	`taxable`	A 1/0 field indicating whether this item is taxable, vat-taxable, etc.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Database

Description

active

A 1/0 field indicating whether this is designated as an active category. Set to 1 if omitted when adding an object.

code

acct_code

Optional accounting system code for integration with external accounting systems.

cost_centerid

cost_center_id

The ID of the associated cost center.

cost_rate

The hourly cost rate

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.

fixed_fee

The fixed fee value of this service.

id

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

name

[Required] The category name.

notes

Category notes.

other_rate

The rate for another time billing metric.

other_rate_type

The time the other_rate field applies to. Valid entries are Day, Week, Month, Quarter, Year and Session.

picklist_label

—

Label as shown on form picklist.

rate

The hourly billing rate.

taxable

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

updated

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

Usage Guidelines

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