WIP forecast details

Provides details such as cost, estimate, and project manager forecast for a WIP project.

List WIP forecast details

get/objects/construction-forecasting/wip-forecast-detail

Returns a collection with a key, ID, and link for each WIP forecast detail entry. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionConstruction
User typeBusiness, Project Manager
PermissionsList, View WIP Forecast Details
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/construction-forecasting/wip-forecast-detail/1"
      },
    • {
      • "id": "2",
      • "key": "2",
      • "href": "/objects/construction-forecasting/wip-forecast-detail/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "totalSuccess": 2,
    • "totalError": 0
    }
}
Get a WIP forecast detail
get/objects/construction-forecasting/wip-forecast-detail/{key}
Returns WIP forecast details for a specified combination of project, task, and cost type.



Permissions and other requirements



SubscriptionConstruction


User typeBusiness, Project Manager


PermissionsList, View WIP Forecast Details







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the WIP forecast detail.


 
 Example:  21
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "430300000000",
    • "key": "430300000000",
    • "wipPeriod": {
      • "periodName": "Month Ended August 2023",
      • "id": "4",
      • "key": "4",
      • "href": "/objects/construction-forecasting/wip-period/4"
      },
    • "task": {
      • "name": "Curb Gutters Sidewalks and Driveways",
      • "id": "32 16 00",
      • "key": "150",
      • "href": "/objects/projects/task/150"
      },
    • "rootTask": {
      • "name": "EXTERIOR IMPROVEMENTS",
      • "id": "32 00 00",
      • "key": "149",
      • "href": "/objects/projects/task/149"
      },
    • "costType": {
      • "name": "Subcontract",
      • "id": "SUB",
      • "key": "586",
      • "href": "/objects/construction/cost-type/586"
      },
    • "project": {
      • "name": "Northside HS cccc",
      • "id": "23-010",
      • "key": "10",
      • "href": "/objects/projects/project/10"
      },
    • "assignedEntity": {
      • "name": "Timberline GC",
      • "id": "TIMBGC",
      • "key": "3",
      • "href": "/objects/company-config/entity/3"
      },
    • "wipProject": {
      • "id": "12",
      • "key": "12",
      • "href": "/objects/construction-forecasting/wip-project/12"
      },
    • "projectManagerForecast": {
      • "key": 17,
      • "costToComplete": "3000.00",
      • "costAtCompletion": "9000.00",
      • "percentComplete": "66.67",
      • "notes": "This is a draft forecast from Project Manager.",
      • "pmUserUpdatedDate": "2023-05-26T10:06:00Z",
      • "costToCompleteVariance": "500.00",
      • "costAtCompletionVariance": "400.00",
      • "href": "/objects/construction-forecasting/wip-project-manager-forecast/17"
      },
    • "priorPeriodProjectManagerForecast": {
      • "costToComplete": "3500.00",
      • "costAtCompletion": "9400.00",
      • "percentComplete": "62.77"
      },
    • "costAndEstimateDetail": {
      • "key": 4303,
      • "estimatedCostAtCompletion": "1500000.00",
      • "jobToDateCosts": "1250000.00",
      • "estimatedCostToDateAmount": "1000000.00",
      • "pendingEstimatesAmount": "1010000.00",
      • "estimatedCostToComplete": "500000.00",
      • "estimatedPercentComplete": "66.67",
      • "estimateVsForecastVariance": "500.00",
      • "href": "/objects/construction-forecasting/wip-actuals-drill-down/4303"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a WIP forecast detail
patch/objects/construction-forecasting/wip-forecast-detail/{key}
Updates an existing WIP forecast detail object by setting the field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionConstruction


User typeBusiness, Project Manager


PermissionsEdit WIP Forecast Details







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the WIP forecast detail.


 
 Example:  21
Request Body schema: application/json
key
string
System-assigned key for the WIP forecast detail.


 
 Example:  "1"
object
WIP period associated with the forecast detail.


 
key
string
System-assigned key for the WIP period.


 
 Example:  "16"
id
string
Unique identifier for the WIP period.


 
 Example:  "16"
object
The entity assigned to the WIP period.


 
key
string
System-assigned key for the entity.


 
 Example:  "1"
id
string
Unique identifier for the entity.


 
 Example:  "USAE"
object
The WIP project associated with the WIP forecast detail.


 
key
string
System-assigned key for the WIP project.


 
 Example:  "322"
id
string
Unique identifier for the WIP project.


 
 Example:  "322"
object
The project associated with the WIP forecast detail.


 
key
string
System-assigned key for the project.


 
 Example:  "10"
id
string
Unique identifier for the project.


 
 Example:  "23-010"
object
Cost type associated with the WIP forecast detail.


 
id
string or null
Unique identifier for the cost type.


 
 Example:  "SUB"
key
string or null
System-assigned key for the cost type.


 
 Example:  "586"
object
The task associated with the WIP forecast detail.


 
id
string or null
Unique identifier for the task.


 
 Example:  "32 16 00"
key
string or null
System-assigned key for the task.


 
 Example:  "150"
object
 Deprecated 
Group (top level) task associated with the WIP forecast detail.


 
id
string or null
Unique identifier for the group task.


 
key
string or null
System-assigned key for the group task.


 
object
Root task is the task at the root level in the hierarchy.


 
id
string or null
Unique identifier for the root task.


 
 Example:  "32 00 00"
key
string or null
System-assigned key for the root task.


 
 Example:  "149"
object
Project manager's forecast of project costs, profits, and completion percentage.


 
key
string or null
System-assigned key for the WIP project manager forecast.


 
 Example:  "1"
costToComplete
string or null <decimal-precision-2> 
Project manager forecast cost to complete.


 
 Example:  "3000.00"
costAtCompletion
string or null <decimal-precision-2> 
Project manager forecast cost at completion.


 
 Example:  "9000.00"
percentComplete
string or null <percent-precision-2> 
Project manager forecast percent complete.


 
 Example:  "90.00"
notes
string or null
Notes or comments about the project manager forecast.


 
 Example:  "Review weekly"
pmUserUpdatedDate
string or null <date-time> 
The date and time the PM forecast was last updated.


 
 Example:  "2023-05-26T10:06:00Z"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "projectManagerForecast": {
    • "costToComplete": "2000.00",
    • "costAtCompletion": "9000.00",
    • "notes": "Update forecast",
    • "pmUserUpdatedDate": "2024-11-26T10:06:00Z"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "430300000000",
    • "id": "430300000000",
    • "href": "/objects/construction-forecasting/wip-forecast-detail/430300000000"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query WIP forecast details
post/services/core/query
Use the query service to find WIP forecast details that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}