Record Job Unit Qty's
This API allows you to enter quantities for Job units.
WebMethod
GJJ31J– required
Option
- scan – error scan only
- update – Post quantities for Job units
- Template – JSON string template (for reference only)
CompanyCode
- required
DateOfRecord
- required; must be in an active period
Reference
- required (10 chars max)
Description
- required (30 chars max)
pdfReport
- true | false (default)
pdfReportOut
- returned audit report — base64 encoded pdf
errorsFound
- returned result
Batch
| Field | Description |
|---|---|
JobNumber | required |
Items
| Field | Description |
|---|---|
CostItem | required • the CostItem+CostType combination must be a line item on either the Job Estimate or on a Change Order |
CostType | required • CostType restriction for units in accordance with Special Options in Costing Profile (if set) |
Units | required |
{
"WebMethod": "GJJ31J",
"Option": "template",
"CompanyCode": "",
"DateOfRecord": "1970-01-01T00:00:00Z",
"Reference": "",
"Description": "",
"Batch": [{
"JobNumber": "",
"Items": [{
"CostItem": "",
"CostType": "",
"Units": 0
}]
}]
}example
{
"WebMethod": "GJJ31J",
"Option": "scan",
"pdfReport": "true",
"CompanyCode": "01",
"DateOfRecord": "2029-05-11T00:00:00Z",
"Reference": "the reference",
"Description": "the description",
"Batch": [{
"JobNumber": "00-001",
"Items": [{
"CostItem": "9900",
"CostType": "Q",
"Units": 2
},
{
"CostItem": "9999",
"CostType": "M",
"Units": 4
}]
},
{
"JobNumber": "000001",
"Items": [{
"CostItem": "9900",
"CostType": "Q",
"Units": 1
},
{
"CostItem": "00001",
"CostType": "E",
"Units": 3
}]
}]
}result with error
{
"errorsFound": 1,
"WebMethod": "GJJ31J",
"Option": "scan",
"pdfReport": false,
"CompanyCode": "01",
"DateOfRecord": "2029-05-11T00:00:00Z",
"errors": ["The date you entered is not Active."]
}result with error
{
"errorsFound": 1,
"WebMethod": "GJJ31J",
"Option": "scan",
"pdfReport": false,
"errors": ["There's no estimate for 000001-9900-Q"]
}result with error
{
"errorsFound": 1,
"WebMethod": "GJJ31J",
"Option": "scan",
"pdfReport": false,
"errors": ["You are restricted to Cost Type 'Q' for Units"]
}successful result
{
"errorsFound": 0,
"WebMethod": "GJJ31J",
"Option": "update",
"pdfReport": true,
"pdfReportOut":"JVBERi0xLjQNCjEgMCBvYmoNC...(base64 encoded pdf)"
}