WIP periods

Use WIP schedule periods to monitor profitability and revenue recognition for ongoing projects. The WIP schedule periods are based on the reporting periods in your entity. See Work in progress (WIP) management for details.

List WIP periods

get/objects/construction-forecasting/wip-period

Returns a collection with a key, ID, and link for each WIP period. 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

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": [{"id": "8",
"key": "8",
"href": "/objects/construction-forecasting/wip-period/8"
},
{"id": "9",
"key": "9",
"href": "/objects/construction-forecasting/wip-period/9"
}
],
"ia::meta": {"totalCount": 2,
"totalSuccess": 2,
"totalError": 0
}
}

Create a WIP period

post/objects/construction-forecasting/wip-period

Creates a new WIP period. You can only create one WIP period for a specified assignedEntity in a given reporting period.

SecurityOAuth2

Request

Request Body schema: application/json
required

Create a new WIP period.

periodEndDate

required

string <date>

The ending date of the WIP schedule's reporting period. This field cannot be modified.

Example: "2023-05-31"

required

object

The entity assigned to this WIP period. This field cannot be modified.

key	string System-assigned key for the entity. Example: "1"
id	string Unique identifier for the entity. Example: "USAE"

periodName

string

The name for the reporting period on which the WIP schedule is based. This field cannot be modified.

Example: "Month end May 2023"

periodStartDate

string <date>

The beginning date of the WIP schedule's reporting period. This field cannot be modified.

Example: "2023-05-01"

state

string

Default: "unposted"

The state is posted if the WIP projects are finalized and posted to the general ledger, otherwise, it is unposted. On creating a wip-period object, the state must be unposted.

A period is ready to be posted when:

The state of the WIP period is set to unposted
The WIP period is not a manually imported historical period (isHistoricalImport is set to false)
The WIP projects are marked as finalized (wip-project.isFinalized is set to true)
All books are open for posting

Enum: "posted" "unposted"

Example: "unposted"

notes

string

Notes or comments about the WIP period.

Example: "Review with the team"

isHistoricalImport

boolean

Default: false

Indicates whether this is a manually imported historical WIP period. This field cannot be modified.

Example: false

lastRefreshDateTime

string <date-time>

The date and time the WIP period was last updated with the latest project data and any changes to the projects included in the WIP schedule.

Example: "2023-05-26T10:06:00Z"

object

The entity from which this WIP period was created. This field cannot be modified.

key	string System-assigned key for the entity. Example: "1"
id	string Unique identifier for the entity. Example: "USAE"

Array of objects

WIP projects the WIP schedule period is based on.

Array

key	string System-assigned key for the WIP project. Example: "1"
id	string Unique identifier for the WIP project. This value is the same as the `key` for this object. 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.
	object CFO forecast of project costs, profits, and completion percentage.
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
	object The project this WIP project is based on.
	object The customer associated with the project.
	object The entity from which this WIP project's parent WIP schedule was created.
	object The entity assigned to the WIP project's parent WIP period.
periodEndDate	string or null <date> WIP schedule end date Example: "2023-05-31"
	object The WIP period this WIP project is associated with.

Responses

201

Created

400

Bad Request

Request samples

application/json

{"periodEndDate": "2023-10-31",
"notes": "WIP schedule for the month of Oct. 2023",
"assignedEntity": {"id": "TIMBGC"
}
}

Response samples

application/json

