Equipment

Returns a list of equipment for a business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit Id.

query Parameters
accountingTemplateName
string

The accounting system template name. If not specified, use default accounting system.

isActive
boolean
Default: true

If true, only include active equipment. If false, only include inactive equipment. If null, include all.

isDeleted
boolean
Default: false

If true, only include deleted equipment. If false, only include non-deleted equipment. If null, include all.

Responses
get/api/v1/businessUnits/{businessUnitId}/equipment
Request samples 
Response samples 
application/json
[
  • {
    }
]
Returns a list of equipment.
Securitybearer 
Request 
Request Body schema: 
businessUnitId
required
string <uuid> 
The business unit id.


 
equipmentCodes
Array of strings or null
List of equipment codes.


 
equipmentIds
Array of strings or null <uuid> 
List of equipment ids.


 
jobIds
Array of strings or null <uuid> 
List of job ids.


 
jobTagIds
Array of strings or null <uuid> 
List of job tag ids.


 
accountingTemplateName
string or null
The accounting template name.


 
isActive
boolean or null
The active flag.


 
isActiveInAnyActiveJobs
boolean or null
The flag to filter equipment to the active status in any of the active jobs.


 
isDeleted
boolean or null
The soft-deleted flag.


 
cursor
string or null
Optional.
When there are additional results, the metadata nextCursor field
should be passed to retrieve the next page of results.


 
limit
integer or null <int32> 
The maximum number of results that should be returned.


 
Responses 
post/api/v1/equipment/advancedRequest
Request samples 
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "equipmentCodes": [
    ],
  • "equipmentIds": [
    ],
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "accountingTemplateName": "string",
  • "isActive": true,
  • "isActiveInAnyActiveJobs": true,
  • "isDeleted": true,
  • "cursor": "string",
  • "limit": 0
}
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns a list of equipment types.
Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
 
Responses 
get/api/v1/businessUnits/{businessUnitId}/equipment/types
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new equipment type.
Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
The business unit id.


 
Request Body schema: 
The equipment type to be created.


code
required
string  non-empty 
The code.


 
description
string or null
The description.


 
Responses 
post/api/v1/businessUnits/{businessUnitId}/equipment/types
Request samples 
{
  • "code": "DIGGER",
  • "description": "Earth digger"
}
Response samples 
application/json
{
  • "id": "10b98b7e-5015-4b7e-a1a6-56166dbcbd37",
  • "businessUnitId": "2a7e2e5f-fb73-46a3-a8b5-fa597435d383",
  • "code": "EXCAVATOR",
  • "description": "Sand excavator"
}
Updates an existing equipment
Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
 
equipmentId
required
string <uuid> 
 
query Parameters
accountingTemplateName
string
 
Request Body schema: 
equipmentId
required
string <uuid> 
The equipment Id.


 
equipmentCode
required
string  [ 1 .. 100 ] characters 
The equipment code.


 
equipmentDescription
string or null  <= 200 characters 
The equipment description


 
gpsDeviceTag
string or null  <= 50 characters 
The GPS device tag.


 
isRental
boolean
The is Rental flag.


 
make
string or null  <= 50 characters 
The make of the equipment.


 
model
string or null  <= 50 characters 
The model of the equipment.


 
licensePlate
string or null  <= 20 characters 
The license plate.


 
serialNumber
string or null  <= 50 characters 
The serial number or VIN.


 
state
string or null  <= 20 characters 
The state.


 
vendorId
string or null <uuid> 
The vendor Id.


 
year
integer <int32> 
The year of the equipment.


 
isActive
boolean or null
The is Active flag.


 
operatorPayClassId
string or null <uuid> 
The Operator's pay class Id.


 
equipmentTypeId
string or null <uuid> 
The equipment type Id.


 
fuelTypeId
string or null <uuid> 
The Fuel Type ID.


 
fuelCapacity
number <double> 
The Fuel Capacity.


 
isFueler
boolean
The IsFueler.


 
accountingCode
string or null  <= 100 characters 
The accounting code.


 
accountingType
string or null  <= 100 characters 
The accounting type.


 
company
string or null  <= 100 characters 
The accounting company.


 
costType
string or null  <= 100 characters 
The accounting cost type.


 
division
string or null  <= 100 characters 
The accounting division.


 
generalLedgerAccount
string or null  <= 100 characters 
The accounting general ledger account.


 
meterType
string or null  <= 100 characters 
The accounting meter type.


 
miscAccount
string or null  <= 100 characters 
The accounting miscaccount.


 
usageCode
string or null  <= 100 characters 
The accounting usage code.


 
Responses 
put/api/v1/businessUnits/{businessUnitId}/equipment/{equipmentId}
Request samples 
{
  • "equipmentId": "d2a795e1-f645-4e24-bc0a-ab1965048fcc",
  • "equipmentCode": "string",
  • "equipmentDescription": "string",
  • "gpsDeviceTag": "string",
  • "isRental": true,
  • "make": "string",
  • "model": "string",
  • "licensePlate": "string",
  • "serialNumber": "string",
  • "state": "string",
  • "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
  • "year": 0,
  • "isActive": true,
  • "operatorPayClassId": "b377aca1-50f0-4f3d-bc38-64319c610347",
  • "equipmentTypeId": "75641331-528a-4a65-a7ee-9c92d1008a32",
  • "fuelTypeId": "6f8add80-12b4-4fd5-9e44-0922d2c2b8e2",
  • "fuelCapacity": 0,
  • "isFueler": true,
  • "accountingCode": "string",
  • "accountingType": "string",
  • "company": "string",
  • "costType": "string",
  • "division": "string",
  • "generalLedgerAccount": "string",
  • "meterType": "string",
  • "miscAccount": "string",
  • "usageCode": "string"
}