Subcontract Change Orders

This API upload's new Subcontract Change Orders to the system. It cannot update existing Change Orders.

WebMethod

  • GJZJ40J – required

Option

  • scan – error scan only
  • update – Upload Subcontract Change Orders
  • Template – Get upload template

CompanyCode

  • required

APSubledgerCode

  • required

errorsFound

  • returned result

recordsProcessed

  • returned result

pdfReport

  • default = false

pdfReportOut

  • base64 encoded pdf

ChangeOrders

FieldDescription
JobNumberrequired
Supplierrequired
SubContractNumberrequired
ChangeOrderNumberoptional, automatically assigned if not provided
Description
ChangeOrderDate
ChangeOrderAmount
OriginIdoptional

LineItems

FieldDescription
CostItemrequired
CostTyperequired
Description
AmountLump Sum contracts
EstimatedQuantityUnit Price contracts
UnitPriceUnit Price contracts
UnitOfMeasureUnit Price contracts
PBReportCoderequired if integrated to Progress Billing
• see Costing System Profile (Special options)
PBLineNumberrequired if integrated to Progress Billing
• see Costing System Profile (Special options)

template

{
        "WebMethod": "GJZJ40J",
        "Option": "Template",
        "CompanyCode": "",
        "APSubledgerCode": "",
        "ChangeOrders": [{
               "JobNumber": "",
               "Supplier": "",
               "SubContractNumber": "",
               "ChangeOrderNumber": "",
               "Description": "",
               "ChangeOrderDate": "1970-01-01T00:00:00Z",
               "ChangeOrderAmount": 0.00,
               "OriginId": "",
               "LineItems": [{
                      "CostItem": "",
                      "CostType": "",
                      "Description": "",
                      "Amount": 0.00,
                      "EstimatedQuantity": 0.00,
                      "UnitPrice": 0.000,
                      "UnitOfMeasure": "",
                      "PBReportCode": "",
                      "PBLineNumber": ""
               }]
        }]
}

example

{
           "WebMethod": "GJZJ40J",
           "Option": "update",
           "CompanyCode": "JC",
           "APSubledgerCode": "AP",
           "pdfReport": true,
           "ChangeOrders": [{
                  "JobNumber": "00-001",
                  "Supplier": "1",
                  "SubContractNumber": "000001",
                  "ChangeOrderNumber": "",
                  "Description": "test",
                  "ChangeOrderDate": "2020-05-11T00:00:00Z",
                  "ChangeOrderAmount": 20.00,
                  "OriginId": "9267788066",
                  "LineItems": [{
                          "CostItem": "010A1",
                          "CostType": "1",
                          "Description": "test",
                          "Amount": 20.00,
                          "EstimatedQuantity": 0.00,
                          "PBLineNumber": "00001"
                  }]
           }]
}

result with error

{
        "WebMethod": "GJZJ40J",
        "Option": "update",
        "CompanyCode": "JC",
        "APSubledgerCode": "AP",
        "recordsProcessed": 0,
        "errorsFound": 1,
        "errors": ["Subcontract 000001 does not exist for Job/Supplier"],
        "pdfErrorReport":"RklMRSBBVFRBQ0hNRU5UICMx"
}

successful result

{
        "errorsFound": 0,
        "pdfReport": false,
        "WebMethod": "GJZJ40J",
        "Option": "update",
        "CompanyCode": "JC",
        "APSubledgerCode": "AP",
        "ChangeOrders": [{
                "JobNumber": "00-001",
                "Supplier": "1",
                "SubContractNumber": "000001",
                "ChangeOrderNumber": "C00022"
        }],
        "recordsProcessed": 1
}