Uprate

A user rate per project [Uprate] is the hourly or daily rate used to bill for a user's time spent on a particular project. Used when your OpenAir account is configured to get the billing rates from Employee / Project [account.rate_from = up].

—	XML	SOAP	REST	Database table
Object	`Uprate`	`oaUprate`	—	`up_rate`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Uprate

oaUprate

—

up_rate

Supported Commands

Add, Read, Modify, Delete

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

—

The Uprate object has the following standard properties:

Note:

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

Review the Usage Guidelines in relation to custom fields for the Uprate object.

XML / SOAP	Database	Description
`categoryid`	`category_id`	The ID of the associated category.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	Currency for the money fields in the record.
`customerid`	`customer_id`	The ID of the associated customer.
`duration`	`duration`	Billing rate: H – hourly D – Daily
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`job_codeid`	`job_code_id`	The ID of the job code this rate is associated with. This is only used in the context of project billing rules.
`notes`	`notes`	Notes associated with the user project rate (uprate).
`project_billing_ruleid`	`project_billing_rule_id`	If project billing rules are used, this is the ID of the associated project billing rule.
`projectid`	`project_id`	The ID of the associated project.
`rate`	`rate`	The billing rate.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`user_id`	The ID of the associated user.

XML / SOAP

Database

Description

categoryid

category_id

The ID of the associated category.

created

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

currency

Currency for the money fields in the record.

customerid

customer_id

The ID of the associated customer.

duration

Billing rate:

H – hourly
D – Daily

id

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

job_codeid

job_code_id

The ID of the job code this rate is associated with. This is only used in the context of project billing rules.

notes

Notes associated with the user project rate (uprate).

project_billing_ruleid

project_billing_rule_id

If project billing rules are used, this is the ID of the associated project billing rule.

projectid

project_id

The ID of the associated project.

rate

The billing rate.

updated

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

userid

user_id

The ID of the associated user.

Usage Guidelines

You can create custom fields for the user rate per project [Uprate] object. These custom fields are available through the XML API and SOAP API only. They are not available on any form.

When creating the new custom field, select Uprate (API only) from the Add custom field to dropdown. The Uprate (API only) entity appears under Global in the dropdown. For more information about creating custom fields, see Creating and Modifying Custom Fields.