Chat with us, powered by LiveChat

Asset MANAGEMENT API SUITE

Technical API details

Check out the information below on our API offerings.

Most Commonly Used APIs

The list below is just a small sample of the APIs available and supported in our products. For a full list down load the AssetWorks API List below.

AcquisitionDate
Active
ActivityDesc
ActivityId
AllowAllFluidTypes
AllowWorkOrders
AlternateUnitNumber
AssetCategoryId
AssetId
AssetNumber
AssetTypeId
Attachments
Attributes
AvailabilityStatusId
BillingId
BookValue
CapitalAdjustmentValue
CapitalValue
CheckInOutStatus
Comments
ConditionId
Country
CreationDate
CreditCards
CurrentLocationId
CustomerNotes
DataScienceGroup
DataScienceProvider
DeliveryDate
DepreciatedMonths
DepreciationRemainingMonths
DepreciationTermMonths
DepreciationType
Description
DescriptionLong
DisposalAuctionPrepAmount
DisposalBankIssuingCheck
DisposalCashReceivedBy
DisposalCheckAmount
DisposalComments
DisposalCommissionAmount
DisposalDate
DisposalDeleteWorkRequests
DisposalEstimatedDate
DisposalFinancier
DisposalFlagDate
DisposalMethodDesc
DisposalMethodId
DisposalOtherProceedsAmount
DisposalPrepAmount
DisposalReasonDesc
DisposalReasonId
DisposalReferenceNumber
DisposalRemoveOperator
DisposalSaleProceedAmount
DisposalSellAssociatedAssets
DisposalStatus
DisposalStatusDesc
DisposalStorageAmount
DisposalTo
DisposalTradeCreditAmount
DisposalTransportationAmount
EstimatedReplacementCost
EstimatedReplacementDate
EstimatedReplacementMeter
EstimatedReplacementMonth
EstimatedReplacementYear
ExpectedLifeMonths
ExpectedLifeUsage1
FuelCards
GrossSalePrice
ImageUrl
InServiceDate
InServiceMeter
InServiceMeter2
InternalId
IsElectric
LastChangedDateTime
LastMeter1DateTime
LastMeter2DateTime
LastPmDate
LastPmId
LastPmLifeMeter1
LastPmWorkOrderLocationId
LastYardCheckDateTime
LatitudeLeaseExpirationDate
LicenseExpirationDate

LicenseGovernment
LicenseNumber
LicenseTypeId
LifeCycleStatusCategory
LifeCycleStatusDesc
LifeCycleStatusId
Longitude
MaintenanceClassId
MaintenanceLocationDesc
MaintenanceLocationId
ManufacturerId
Messages
Meter1AtDelivery
Meter1LifeTotal
Meter1Reading
Meter1Source
Meter1TypeId
Meter2AtDelivery
Meter2LifeTotal
Meter2Reading
Meter2Source
Meter2TypeId
ModelId
MotorPoolLocationId
NetSalePrice
NextPmDueDate
NextPmServiceId
Notes
OffRoad
OffRoadPct
OpenWorkOrders
OperationalClassDesc
OperationalClassId
OperationalStatusDesc
OperationalStatusId
OperatorDeptDesc
OperatorDeptId
OperatorEmail
OperatorId
OperatorName
OperatorPhone
OriginalCost
Ownership
OwningDeptDesc
OwningDeptId
ParkingLocationDesc
ParkingLocationId
PoolClassId
PreviousAssetId
Products
QtyFuelUsedSinceLastPm
RecordType
RentalRates
ReplacedByAssetId
ReplacesAssetId
ResourceClassId
RetireDate
SaleExpense
SalvagePct
SalvageValue
SerialNumber
Sku
SupportsAvailability
SupportsTelematicsCloud
TechSpecDesc
TechSpecId
TelematicsDataSource
Title
ToolTypeId
UnitShiftId
UnitStatus
UserClass1
UserClass1Desc
UserClass2
UserClass2Desc
UserClass3
UserClass3Desc
UserClass4
UserClass4Desc
UserClass5
UserClass5Desc
UseTelematicsMeterWhenFueling
UsingDeptDesc
UsingDeptId
WeightGross
Year

AssetId
BillingCodeId
Comments
CommercialLaborTotalCost
CommercialMarkupCost
CommercialOtherTotalCost
CommercialPartsTotalCost
CommercialTaxCost
CommercialTotalCost
CreditAccountDesc
CreditAccountId
DebitAccountDesc
DebitAccountId
DepartmentDesc
DepartmentId
EachCost
FeeCost
FuelTypeId
InternalExternal
InternalId
InvoiceNumber
LaborCost
LaborHours

LastChangedDateTime
MeterCost
OtherCost
PartId
PartsCost
Period
PeriodStatus
PoolTicket
Quantity
RecurringCost
Source
TableReferenceId
TaskDesc
TaskId
TimeCost
TotalCost
TransactionDateTime
TransactionType
VendorDesc
VendorId
WorkOrderId
WorkOrderLocationId

Active
AllowWorkOrders
BillingId
BillingIdEffectiveDate
ContactEmail
ContactId
ContactName
ContactPhone
DeliveryLocationDesc
DeliveryLocationId
DepartmentId
Description
InternalId

InventoryLocationDesc
InventoryLocationId
LastChangedDateTime
MaintenanceClassDesc
MaintenanceClassId
MaintenanceLocationDesc
MaintenanceLocationId
OrgLevel
OrgLevels
TechSpecDesc
TechSpecId
WorkOrderComment

