Internal Estimate Changes

This API records Internal Estimate Changes in the system.

WebMethod

  • GJJC5J – required

Option

  • scan – error scan only
  • update – Upload equipment usage
  • Template – Get upload template

CompanyCode

  • required

errorsFound

  • returned result

recordsProcessed

  • returned result

NextChangeOrderNumber

  • automatically assign Change Order Numbers
  • Boolean (default = false, ie: Change Order Numbers must be specified)
  • cannot be used with mixed datasets

pdfReport

  • Boolean (default = false)

pdfReportOut

  • base64 encoded pdf (read-only)

ChangeOrders

FieldDescription
JobNumberrequired
ChangeOrderNumberrequired
• must be unique for Job
• if configured, must be in accordance with "Letter (A-Z) Used for Internal Est.
C/O" (refer to Job System Profile - Special Option)
Description
ChangeOrderDaterequired
OriginIdInternal use only

LineItems

FieldDescription
CostItemrequired
CostTyperequired
Unitsnumber (-999999999.99)
Amountnumber (-999999999.99)
Hoursnumber (-999999999.99)
• N/A for non-Labour Cost Type
OriginIdInternal use only

template

{
    "WebMethod":"GJJC5J",
    "Option":"template",
    "NextChangeOrderNumber":true,
    "pdfReport":false,
    "CompanyCode":"",
    "ChangeOrders":[{
         "JobNumber":"",
         "ChangeOrderNumber":"",
         "Description":"",
         "ChangeOrderDate":"2020-09-22T00:00:00Z",
         "OriginId":"",
         "LineItems":[{
               "CostItem":"",
               "CostType":"",
               "Units":0,
               "Amount":0,
               "Hours":0,
               "OriginId":""
          }]
      }]
}

example

{
    "WebMethod":"GJJC5J",
    "Option":"scan",
    "pdfReport":false,
    "CompanyCode":"01",
    "ChangeOrders":[{
        "JobNumber":"ANYJOB",
        "ChangeOrderNumber":"00005",
        "Description":"Any Text",
        "ChangeOrderDate":"2020-09-22T00:00:00Z",
        "LineItems":[{
              "CostItem":"00000025",
              "CostType":"MA",
              "Units":999.99,
              "Amount":999.99,
              "Hours":999.99
         }]
     }]
}

result with error

{
        "WebMethod": "GJJC5J",
        "Option": "scan",
        "CompanyCode": "01",
        "recordsProcessed": 1,
        "errorsFound": 1,
        "errors":["C/O Status (missing)"]
}

successful result

{
        "WebMethod": "GJJC5J",
        "Option": "scan",
        "CompanyCode": "01",
        "DateOfRecord": "2020-09-29T00:00:00Z",
        "errorsFound": 0,
        "recordsProcessed": 1,
        "pdfReport": false
}