ProjectBudgetGroup

A project budget group [ProjectBudgetGroup] is a complete project budget as defined in Projects > [Select a project] > Financials > Project Budget > Properties using the OpenAir UI.

Review the Usage Guidelines for the ProjectBudgetGroup object.

—	XML	SOAP	REST	Database table
Object	ProjectBudgetGroup	oaProjectBudgetGroup	—	project_budget_group
Supported Commands	Add, Read, Modify, Delete	add(), read(), modify(), upsert(), delete()	—	—

The ProjectBudgetGroup object has the following properties:

XML / SOAP	Database	Description
approval_status	approval_status	A one-character string indicating the approval status of the project budget group. Possible values: O - Open S - Submitted A - Approved R - Rejected X - Archived
approved	date_approved	The date the project budget group was approved. See Date Fields.
archived	date_archived	The date the project budget group was archived. See Date Fields.
budget_by	budget_by	Sets the "Budget by" option: 1 — budget by project 2 — budget by phase 3 — budget by task
calculated_total	calculated_total	[Read-only] The total calculated from project budget transactions. Date set by the date" field (obsolete attribute)."
cf_opt	cf_opt	Optimistic contingency factor for this project budget. Used if your account is configured to allow for a simplified contingency factor on project budgets. Defaults to 80% if not set when adding a ProjectBudgetGroup object.
cf_pes	cf_pes	Pessimistic contingency factor for this project budget. Used if your account is configured to allow for a simplified contingency factor on project budgets. Defaults to 120% if not set when adding a ProjectBudgetGroup object.
created	created	[Read-only] Time the record was created. See Date Fields.
currency	currency	Currency for the money fields in the record.
customerid	customerid	[Required] The ID of the associated customer.
date	date	The date of the budget entry. See Date Fields.
eac	—	[Read-only] Calculated estimate at completion (EAC) total.
eac_expense	—	[Read-only] Calculated estimate at completion (EAC) – expense subtotal.
eac_labor	—	[Read-only] Calculated estimate at completion (EAC) – labor subtotal.
eac_purchase	—	[Read-only] Calculated estimate at completion (EAC) – purchase subtotal.
etc	—	[Read-only] Calculated estimate to complete (ETC) total.
etc_expense	—	[Read-only] Calculated estimate to complete (ETC) – expense subtotal.
etc_labor	—	[Read-only] Calculated estimate to complete (ETC) – labor subtotal.
etc_purchase	—	[Read-only] Calculated estimate to complete (ETC) – purchase subtotal.
externalid	externalid	If the record was imported from an external system you store the unique external record ID here.
funding_total	funding_total	[Read-only] Total calculated from project funding documents. Date set by the date" field."
id	id	[Read-only] Unique ID. Automatically assigned by OpenAir.
internal_total	internal_total	Manually entered total. Date set by the date" field."
itd	—	[Read-only] Calculated inception to date (ITD) total.
itd_expense	—	[Read-only] Calculated inception to date (ITD) – expense subtotal.
itd_labor	—	[Read-only] Calculated inception to date (ITD) – labor subtotal.
itd_purchase	—	[Read-only] Calculated inception to date (ITD) – purchase subtotal.
labor_subcategory	labor_subcategory	Labor subcategory: 0 - category 1 - job code
name	name	The name of the project budget group.
notes	notes	Notes associated with this project budget.
parentid	parentid	The project budget group ID of this budget's immediate ancestor. If zero or null, this is a top-level project budget group.
profitability	profitability	The profitability of this project budget group.
projectid	projectid	[Read-only] The ID of the associated project.
setting	setting	Miscellaneous settings are stored in this field as a serialized hash.
submitted	date_submitted	The date the project budget group was submitted. See Date Fields.
total	total	The total value of the budget entry. Date set by the date" field."
total_calculated_billing	total_calculated_billing	[Read-only] Billing total calculated from project budget transactions. Date set by the date" field."
total_calculated_cost	total_calculated_cost	[Read-only] Cost total calculated from project budget transactions. Date set by the date" field."
total_expected_billing	total_expected_billing	[Read-only] Billing budget expected total. Date set by the date" field."
total_expected_cost	total_expected_cost	[Read-only] Cost total calculated from project budget transactions. Date set by the date" field."
total_from_funding	total_from_funding	A 1/0 field indicating whether to use the total from project funding documents.
unassigned_task	unassigned_task	A 1/0 field indicating whether it is possible to create budget entries not connected to any particular task.
updated	updated	[Read-only] Time the record was last modified. See Date Fields.
userid	userid	The user ID of the budget owner.
version	version	Version of the project budget group.

Usage Guidelines

Review the following guidelines:

• When adding a budget, OpenAir checks the validity of the customer and the project.

• When modifying an existing budget, you cannot change the project or the customer for the budget.

• To delete a budget, you must have edit access. Approved or archived budgets cannot be deleted.

• The API does not support project budget approvals.