ProjectBudgetRule

A project budget rule [ProjectBudgetRule] defines a line in the project budget grid.

Review the Usage Guidelines for the ProjectBudgetRule object.

—	XML	SOAP	REST	Database table
Object	`ProjectBudgetRule`	`oaProjectBudgetRule`	—	`project_budget_rule`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

ProjectBudgetRule

oaProjectBudgetRule

—

project_budget_rule

Supported Commands

Add, Read, Modify, Delete

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

—

The ProjectBudgetRule object has the following properties:

XML / SOAP	Database	Description
`category`	`category`	The main category for this budget line: 1 — labor 2 — expense item 3 — purchase order When setting `category` to `1`, the property `labor_subcategory` for the associated project budget group `project_budget_groupid` must be set.
`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`	[Read-only] Copied from project budget group. The ID of the associated customer.
`date`	`date`	The date of the budget rule. See Date Fields.
`end_date`	`end_date`	End date of the period. See Date Fields.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`imported`	`imported`	A 0/1 field which indicates whether the rule was imported from project task assignments or bookings (related only to the labor category).
`itemid`	`item_id`	The ID of the associated item.
`job_codeid`	`job_code_id`	The ID of the associated job code.
`notes`	`notes`	Notes associated with this project budget line.
`period`	`period`	The period of the total: D — daily W — weekly M — monthly T — total (for example, the sum entered in the web application is only for one date, and not periodically recurring)
`productid`	`product_id`	The ID of the associated product.
`profitability`	`profitability`	The profitability of this project budget rule.
`project_budget_groupid`	`project_budget_group_id`	[Required] The ID of the associated project_budget_group. Cannot be modified.
`project_taskid`	`project_task_id`	The ID of the associated project task.
`projectid`	`project_id`	[Read-only] Copied from project budget group. The ID of the associated project.
`quantity`	`quantity`	The quantity for this project budget rule.
`quantity_best`	`quantity_best`	The best-case quantity estimate for this project budget rule.
`quantity_most_likely`	`quantity_most_likely`	The most likely quantity estimate for this project budget rule.
`quantity_worst`	`quantity_worst`	The worst-case quantity estimate for this project budget rule.
`rate`	`rate`	The rate of this project budget rule.
`start_date`	`start_date`	Start date of the period. See Date Fields.
`total`	`total`	The total for this project budget rule. Date set by the date" attribute."
`total_best`	`total_best`	The best-case estimate for this project budget rule. Date set by the date" attribute."
`total_most_likely`	`total_most_likely`	The most likely estimate for this project budget rule. Date set by the date" attribute."
`total_worst`	`total_worst`	The worst-case estimate for this project budget rule. Date set by the date" attribute."
`updated`	`updated`	[Read-only] Time the record was last modified. See Date Fields.

XML / SOAP

Database

Description

category

The main category for this budget line:

1 — labor
2 — expense item
3 — purchase order

When setting category to 1, the property labor_subcategory for the associated project budget group project_budget_groupid must be set.

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

[Read-only] Copied from project budget group. The ID of the associated customer.

date

The date of the budget rule. See Date Fields.

end_date

End date of the period. See Date Fields.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

imported

A 0/1 field which indicates whether the rule was imported from project task assignments or bookings (related only to the labor category).

itemid

item_id

The ID of the associated item.

job_codeid

job_code_id

The ID of the associated job code.

notes

Notes associated with this project budget line.

period

The period of the total:

D — daily
W — weekly
M — monthly
T — total (for example, the sum entered in the web application is only for one date, and not periodically recurring)

productid

product_id

The ID of the associated product.

profitability

The profitability of this project budget rule.

project_budget_groupid

project_budget_group_id

[Required] The ID of the associated project_budget_group. Cannot be modified.

project_taskid

project_task_id

The ID of the associated project task.

projectid

project_id

[Read-only] Copied from project budget group. The ID of the associated project.

quantity

The quantity for this project budget rule.

quantity_best

The best-case quantity estimate for this project budget rule.

quantity_most_likely

The most likely quantity estimate for this project budget rule.

quantity_worst

The worst-case quantity estimate for this project budget rule.

rate

The rate of this project budget rule.

start_date

Start date of the period. See Date Fields.

total

The total for this project budget rule. Date set by the date" attribute."

total_best

The best-case estimate for this project budget rule. Date set by the date" attribute."

total_most_likely

The most likely estimate for this project budget rule. Date set by the date" attribute."

total_worst

The worst-case estimate for this project budget rule. Date set by the date" attribute."

updated

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

Usage Guidelines

Review the following guidelines:

When adding a new project budget rule, SuiteProjects Pro checks the validity of the project budget group ID, and returns error 945 if invalid (see Error Codes). The project and customer fields are sourced from the project budget group.
When modifying an existing project budget rule, you cannot change the project, customer, or budget group ID fields. If you change any of the following fields in a project budget rule, these fields are copied to all related project budget transactions: category, categoryid, itemid, job_codeid, productid, project_taskid.
To delete a project budget rule, you must have edit access to the project budget group, and the project budget must not be approved or archived.
The API does not support project budget approvals.