LoadedCost

A loaded cost [LoadedCost] is the full hourly cost incurred by the company when an employee spends time on a project. Depending on your account configuration, up to three loaded cost levels can be set for each employees. Employees' loaded costs rate overrides can be set for each projects and project tasks.

Review the Usage Guidelines for the LoadedCost object.

—	XML	SOAP	REST	Database table
Object	`LoadedCost`	`oaLoadedCost`	—	`loaded_cost`
Supported Commands	`Add`, `Read`, `Modify`	`add()`, `read()`, `modify()`, `upsert()`	—	—

—

XML

SOAP

REST

Database table

Object

LoadedCost

oaLoadedCost

—

loaded_cost

Supported Commands

Add, Read, Modify

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

—

The LoadedCost object has the following properties:

XML / SOAP	XML / SOAP	Description
`cost`	`cost`	The fully loaded hourly cost of the user.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	The currency of the cost field.
`current`	`current`	A 1/0 field indicating if this is the current loaded cost record.
`customerid`	`customer_id`	The ID of the associated customer.
`end`	`end`	End date for the loaded cost for historical records. See Date Fields.
`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.
`lc_level`	`lc_level`	If multiple loaded costs are used, this holds the level of loaded cost 0 - primary loaded cost 1 - secondary loaded cost 2 - tertiary loaded cost
`project_taskid`	`project_task_id`	The ID if this loaded cost is associated with a specific project task. If this field is used, the project_id and customer_id must be empty.
`projectid`	`project_id`	The ID if this loaded cost is associated with a specific project.
`start`	`start`	Start date for the loaded cost for historical records. See Date Fields.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`user_id`	[Required] ID of the user. The user must exist, must not be marked as deleted and must be active.

XML / SOAP

Description

cost

The fully loaded hourly cost of the user.

created

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

currency

The currency of the cost field.

current

A 1/0 field indicating if this is the current loaded cost record.

customerid

customer_id

The ID of the associated customer.

end

End date for the loaded cost for historical records. See Date Fields.

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.

lc_level

If multiple loaded costs are used, this holds the level of loaded cost

0 - primary loaded cost
1 - secondary loaded cost
2 - tertiary loaded cost

project_taskid

project_task_id

The ID if this loaded cost is associated with a specific project task. If this field is used, the project_id and customer_id must be empty.

projectid

project_id

The ID if this loaded cost is associated with a specific project.

start

Start date for the loaded cost for historical records. See Date Fields.

updated

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

userid

user_id

[Required] ID of the user. The user must exist, must not be marked as deleted and must be active.

Usage Guidelines

Review the following guidelines:

There can be only one current cost value for a loaded cost level and a specific user. current cannot be set to 1 for more than one lc_level and userid combination.
If current is set to 1, start and end must be empty. Otherwise, start and end are required.
When you add or modify a User, you can modify the LoadedCost associated with that User. See Updating User Loaded Costs.