Takeoff

Fields are optional unless specified; optional field nodes can be omitted from the JSON.

WebMethod

GJJ72J – required

Option

scan – error scan only
update – add or update Takeoff(s)
download – retrieve Takeoff(s)
schema – JSON schema for Takeoff update/download
template – JSON string template for reference

CompanyCode

required

ARSubledgerCode

required

JC_TakeoffHeader_tbl

Field	Description
`JobNumber`	required
`TakeOffNumber`	required—must be a valid existing Takeoff or a new one will be created
`Description`	required
`SummarizeBOM`	Y\|N • N – Explode assemblies into individual parts (default) • Y - Keep assemblies in summary form
`DateShipped`	YYYY-MM-DD \| N/A
`RevisedShippingDate`	YYYY-MM-DD \| N/A
`ShippedVia`
`WayBillNumber`
`ShipperName`
`PaymentOptions`	C\|P • C – Collect (default) • Prepaid
`ShippingNotes`
`ShippingQuantity`
`ShippingDescription`
`ShipTo`
`CustomerCode`
`Notes`	free-text header note (optional)
`QuoteDescription`	free-text quote description (optional)

JC_TakeoffDetail_tbl

Field	Description
`LineNumber`	required; 1-99999
`WarehouseCode`	required
`TakeOffLineType`	M\|L\|C\|P\|E\|O • M – Material (default) • L – Labour • C – Comment • P – Piecework • E – Equipment • O – Other
`CostItem`
`CostType`
`PartNumber`
`PartDescription`
`Cost`
`Quantity`
`BaseMarkup`
`BuilderMarkup`
`PieceworkCode`
`LabelQuantity`
`Weight`

template

{
      "WebMethod": "GJJ72J",
      "Option": "template",
      "CompanyCode": "",
      "ARSubledgerCode": "",
      "JC_TakeoffHeader_tbl": [{
            "JobNumber": "",
            "TakeOffNumber": "",
            "Description": "",
            "SummarizeBOM": "N",
            "DateShipped": "",
            "RevisedShippingDate": "",
            "ShippedVia": "",
            "WayBillNumber": "",
            "ShipperName": "",
            "PaymentOptions": "C",
            "ShippingNotes": "",
            "ShippingQuantity": 0,
            "ShippingDescription": "",
            "ShipTo": "",
            "CustomerCode": "",
            "Notes": "",
            "QuoteDescription": "",
            "JC_TakeoffDetail_tbl": [{
                  "LineNumber": "",
                  "WarehouseCode": "",
                  "TakeOffLineType": "M",
                  "CostItem": "",
                  "CostType": "",
                  "PartNumber": "",
                  "PartDescription": "",
                  "Cost": "",
                  "Quantity": 0,
                  "BaseMarkup": 0,
                  "BuilderMarkup": 0,
                  "PieceworkCode": "",
                  "LabelQuantity": 0,
                  "Weight": 0
            }]
      }]
}

examples

Create a Takeoff

{
        "WebMethod":"GJJ72J",
        "Option":"update",
        "CompanyCode": "PR",
        "ARSubledgerCode": "AR      ",
        "JC_TakeoffHeader_tbl": [{
                "JobNumber": "MASTER",
                "TakeOffNumber": "0000000001",
                "Description": "Take off 1",
                "SummarizeBOM": "N",
                "PaymentOptions": "C",
                "JC_TakeoffDetail_tbl": [{
                     "LineNumber": "1",
                     "WarehouseCode": "MAIN",
                     "TakeOffLineType": "M",
                     "CostItem": "300000",
                     "CostType": "WM",
                     "PartNumber": "2146792974",
                     "PartDescription": "Spray Paint - Color Match",
                     "Cost": 8.95,
                     "Quantity": 1.00
                },
                {
                     "LineNumber": "2",
                     "WarehouseCode": "MAIN",
                     "TakeOffLineType": "M",
                     "CostItem": "300000",
                     "CostType": "WM",
                     "PartNumber": "682577784",
                     "PartDescription": "Plumb.Stack-Rub-5-in-1Boot-Charcoal",
                     "Cost": 9.95,
                     "Quantity": 5.00
                }]
        }]
}

Read Takeoff(s)

{"WebMethod":"GJJ72J","Option":"download","CompanyCode":"PR","ARSubledgerCode":"AR","JC_TakeoffHeader_tbl":[{"JobNumber":"MASTER","TakeOffNumber": "0000000001"}]}

Error examples

{
       "WebMethod": "GJJ72J",
       "Option": "download",
       "CompanyCode": "PR",
       "ARSubledgerCode": "AR",
       "JC_TakeoffHeader_tbl": [{
             "JobNumber": "MASTER",
             "TakeOffNumber": "0000000001",
             "error": "Record not found"
       }],
       "RecordsProcessed": 1,
       "errors": ["Record not found = JTHPRAR   MASTER    0000000001"],
       "errorsFound":1
}

{
       "WebMethod": "GJJ72J",
       "Option": "scan",
       "CompanyCode": "PR",
       "ARSubledgerCode": "AR   ",
       "JC_TakeoffHeader_tbl": [{
             "JobNumber": "MASTER",
             "TakeOffNumber": "0000000001",
             "Description": "Take off 1",
             "JC_TakeoffDetail_tbl": [{
                   "LineNumber": "1",
                   "WarehouseCode": "MAIN",
                   "TakeOffLineType": "M",
                   "CostItem": "300000",
                   "CostType": "WM",
                   "PartNumber": "2146792974",
                   "PartDescription": "Spray Paint - Color Match",
                   "Cost": 8.95,
                   "Quantity": 1.00
             }]
       }],
       "RecordsProcessed": 1,
       "errors": ["(JobNumber) Job #: 'MASTER    ' doesn't exist"],
       "errorsFound": 1
}