Equipment Usage

This API records equipment usage in the system.

WebMethod

GJES5J – required

Option

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

CompanyCode

required

DateOfRecord

required

errorsFound

returned result

recordsProcessed

returned result

pdfReport

default = false

pdfReportOut

base64 encoded pdf

Equipment

Field	Description
`EquipmentCode`	required
`DateRequired`	defaults to current system date
`AllocationType`	(header)`AllocationType` = `J` \| `W` \| `E` • automatically assigned from header (read-only) (header)`AllocationType` = `M` – G \| J \| W \| E (required) • G – G/L • J – Job • W – W/O • E – E/Q
`AllocationCompanyCode`	required
`Allocation1`	`AllocationType` = G \| J \| W \| E (required) • G – GLAccount • J – JobNumber • W – WorkOrderNumber • E – EquipmentNumber
`Allocation2`	`AllocationType` = G \| J (required) • G – GLDepartmentCode • J – CostItem • W – CostType • E – ComponentCode
`Allocation3`	`AllocationType` = G \| J \| W \| E (required) • G – SubAccount (if applicable) • J \| E – CostType • W – N/A
`RentalGroup`	from Equipment Profile
`UnitCode`	HOURS \| DAYS \| WEEKS \| MONTHS
`Quantity`
`Rates`
`Shift`	blank or 1-6 (used for C/M)

{
       "WebMethod": "GJES5J",
       "Option": "scan",
       "pdfReport": false,
       "CompanyCode": "",
       "DateOfRecord": "1900-01-01T00:00:00Z",
       "Equipment": [{
             "EquipmentCode": "",
             "DateRequired": "1900-01-01T00:00:00Z",
             "AllocationType": "",
             "AllocationCompanyCode": "",
             "Allocation1": "",
             "Allocation2": "",
             "Allocation3": "",
             "RentalGroup": "",
             "UnitCode": "",
             "Quantity": "",
             "Rates": "",
             "Shift": ""
       }]
}

example

{
           "WebMethod": "GJES5J",
           "Option": "scan",
           "pdfReport": true,
           "CompanyCode": "01",
           "DateOfRecord": "2018-11-01T00:00:00Z",
           "Equipment": [{
                 "EquipmentCode": "0000000001",
                 "DateRequired": "2018-11-01T00:00:00Z",
                 "AllocationType": "J",
                 "AllocationCompanyCode": "01",
                 "Allocation1": "00-008",
                 "Allocation2": "9999",
                 "Allocation3": "1",
                 "RentalGroup": "Internal",
                 "UnitCode": "HOURS",
                 "Quantity": "10",
                 "Rates": "21.88",
                 "Shift": "1"
           }]
}

result with error

{
        "WebMethod": "GJES5J",
        "Option": "scan",
        "CompanyCode": "01",
        "DateOfRecord": "2018-11-01T00:00:00Z",
        "recordsProcessed": 1,
        "errorsFound": 1,
        "errors":["Equipment Code: 0000000001 is not on file"],
        "pdfErrorReport":"RklMRSBBVFRBQ0hNRU5UICMx"
}

successful result

{
        "WebMethod": "GJES5J",
        "Option": "scan",
        "CompanyCode": "01",
        "DateOfRecord": "2018-11-01T00:00:00Z",
        "errorsFound": 0,
        "recordsProcessed": 1,
        "pdfReport": false
}