{"ia::result": {"key": "41",
"id": "41",
"href": "/objects/construction-forecasting/wip-period/41"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get a WIP period

get/objects/construction-forecasting/wip-period/{key}

Returns detailed information for a specified WIP period.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the WIP period.

Example: 1

Responses

200

400

Bad Request

Request samples

Response samples

application/json

{"ia::result": {"createdFromEntity": {"key": "3"
},
"endOfPriorYearPeriod": {"periodName": "Month Ended December 2022",
"id": "65",
"key": "65"
},
"assignedEntity": {"name": "Timberline GC",
"id": "TIMBGC",
"key": "3"
},
"wipProjects": [{"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": [{"wipPeriod": {"periodName": "Month Ended October 2023",
"id": "54",
"key": "54"
},
"task": {"name": "Finish Carpentry",
"id": "06 20 00",
"key": "538"
},
"costType": {"name": "Subcontract",
"id": "SUB",
"key": "1496"
},
"project": {"name": "Quick Bowls - Portland1",
"id": "22-001",
"key": "1"
},
"wipProject": {"id": "338",
"key": "338"
},
"rootTask": {"name": "WOOD PLASTICS AND COMPOSITES",
"id": "06 00 00",
"key": "537"
},
"priorPeriodProjectManagerForecast": {"costAtCompletion": "900",
"costToComplete": "500",
"percentComplete": "80"
},
"costAndEstimateDetail": {"estimatedCostAtCompletion": "5200",
"jobToDateCosts": "5200",
"estimatedCostToDateAmount": "5200",
"key": "7829"
},
"projectManagerForecast": {"costToCompleteVariance": "900",
"costAtCompletionVariance": "500"
},
"id": "782900000000",
"key": "782900000000"
},
{"wipPeriod": {"periodName": "Month Ended October 2023",
"id": "54",
"key": "54"
},
"task": {"name": "Fees",
"id": "01 41 23",
"key": "259"
},
"costType": {"name": "Other",
"id": "OTH",
"key": "835"
},
"project": {"name": "Quick Bowls - Portland1",
"id": "22-001",
"key": "1"
},
"wipProject": {"id": "338",
"key": "338"
},
"rootTask": {"name": "GENERAL REQUIREMENTS",
"id": "01 00 00",
"key": "255"
},
"priorPeriodProjectManagerForecast": {"costAtCompletion": "900",
"costToComplete": "500",
"percentComplete": "80"
},
"costAndEstimateDetail": {"estimatedCostAtCompletion": "1100",
"jobToDateCosts": "6590",
"estimatedCostToDateAmount": "1100",
"key": "7836"
},
"projectManagerForecast": {"costToCompleteVariance": "900",
"costAtCompletionVariance": "500"
},
"id": "783600000000",
"key": "783600000000"
}
],
"audit": {"createdBy": "1",
"createdDateTime": "2024-12-11T17:36:42Z",
"modifiedBy": "1",
"modifiedDateTime": "2025-01-03T21:13:13Z",
"createdByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
},
"modifiedByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
}
},
"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"
},
"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,
"assignedEntity": {"key": "3",
"id": "TIMBGC",
"name": "Timberline GC",
"href": "/objects/company-config/entity/3"
}
},
{"wipPeriod": {"periodName": "Month Ended October 2023",
"id": "54",
"key": "54"
},
"project": {"endDate": "2023-05-31",
"name": "The Crest",
"description": "3-story hotel with 140 rooms",
"id": "22-002",
"key": "2",
"startDate": "2022-05-23",
"status": "active"
},
"forecastDetails": [{"wipPeriod": {"periodName": "Month Ended October 2023",
"id": "54",
"key": "54"
},
"task": {"name": "Curb Gutters Sidewalks and Driveways",
"id": "32 16 00",
"key": "139"
},
"costType": {"name": "Subcontract",
"id": "SUB",
"key": "562"
},
"project": {"name": "The Crest",
"id": "22-002",
"key": "2"
},
"wipProject": {"id": "339",
"key": "339"
},
"assignedEntity": {"name": "Timberline GC",
"id": "TIMBGC",
"key": "3"
},
"rootTask": {"name": "EXTERIOR IMPROVEMENTS",
"id": "32 00 00",
"key": "138"
},
"costAndEstimateDetail": {"estimatedCostAtCompletion": "650000",
"jobToDateCosts": "650000",
"estimatedCostToDateAmount": "650000",
"key": "7831"
},
"projectManagerForecast": {"costToCompleteVariance": "0",
"costAtCompletionVariance": "0"
},
"id": "783100000000",
"key": "783100000000"
},
{"wipPeriod": {"periodName": "Month Ended October 2023",
"id": "54",
"key": "54"
},
"task": {"name": "Finish Carpentry",
"id": "06 20 00",
"key": "544"
},
"costType": {"name": "Subcontract",
"id": "SUB",
"key": "1510"
},
"project": {"name": "The Crest",
"id": "22-002",
"key": "2"
},
"wipProject": {"id": "339",
"key": "339"
},
"assignedEntity": {"name": "Timberline GC",
"id": "TIMBGC",
"key": "3"
},
"rootTask": {"name": "WOOD PLASTICS AND COMPOSITES",
"id": "06 00 00",
"key": "543"
},
"costAndEstimateDetail": {"estimatedCostAtCompletion": "850000",
"jobToDateCosts": "850000",
"estimatedCostToDateAmount": "850000",
"key": "7842"
},
"projectManagerForecast": {"costToCompleteVariance": "0",
"costAtCompletionVariance": "0"
},
"id": "784200000000",
"key": "784200000000"
}
],
"audit": {"createdBy": "1",
"createdDateTime": "2024-12-11T17:36:42Z",
"modifiedBy": "1",
"modifiedDateTime": "2025-01-03T21:13:13Z",
"createdByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
},
"modifiedByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
}
},
"projectManagerForecast": {"contractValue": "26655280",
"costAtCompletion": "22047033.42",
"costToComplete": "1476700.07",
"percentComplete": "93.3"
},
"cfoForecast": {"contractValue": "26655280",
"costAtCompletion": "22047033.42",
"costToComplete": "1476700.07",
"percentComplete": "93.3"
},
"customer": {"name": "Star Enterprises",
"id": "C00021",
"key": "21"
},
"jobToDateUnderbillingAmount": "24869376.24",
"remainingProfit": "309203.69",
"currentPeriodEarnedProfitAmount": "0",
"totalContractValue": "26655280",
"currentPeriodEarnedRevenueAmount": "0",
"endOfPriorYearEarnedToDateAmount": "0",
"earnedProfitToDateAmount": "4299042.89",
"cfoForecastGrossProfitAtCompletion": "4608246.58",
"costAtCompletionVariance": "0",
"currentPeriodBillingAmount": "0",
"grossProfitPercentOfContract": "17.29",
"estimatedCostToComplete": "1476700.07",
"overUnderBillingAmount": "24869376.24",
"yearToDateBillingAmount": "0",
"isFinalized": false,
"grossProfitVarianceAmount": "0",
"jobToDateOverbillingAmount": "0",
"estimatedPercentComplete": "93.3",
"yearToDateEarnedProfitAmount": "4299042.89",
"jobToDateCosts": "20570333.35",
"endOfPriorYearEarnedProfit": "0",
"grossProfitPercentOfCost": "20.9",
"remainingBacklogAmount": "1785903.76",
"id": "339",
"estimatedCostToDateAmount": "22047033.42",
"contractVarianceAmount": "0",
"key": "339",
"currentPeriodCostAmount": "0",
"yearToDateCostAmount": "0",
"cfoForecastGrossProfitMarginPercent": "17.29",
"yearToDateEarnedRevenueAmount": "24869376.24",
"totalGrossProfitEstimatedAtCompletion": "4608246.58",
"jobToDateBillings": "0",
"earnedToDateAmount": "24869376.24",
"estimatedCostAtCompletion": "22047033.42",
"pendingEstimatesAmount": "0",
"hasAnomaly": false,
"assignedEntity": {"key": "3",
"id": "TIMBGC",
"name": "Timberline GC",
"href": "/objects/company-config/entity/3"
}
}
],
"audit": {"createdBy": "1",
"createdDateTime": "2024-12-11T17:36:41Z",
"modifiedBy": "1",
"modifiedDateTime": "2025-01-03T21:13:12Z",
"createdByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
},
"modifiedByUser": {"key": "1",
"id": "Admin",
"href": "objects/company-config/user/1"
}
},
"lastRefreshDateTime": "2024-12-27T00:37:38Z",
"wipCostBreakdownLevel": "costCodeAndCostType",
"notes": "",
"periodName": "Month Ended October 2023",
"id": "54",
"state": "unposted",
"fiscalYear": "2023-01-01",
"isHistoricalImport": false,
"key": "54",
"periodEndDate": "2023-10-31"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update a WIP period

