Generate WIP projects

The generate WIP projects service creates WIP project objects based on calculations of the extended forecast.

Actuals are calculated using data from the general ledger cost and revenue, project estimate, and project contract, combined with the CFO forecast from the prior WIP period.

Generate WIP projects

post/services/construction-forecasting/wip-period/generate

Generate WIP projects for a WIP schedule period.

Permissions and other requirements
SubscriptionConstruction
User typeBusiness, Project Manager
PermissionsAdd WIP Projects
SecurityOAuth2
Request
Request Body schema: application/json
required
periodEndDate
required
string <date>

The ending date of the WIP schedule's reporting period.

Example: "2023-05-31"
required
object

The entity assigned to this WIP period.

key
string

Unique key for the entity.

Example: "1"
id
string

Unique identifier for the entity.

Example: "USAE"
periodStartDate
string <date>

The beginning date of the WIP schedule's reporting period.

Example: "2023-05-01"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "periodEndDate": "2023-01-01"
}
Response samples
application/json
{
  • "ia::result": {
    • "wipProjects": [
      • {
        }
      ],
    • "lastRefreshDateTime": "2023-06-02T14:47:14Z",
    • "wipCostBreakdownLevel": "costCodeAndCostType"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}