1. API
  2. REST API
  3. REST API Endpoint Reference
  4. Project Phases

Project Phases

Project phases are work packages to be completed as part of a project. It includes information about the work to be done, when, by whom, and at what cost.

Note:

The /project-phases/ endpoint can only be used for project task records with the task classification field set to Phase in SuiteProjects Pro. This is equivalent to records with the classification property set to P in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes.

For Milestones — project task records with zero duration and the task classification field set to Milestone in SuiteProjects Pro, or the classification property set to M in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes — see Project Milestones.

For Tasks — project task records that have other project tasks nested under and the task classification field set to Task in SuiteProjects Pro, or the classification property set to T in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes — see Project Tasks.

Available methods

ProjectPhase Object Properties

A project phase is a work package to be completed as part of a project. It includes information about the work to be done, when, by whom, and at what cost.

The ProjectPhase object has the following properties:

Name

Description

Type

Read-Only

Query Allowed

Sorting Allowed

attachments

The attachments associated with this phase. Array of internal IDs for attachment objects.

Array of {”id”: <integerValue>} objects.

Yes

—

—

calculatedFinishes

Calculated finish date.

string($date)

Yes

Yes

—

calculatedStarts

Calculated start date of the project phase. If the use task estimating feature is turned on, this field will have the estimated total time the task will take to complete. If zero, no estimating has occurred so the estimate is the same as the plan.

string($date)

Yes

Yes

—

created

Time the record was created.

string($date-time)

Yes

Yes

Yes

currency

Currency for the money fields in the record. This should be the same as the project currency.

string

Yes

Yes

Yes

customerId

The ID of the associated customer.

integer($int64)

Yes

Yes

Yes

defaultCategoryOnPhase

The category to assign to a timesheet entry assigned to this task. The feature has to be enabled for this assignment to work.

string

—

Yes

Yes

defaultCategoryOnPhase1

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategoryOnPhase2

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategoryOnPhase3

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategoryOnPhase4

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategoryOnPhase5

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

externalId

If the record was imported from an external system you store the unique external record ID here.

string

—

Yes

Yes

id

Unique ID. Automatically assigned by SuiteProjects Pro

integer($int64)

Yes

Yes

Yes

idNumber

User-defined phase ID.

integer($int64)

—

Yes

Yes

isClosed

A 1/0 field indicating if this is closed phase.

Boolean

—

Yes

Yes

isReadyForRecognition

Flag 1/0 indicating if phase is ready for recognition

Boolean

—

Yes

Yes

name

Short description of this phase.

string

—

Yes

Yes

notes

Notes associated with the project phase.

string

—

Yes

Yes

parentId

The ID of our immediate ancestor. If zero or null, this is a project-level (top-level) task or phase.

integer($int64)

—

Yes

Yes

percentComplete

This field is an estimate of the percentage of planned time which has been completed. It has no relation to the actual time spent on a phase. (A 5-hour phase could consume 50 hours of work but still be only 25% complete.)

integer($int64)

Yes

Yes

Yes

plannedHours

Total number of hours the phase is estimated to require. This is the total amount of time the phase should take if worked on continuously by one person with no interruptions. A task with zero planned hours is also known as a milestone.

integer($int64)

Yes

Yes

Yes

predecessors

Comma delimited list of task IDs which must complete before this phase can start.

string

Yes

Yes

—

predecessorsLag

Comma delimited list for task ID:days of lag time for predecessors. Only populated if there is a lag time.

string

Yes

Yes

—

predecessorsType

Comma delimited list of task ID:relationship type for predecessors. Only populated if the relationship type is not finish-to-start.

string

Yes

Yes

—

priority

The priority of the phase (1 -9).

integer($int64)

—

Yes

Yes

projectId

The ID of the associated project.

integer($int64)

Yes

Yes

Yes

seq

The sequence number of this task.

integer($int64)

Yes

Yes

Yes

updated

Time the record was last updated or modified

string($date-time)

Yes

Yes

Yes