patch/objects/construction-forecasting/wip-period/{key}

Updates an existing WIP period by setting the field values. Any fields not provided remain unchanged.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the WIP period.

Example: 1

Request Body schema: application/json

state

string

Default: "unposted"

The state is posted if the WIP projects are finalized and posted to the general ledger, otherwise, it is unposted. On creating a wip-period object, the state must be unposted.

A period is ready to be posted when:

The state of the WIP period is set to unposted
The WIP period is not a manually imported historical period (isHistoricalImport is set to false)
The WIP projects are marked as finalized (wip-project.isFinalized is set to true)
All books are open for posting

Enum: "posted" "unposted"

Example: "unposted"

notes

string

Notes or comments about the WIP period.

Example: "Review with the team"

isHistoricalImport

boolean

Default: false

Indicates whether this is a manually imported historical WIP period. This field cannot be modified.

Example: false

lastRefreshDateTime

string <date-time>

The date and time the WIP period was last updated with the latest project data and any changes to the projects included in the WIP schedule.

Example: "2023-05-26T10:06:00Z"

Array of objects

WIP projects the WIP schedule period is based on.

Array

key	string System-assigned key for the WIP project. Example: "1"
id	string Unique identifier for the WIP project. This value is the same as the `key` for this object. 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.
	object CFO forecast of project costs, profits, and completion percentage.
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
	object The project this WIP project is based on.
	object The customer associated with the project.
	object The entity from which this WIP project's parent WIP schedule was created.
	object The entity assigned to the WIP project's parent WIP period.
periodEndDate	string or null <date> WIP schedule end date Example: "2023-05-31"
	object The WIP period this WIP project is associated with.

Responses

200

400

Bad Request

Request samples

application/json

{"state": "posted",
"notes": "large under billing"
}

Response samples

application/json

{"ia::result": {"key": "41",
"id": "41",
"href": "/objects/construction-forecasting/wip-period/41"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete a WIP period

delete/objects/construction-forecasting/wip-period/{key}

Deletes a WIP period.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the WIP period.

Example: 1

Responses

204

No Content

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": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

WIP periods

List WIP periods

Create a WIP period

Request Body schema: application/jsonrequired

Get a WIP period

path Parameters

Update a WIP period

path Parameters

Request Body schema: application/json

Delete a WIP period

path Parameters

Request Body schema: application/json
required