Active
Attributes
BirthDate
CanBeScheduled
CanDoLabor
ClassificationId
Comments
CrewId
DeptId
DriverNumber
Email
EmployeeId
EmploymentDate
FuelCard
FuelCardPIN
HomePhone
ImageUrl
InternalId
IsContractor
IsSupervisor

LastChangedDateTime
LoadPct
LocationId
MobilePhone
PayClass1
PayClass2
PayClass3
PayStep1
PayStep2
PayStep3
ShiftId
StandardChargeRate
SupervisorId
SupportsAllDepartments
SupportsAllLocations
TerminationDate
TimeTypeId
VendorId
WorkPhone

Active
Address
Attributes
City
Country
DefaultPartsLocationId
DepartmentId
Description
InventoryCarryingCostPct
InventoryLocationId
IsDelivery
IsFuel
IsInventory
IsMaintenance
IsParking
IsPool
LastChangedDateTime

Latitude
LocationId
Longitude
PartsRepairLocationId
Phone
PurchaseOrderOverheadCost
RecoveryCenter
ShiftId
State
TaxSchemeId
TimeReportingGranularity
TimeRoundingUnit
TimeZoneId
WarrantyAccountId
WarrantyUsage
WarrantyUsageUnitOfMeasure
ZipCode

Comments
CreatedDateTime
DefaultVendorId
Description
DescriptionLanguage1
DescriptionLanguage2
DescriptionLanguage3
InternalId
LastChangedDateTime

ManufacturerId
PartId
ProductCategoryDesc
ProductCategoryId
Serialized
TaskSystemId
TaskSystemIdMustMatch
UnitOfMeasureId
VMRSCode

AccountId
Address1
Address2
AllowCommercial
AllowParts
Attachments
City
Comments
ContactName
CorporateVendorId
Country
CreateDateTime
DistributorId
InternalId
LastChangedDateTime
LastReceivedDateTime
LocationId
NeedByDateTime
Notes

OpenLines
OrderDateTime
Phone
PoId
PoLines
POReferenceNumber
State
Status
TotalCost
UserData1
UserData2
UserData3
UserData4
UserData5
VendorDesc
VendorId
VendorInternalId
ZipCode

DueDateTime
EarliestDateTime
IncidentId
InternalId
IsCurrentlyDue
LaborHoursEst
LastChangedDateTime
Locked
NextDue
Notes
Occurrence
PriorityDesc
PriorityId
RecordType
RepairReasonDesc
RepairReasonDescLanguage1
RepairReasonDescLanguage2
RepairReasonDescLanguage3
RepairReasonId

ServiceRequestId
ServiceRequestNoteId
ShopDesc
ShopId
Status
SymptomComment
SymptomId
TaskDesc
TaskId
TaskReason
Tasks
TechSpecId
VendorDesc
VendorId
WarrantyViolation
WorkOrderId
WorkOrderLocationId
WorkPlanDesc
WorkPlanId

Active
AdrAddress1
AdrAddress2
AdrCountry
AdrMunicipality
AdrPostalCode
AdrStateProvince
AllowCommercialWork
AllowEquipment
AllowFuel
AllowParts
AllowPartsRepair
AllowPartsWarranty
AllowTesting
AllowWarranty
Attributes
BillingAddress1
BillingAddress2
BillingAddressSameAsMail
BillingCity
BillingContactName
BillingContactPhone
BillingContactPhoneExt
BillingCountry
BillingCounty
BillingEmailAddress
BillingPostalCode
BillingRegion
BillingStateProvince
BillingType

Comments
ContactName
Contacts
CorporateVendorDesc
CorporateVendorId
CurrencyCode
CustomerAccount
Description
DiscountDays
DiscountPct
EEOCStatus
EmailAddress
Fax
InternalId
LastChangedDateTime
LeadDays
NetTermsDays
Notes
Phone
RMARequired
SupportsAllLocations
TaxSchemeId
VendorId
VendorTicketAllowed
VendorTypes
Website
WorkOrderLocationDescDefault
WorkOrderLocationIdDefault

AssignedEmployees
AssignedVendors
Attachments
ContactPhoneExtension
LastChangedDateTime
Notes
ParkingLocationId
PickupDateTime
PickupName

RecordType
RepairReasonDescLanguage1
RepairReasonDescLanguage2
RepairReasonDescLanguage3
RequisitionId
ServiceRequests
Tasks
WorkOrderNoteId

More API Documentation

Check out the information on our API offerings.

The ABCs of APIs.

View all APIs that are supported by AssetWorks products by downloading the FA .json file.

Frequently Asked Questions (FAQs)

An API (Application Programming Interface) allows different software systems to communicate with each other. It defines a set of rules and endpoints that developers can use to request or send data between applications.

The API uses token based authentication. A bearer token is granted after user access and permissions are authorized. Check the documentation for the required authentication method and include the credentials in your request headers.

Rate limits restrict the number of API requests you can make in a given time period (e.g., 1000 requests per minute). The rate limit can be configured as desired. Exceeding this limit may result in temporary blocking. To avoid this, implement request throttling and monitor your usage.

API responses include status codes that indicate the type of error. Check the error message in the response body for details. Common issues include invalid parameters, authentication failures, or server errors. See the API Basics guide above for more information on the common errors.

The most common and widely used tools for testing the API include Postman and Swagger. This helps you understand the API behavior before writing production code.

You can find more help here. This will allow you the option to submit a request for more help from our customer support.

You can find release notes for each product version on the AssetWorks Community site. This site requires a login and password.