Equipment

Creates a new piece of equipment.

Creates a new piece of equipment, using its code as a unique identifier on the specified business unit.

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
Request Body schema: application/json

The equipment.

code
required
string

The code.

businessUnitCode
required
string

The business unit code.

id
string or null <uuid>

The Id of the equipment.

isActive
boolean or null

The is Active flag.

defaultPayClass
string or null

The default pay class code.

description
string or null

The description.

gpsDeviceTag
string or null

The GPS device tag.

group
string or null

The group name.

licensePlate
string or null

The license plate.

state
string or null

The state.

serialNumber
string or null

The serial number or VIN.

isRental
boolean or null

The is Rental flag.

make
string or null

The make of the equipment.

model
string or null

The model of the equipment.

year
integer or null <int32>

The year of the equipment.

capacity
number or null <double>

The capacity of the equipment.

accountingCode
string or null

The accounting code.

company
string or null

The "Company" accounting field.

miscAccount
string or null

The "MiscAccount" accounting field.

accountingType
string or null

The "AccountingType" accounting field.

meterType
string or null

The "MeterType" accounting field.

usageCode
string or null

The "UsageCode" accounting field.

costType
string or null

The "CostType" accounting field.

division
string or null

The "Division" accounting field.

generalLedgerAccount
string or null

The "GLAcct" accounting field.

accountingTemplateName
string or null

The accounting template name.

Responses
post/api/v1/Equipment
Request samples
application/json
{
  • "code": "00.00DAWN",
  • "businessUnitCode": "manager",
  • "id": "bc226e8c-bbef-4ccd-913f-ecb654995d81",
  • "isActive": true,
  • "defaultPayClass": "01-IRS-(HWI-4217)",
  • "description": "2017 Loader",
  • "gpsDeviceTag": "GPS",
  • "group": "Loaders",
  • "licensePlate": "831-TX01",
  • "state": "LIC",
  • "serialNumber": "TX",
  • "isRental": false,
  • "make": "marque 1",
  • "model": "modele 2a",
  • "year": 2017,
  • "capacity": 103.38,
  • "accountingCode": "10351z",
  • "company": "John Deere",
  • "miscAccount": "Misc Account",
  • "accountingType": "Acct Type",
  • "meterType": "Meter Type",
  • "usageCode": "Usage Code",
  • "costType": "Equipment",
  • "division": "SouthWest",
  • "generalLedgerAccount": "GL Acct",
  • "accountingTemplateName": "default"
}

Returns a list of equipment.

Returns a list of equipment for the specified business unit code and accounting template.

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitCode
required
string

The business unit code.

Example: businessUnitCode=MANAGER
accountingTemplateName
string
Default: ""

The accounting template name. If blank or unspecified, the primary accounting template for the business unit is used.

Example: accountingTemplateName=MAINTEMPLATE
Responses
get/api/v1/Equipment
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates a piece of equipment by its id.
After the result of this operation, the server entity will match exactly what is sent here.  (i.e., excluded fields will be interpreted as "not needed" and deleted from the server)


For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The equipment guid.


 
Request Body schema: application/json
The equipment.


code
required
string
The code.


 
businessUnitCode
required
string
The business unit code.


 
id
string or null <uuid> 
The Id of the equipment.


 
isActive
boolean or null
The is Active flag.


 
defaultPayClass
string or null
The default pay class code.


 
description
string or null
The description.


 
gpsDeviceTag
string or null
The GPS device tag.


 
group
string or null
The group name.


 
licensePlate
string or null
The license plate.


 
state
string or null
The state.


 
serialNumber
string or null
The serial number or VIN.


 
isRental
boolean or null
The is Rental flag.


 
make
string or null
The make of the equipment.


 
model
string or null
The model of the equipment.


 
year
integer or null <int32> 
The year of the equipment.


 
capacity
number or null <double> 
The capacity of the equipment.


 
accountingCode
string or null
The accounting code.


 
company
string or null
The "Company" accounting field.


 
miscAccount
string or null
The "MiscAccount" accounting field.


 
accountingType
string or null
The "AccountingType" accounting field.


 
meterType
string or null
The "MeterType" accounting field.


 
usageCode
string or null
The "UsageCode" accounting field.


 
costType
string or null
The "CostType" accounting field.


 
division
string or null
The "Division" accounting field.


 
generalLedgerAccount
string or null
The "GLAcct" accounting field.


 
accountingTemplateName
string or null
The accounting template name.


 
Responses 
put/api/v1/Equipment/{id}
Request samples 
application/json
{
  • "code": "00.00DAWN",
  • "businessUnitCode": "manager",
  • "id": "bc226e8c-bbef-4ccd-913f-ecb654995d81",
  • "isActive": true,
  • "defaultPayClass": "01-IRS-(HWI-4217)",
  • "description": "2017 Loader",
  • "gpsDeviceTag": "GPS",
  • "group": "Loaders",
  • "licensePlate": "831-TX01",
  • "state": "LIC",
  • "serialNumber": "TX",
  • "isRental": false,
  • "make": "marque 1",
  • "model": "modele 2a",
  • "year": 2017,
  • "capacity": 103.38,
  • "accountingCode": "10351z",
  • "company": "John Deere",
  • "miscAccount": "Misc Account",
  • "accountingType": "Acct Type",
  • "meterType": "Meter Type",
  • "usageCode": "Usage Code",
  • "costType": "Equipment",
  • "division": "SouthWest",
  • "generalLedgerAccount": "GL Acct",
  • "accountingTemplateName": "default"
}