WIP available periods

Get a list of available General Ledger reporting periods.

Get available periods

post/services/construction-forecasting/wip-reporting-period/get-available

Retrieve a list of available periods for creating a WIP report.

Permissions and other requirements
SubscriptionConstruction
User typeBusiness, Project Manager
PermissionsWIP List Periods
SecurityOAuth2
Request
Request Body schema: application/json
optional
required
object

The entity assigned to the WIP period. The top level WIP period may be assigned a different entity. When creating a WIP period from entity level, the entity must match the selected entity.

key
string

System-assigned key for the entity.

Example: "1"
id
string

Unique identifier for the entity.

Example: "USAE"
periodEndDate
string <date>

WIP period end date or any date within a WIP period. The current date is used if this value is not specified or is null.

Example: "2023-05-31"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "periodEndDate": "2023-06-02"
}
Response samples
application/json
{
  • "ia::result": {
    • "periods": [
      • {
        },
      • {
        }
      ]
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}