WIP projects

Ongoing projects that may be included in a WIP schedule, that provide:

  • Project manager and CFO forecasts of project costs, profits, and completion percentage
  • Actual costs and earned revenue
  • Overbilling and underbilling amounts

List WIP projects

get/objects/construction-forecasting/wip-project

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "17",
      • "key": "17",
      • "href": "/objects/construction-forecasting/wip-project/17"
      },
    • {
      • "id": "23",
      • "key": "23",
      • "href": "/objects/construction-forecasting/wip-project/23"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "totalSuccess": 2,
    • "totalError": 0
    }
}
Get a WIP project
get/objects/construction-forecasting/wip-project/{key}
Returns detailed information for a particular WIP project.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "projectStatus": {
      • "id": "In Progress",
      • "key": "1",
      • "href": "/objects/projects/project-status/1"
      },
    • "manager": {
      • "name": "Moffet; Doug W",
      • "id": "EMP00025",
      • "key": "25",
      • "href": "/objects/company-config/employee/1"
      },
    • "projectType": {
      • "id": "Warehouse",
      • "key": "3",
      • "href": "/objects/projects/project-type/3"
      },
    • "location": {
      • "name": "Beaverton",
      • "id": "BEAVERTON",
      • "key": "8",
      • "href": "/objects/company-config/location/8"
      },
    • "class": {
      • "name": "Construction class",
      • "id": "Construction class",
      • "key": "2",
      • "href": "/objects/company-config/class/2"
      },
    • "department": {
      • "name": "Construction Operations",
      • "id": "OPERATIONS",
      • "key": "1",
      • "href": "/objects/company-config/department/1"
      },
    • "wipPeriod": {
      • "periodName": "Month Ended October 2023",
      • "id": "54",
      • "key": "54"
      },
    • "project": {
      • "endDate": "2023-07-31",
      • "name": "Quick Bowls - Portland1",
      • "description": "Fast food restaurant with drive-thru",
      • "id": "22-001",
      • "key": "1",
      • "startDate": "2022-01-03",
      • "status": "active"
      },
    • "forecastDetails": [
      • {
        },
      • {
        }
      ],
    • "audit": {
      • "createdBy": "1",
      • "createdDateTime": "2024-12-11T17:36:42Z",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2025-01-03T21:13:13Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "projectManagerForecast": {
      • "contractValue": "179610",
      • "costAtCompletion": "900",
      • "costToComplete": "-308235.95",
      • "percentComplete": "-9999"
      },
    • "cfoForecast": {
      • "contractValue": "179610",
      • "lastUpdatedDate": "2024-12-26T16:35:22Z",
      • "costAtCompletion": "450000.6",
      • "costToComplete": "140864.65",
      • "percentComplete": "68.7"
      },
    • "customer": {
      • "name": "Trammel Crow",
      • "id": "C00002",
      • "key": "2",
      • "href": "/objects/accounts-receivable/customer/2"
      },
    • "jobToDateUnderbillingAmount": "100490.07",
    • "remainingProfit": "-84646.72",
    • "currentPeriodEarnedProfitAmount": "0",
    • "totalContractValue": "179610",
    • "currentPeriodEarnedRevenueAmount": "0",
    • "endOfPriorYearEarnedToDateAmount": "0",
    • "earnedProfitToDateAmount": "-185743.88",
    • "cfoForecastGrossProfitAtCompletion": "-270390.6",
    • "costAtCompletionVariance": "21244.06",
    • "currentPeriodBillingAmount": "0",
    • "grossProfitPercentOfContract": "-150.54",
    • "estimatedCostToComplete": "119620.59",
    • "overUnderBillingAmount": "100490.07",
    • "yearToDateBillingAmount": "0",
    • "isFinalized": false,
    • "grossProfitVarianceAmount": "-21244.06",
    • "jobToDateOverbillingAmount": "0",
    • "estimatedPercentComplete": "72.1",
    • "yearToDateEarnedProfitAmount": "-185743.88",
    • "jobToDateCosts": "309135.95",
    • "endOfPriorYearEarnedProfit": "0",
    • "grossProfitPercentOfCost": "-60.09",
    • "remainingBacklogAmount": "56217.93",
    • "id": "338",
    • "estimatedCostToDateAmount": "428756.54",
    • "contractVarianceAmount": "0",
    • "key": "338",
    • "currentPeriodCostAmount": "0",
    • "yearToDateCostAmount": "0",
    • "cfoForecastGrossProfitMarginPercent": "-150.54",
    • "yearToDateEarnedRevenueAmount": "123392.07",
    • "totalGrossProfitEstimatedAtCompletion": "-249146.54",
    • "jobToDateBillings": "22902",
    • "earnedToDateAmount": "123392.07",
    • "estimatedCostAtCompletion": "428756.54",
    • "pendingEstimatesAmount": "0",
    • "hasAnomaly": false,
    • "createdFromEntity": {
      • "name": "Timberline GC",
      • "id": "TIMBGC",
      • "key": "3",
      • "href": "/objects/company-config/entity/3"
      },
    • "assignedEntity": {
      • "name": "Timberline GC",
      • "id": "TIMBGC",
      • "key": "3",
      • "href": "/objects/company-config/entity/3"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a WIP project
patch/objects/construction-forecasting/wip-project/{key}
Updates an existing WIP project by setting the field values. Any fields not provided remain unchanged.


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


 
 Example:  99
Request Body schema: application/json
key
string
System-assigned key for the WIP project.


 
 Example:  "1"
isFinalized
boolean
 Default:  false
A WIP project is finalized when it is ready to be posted to the general ledger.


 
 Example:  false
estimatedCostToDateAmount
string <decimal-precision-2> 
The project's estimated costs to-date based on estimate entries in the project's primary estimate. Estimate entries are included if they meet the following criteria:


    

  • Have a workflow type of original, revision, or approved change.
    • 

  • Have an effective date that falls before or on the end date for the WIP schedule.
    • 



 
 Example:  "10000.00"
jobToDateCosts
string <decimal-precision-2> 
The project's actual costs to-date. This amount comes from journal postings to the selected cost accounts.


 
 Example:  "1000.00"
estimatedCostToComplete
string <decimal-precision-2> 
Estimate of the costs remaining for the project. The amount is calculated as estimatedCostAtCompletion less jobToDateCosts.


 
 Example:  "3000.00"
estimatedCostAtCompletion
string <decimal-precision-2> 
Estimated cost at completion of the project based on estimate entries in the project's primary estimate. Estimate entries are included if they have a workflow type of original, revision, or approved change.


 
 Example:  "3000.00"
pendingEstimatesAmount
string <decimal-precision-2> 
Estimated pending amount based on pending estimate entries in the project's primary estimate.


 
 Example:  "3000.00"
estimatedPercentComplete
string <percent-precision-2> 
Estimated percent complete for the project, calculated as project's jobToDateCosts divided by estimatedCostAtCompletion.


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


 
costToComplete
string <decimal-precision-2> 
Project manager forecast cost to complete.


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


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


 
 Example:  90
contractValue
string <decimal-precision-2> 
Project manager forecast contract value.


 
 Example:  "10000.00"
lastUpdatedDate
string <date-time> 
The date and time the project manager last updated their forecast.


 
 Example:  "2023-05-26T10:06:00Z"
object
CFO forecast of project costs, profits, and completion percentage.


 
costToComplete
string <decimal-precision-2> 
CFO forecast cost to complete.


 
 Example:  "4000.00"
costAtCompletion
string <decimal-precision-2> 
CFO forecast cost at completion.


 
 Example:  "9500.00"
percentComplete
string <percent-precision-2> 
CFO forecast percent complete.


 
 Example:  70
contractValue
string <decimal-precision-2> 
CFO forecast contract value.


 
 Example:  "10000.00"
lastUpdatedDate
string <date-time> 
The date and time the CFO last updated their forecast.


 
 Example:  "2023-05-26T10:06:00Z"
costAtCompletionVariance
string <decimal-precision-2> 
Cost at completion variance (cfoForecast.costAtCompletion less estimatedCostAtCompletion).


 
 Example:  "500.00"
totalContractValue
string <decimal-precision-2> 
The sum of the price for all project contract lines, including any change request entries linked to the project contract line through a change order.


A project contract line entry is included in the calculation if it meets the following conditions:


    

  • The workflow type is original or revision, or approved change (change request entry).
    • 

  • The price effective date is earlier than or on the end date of the WIP schedule period.
    • 



 
 Example:  "10000.00"
contractVarianceAmount
string <decimal-precision-2> 
Contract amount variance (cfoForecast.contractValue less totalContractValue).


 
 Example:  "1000.00"
jobToDateBillings
string <decimal-precision-2> 
Job-to-date billings amount comes from journal postings to the revenue accounts specified in the WIP setup object.


Journal entries are included in this amount if they meet the following conditions:


    

  • The account is specified as a revenue account in the list of accounts in the WIP setup object.
    

    • 

  • The project dimension assigned to the journal entry matches the WIP project or one of its child projects.
    

    • 

  • The entry date for the journal entry falls before the WIP schedule period end date.
    

    • 



A credit amount posted to the account is added to the job-to-date billed amount. A debit is subtracted.


 
 Example:  "5000.00"
earnedToDateAmount
string <decimal-precision-2> 
Earned-to-date amount (cfoForecast.contractValue multiplied by cfoForecast.percentComplete).


This amount reflects the earnings from the beginning of the project; it is not limited to the current year.


 
 Example:  "5000.00"
remainingBacklogAmount
string <decimal-precision-2> 
Remaining backlog amount represents the work left for the project as a currency amount (cfoForecast.contractValue less earnedToDateAmount).


 
 Example:  "3000.00"
overUnderBillingAmount
string <decimal-precision-2> 
The overbilling or underbilling amount is the difference between YTD billed and YTD earned amounts.


 
 Example:  "-1000.00"
earnedProfitToDateAmount
string <decimal-precision-2> 
Current earned profit to-date (earnedToDateAmount less jobToDateCosts).


 
 Example:  "5000.00"
grossProfitPercentOfContract
string <percent-precision-2> 
Gross profit percent of contract (cfoForecast.grossProfitAtCompletion divided by cfoForecast.contractValue).


 
 Example:  20
grossProfitPercentOfCost
string <percent-precision-2> 
Gross profit percent of cost (cfoForecast.grossProfitAtCompletion divided by cfoForecast.costsAtCompletion).


 
 Example:  30
totalGrossProfitEstimatedAtCompletion
string <decimal-precision-2> 
Total gross profit estimated at completion (totalContractValue less estimatedCostAtCompletion).


 
 Example:  "3000.00"
cfoForecastGrossProfitAtCompletion
string <decimal-precision-2> 
CFO forecast gross profit at completion (cfoForecast.contractValue less cfoForecast.costsAtCompletion).


 
 Example:  "3000.00"
grossProfitVarianceAmount
string <decimal-precision-2> 
Gross profit variance (cfoForecast.grossProfitAtCompletion less totalGrossProfitEstimatedAtCompletion).


 
 Example:  "1000.00"
cfoForecastGrossProfitMarginPercent
string <percent-precision-2> 
CFO forecast gross profit margin percent (cfoForecast.grossProfitAtCompletion divided by cfoForecast.contractValue).


 
 Example:  30
priorYearsProfit
string <decimal-precision-2> 
Earned to-date profit (earnedToDateAmount less jobToDateCost).


 
 Example:  "20000.00"
endOfPriorYearEarnedToDateAmount
string <decimal-precision-2> 
Earned to-date amount as of end of prior year (earnedToDateAmount less endOfPriorYearEarnedProfit).


 
 Example:  "15000.00"
endOfPriorYearEarnedProfit
string <decimal-precision-2> 
Earned profit as of end of prior year. This value comes from the end-of-year WIP schedule from the prior year if one exists. Otherwise, the amount is zero.


 
 Example:  "15000.00"
remainingProfit
string <decimal-precision-2> 
The amount of the project that remains to be earned (cfoForecast.grossProfitAtCompletion less earnedProfitToDate).


 
 Example:  "15000.00"
yearToDateCostAmount
string <decimal-precision-2> 
Year-to-date costs.


 
 Example:  "15000.00"
yearToDateBillingAmount
string <decimal-precision-2> 
Year-to-date billings.


 
 Example:  "15000.00"
yearToDateEarnedRevenueAmount
string <decimal-precision-2> 
Year-to-date earned revenue.


 
 Example:  "15000.00"
jobToDateOverBillingAmount
string <decimal-precision-2> 
 Deprecated 
This field has been deprecated. Use the jobToDateOverbillingAmount field instead.


 
jobToDateOverbillingAmount
string <decimal-precision-2> 
Job-to-date overbilling.


 
 Example:  "15000.00"
jobToDateUnderBillingAmount
string <decimal-precision-2> 
 Deprecated 
This field has been deprecated. Use the 'jobToDateUnderbillingAmount` field instead.


 
jobToDateUnderbillingAmount
string <decimal-precision-2> 
Job-to-date underbilling.


 
 Example:  "15000.00"
yearToDateEarnedProfitAmount
string <decimal-precision-2> 
Year-to-date earned profit.


 
 Example:  "15000.00"
currentPeriodBillingAmount
string <decimal-precision-2> 
Current period billings.


 
 Example:  "15000.00"
currentPeriodCostAmount
string <decimal-precision-2> 
Current period costs.


 
 Example:  "15000.00"
currentPeriodEarnedProfitAmount
string <decimal-precision-2> 
Current period earned profit.


 
 Example:  "15000.00"
currentPeriodEarnedRevenueAmount
string <decimal-precision-2> 
Current period earned revenue.


 
 Example:  "15000.00"
notes
string
Notes or comments about the WIP project.


 
 Example:  "no comments"
Array of objects
WIP forecast details for the WIP project


 
 Array 
key
string
System-assigned key for the WIP forecast detail.


 
 Example:  "1"
id
string
Unique identifier for the WIP forecast detail. This value is the same as the key for this object.


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


 
object
The entity assigned to the WIP schedule.


 
object
The WIP project associated with the WIP forecast detail.


 
object
The project associated with the WIP forecast detail.


 
object
Cost type associated with the WIP forecast detail.


 
object
The task associated with the WIP forecast detail.


 
object
Root (top level) task associated with the WIP forecast detail.


 
object
Project manager's forecast of project costs, profits, and completion percentage.


 
object
The project this WIP project is based on.


 
key
string
Key for the project.


 
 Example:  "16"
id
string
Identifier for the project.


 
 Example:  "SMIT"
object
The customer associated with the project.


 
key
string
Key for the customer.


 
 Example:  "10"
id
string
Identifier for the customer.


 
 Example:  "ITEC"
object
The entity from which this WIP project's parent WIP schedule was created.


 
key
string
System-assigned key for the entity.


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


 
 Example:  "USAE"
object
The entity assigned to the WIP project's parent WIP period.


 
key
string
System-assigned key for the entity.


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


 
 Example:  "USAE"
periodEndDate
string or null <date> 
WIP schedule end date


 
 Example:  "2023-05-31"
object
The WIP period this WIP project is associated with.


 
key
string
The key for the WIP period.


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


 
 Example:  "123"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "isFinalized": true,
  • "notes": "Done with editing"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "41",
    • "id": "41",
    • "href": "/objects/construction-forecasting/wip-project/41"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}