Upload Forecast Final
This API records Upload Forecast Final Cost Type & Hours in the system.
- will only update existing Cost Items and Cost Types (ie: does not create new Cost Items and Cost Types)
WebMethod
Option
- scan – error scan only
- update – Upload equipment usage
- Template – Get upload template
CompanyCode
AsOf
- Period (YYYY-MM), default = current
UpdatePreviousPeriodsOnly
- Boolean, default = false
- Not applicable if
AsOf period is current
errorsFound
recordsProcessed
pdfReport
pdfReportOut
- base64 encoded pdf, read-only
Upload Forecast Final Cost Type & Hours
| Field | Description |
|---|
JobNumber | required |
LineItems
| Field | Description |
|---|
CostItem | Required |
CostType | Required |
LabHours | number (-99999.99) |
Amount | number (-999999999.99) |
Units | Units / Quantity — number (-999999999.99) |
template
{
"WebMethod":"GJJ36CTJ",
"Option":"Template",
"UpdatePreviousPeriodsOnly":false,
"AsOf":"2023-07",
"pdfReport":false,
"CompanyCode":"",
"ForecastFinal":[{
"JobNumber":"",
"LineItems":[{
"CostItem":"",
"CostType":"",
"LabHours":0,
"Amount":0,
"Units":0
}]
}]
}
example
{
"WebMethod":"GJJ36CTJ",
"Option":"scan",
"pdfReport":false,
"CompanyCode":"01",
"ForecastFinal":[{
"JobNumber":"00001",
"LineItems":[{
"CostItem":"0010",
"CostType":"LAB",
"LabHours":6,
"Amount":250.00,
"Units":30
}]
}]
}
result with error
{
"WebMethod": "GJJ36CTJ",
"Option": "scan",
"CompanyCode": "01",
"recordsProcessed": 1,
"errorsFound": 1,
"errors":[" Job Number 000035 does not exist "]
}
successful result
{
"WebMethod": "GJJ36CTJ",
"Option": "scan",
"CompanyCode": "01",
"errorsFound": 0,
"recordsProcessed": 1,
"pdfReport": false
}