Asset Schema
Schemas
Device_View
Paginated list response for GET /Asset.
| Property | Type | Description |
|---|---|---|
page_no | integer | Current page number. |
page_size | integer | Number of records per page. |
record_count | integer (int64) | Total number of matching records. |
assets | array[Device_List] | Array of asset summary objects. |
columns_id | integer | Active column profile ID. |
columns_tilehtml | string | HTML template for tile view. |
columns | array[ViewColumnsDetails] | Column profile details. |
xtypeunamecancreatenew | array[RT_Permission] | Permissions indicating which asset types can be created. |
Device
Full asset/device object used for create, update, and single-record responses.
| Property | Type | Description |
|---|---|---|
id | integer | Asset ID. |
inventory_number | string | Asset inventory/tag number. |
key_field / key_field2 / key_field3 | string | Primary identifying fields (e.g., hostname, serial number). |
client_id | integer | ID of the owning client. |
client_name | string | Name of the owning client. |
site_id | integer | Site ID. |
site_name | string | Site name. |
assettype_id | integer | Asset type ID. |
assettype_name | string | Asset type name. |
inactive | boolean | Whether the asset is inactive. |
is_primary_asset | boolean | Whether this is a primary asset. |
parent_id | integer | Parent asset ID. |
child_id | integer | Child asset ID. |
warranty_end | datetime | Warranty expiry date. |
warranty_note | string | Warranty notes. |
supplier_id | integer | Supplier ID. |
supplier_name | string | Supplier name. |
manufacturer_id | integer | Manufacturer ID. |
manufacturer_name | string | Manufacturer name. |
supplier_contract_id | integer | Supplier contract ID. |
contract_id | integer | Contract ID. |
contract_value | number | Contract value. |
fields | array[FieldHelper] | Built-in asset type fields. |
customfields | array[CustomField] | Custom fields for the asset type. |
notes | string | Asset notes. |
criticality | integer | Criticality level. |
service_id | integer | Linked service ID. |
business_owner_id | integer | Business owner user ID. |
technical_owner_id | integer | Technical owner user ID. |
username | string | Associated username. |
users | array[Users_List] | Users associated with the asset. |
children | array[Device] | Child device objects. |
parent_assets | array[Device_List] | Parent asset summaries. |
child_assets | array[Device_List] | Child asset summaries. |
hierarchy | array[Device] | Full hierarchy chain. |
software | array[DeviceApplications] | Software installed on the device. |
services | array[ServSite_List] | Linked services. |
contracts | array[ContractHeader_List] | Linked contracts. |
bookmarked | boolean | Whether the asset is bookmarked. |
open_ticket_count | integer | Number of open tickets linked to this asset. |
total_ticket_count | integer | Total tickets linked to this asset. |
intune_id | string | Microsoft Intune device ID. |
azure_userid | string | Azure AD user ID. |
jamf_id | integer | JAMF device ID. |
prtg_id | integer | PRTG sensor ID. |
domotz_agentid | integer | Domotz agent ID. |
lansweeper_id | string | Lansweeper asset ID. |
ateraid | string | Atera agent ID. |
itglue_id | string | IT Glue asset ID. |
dlastupdate | datetime | Last update timestamp. |
guid | string | Asset GUID. |
os_override | string | Override for the OS field. |
phone_number | string | Associated phone number. |
item_id | integer | Linked inventory item ID. |
itemstock_id | integer | Linked stock item ID. |
DeviceChange
Audit log entry for a change made to an asset field.
| Property | Type | Description |
|---|---|---|
id | integer (int64) | Change record ID. |
asset_id | integer | Asset that was changed. |
field_id | integer | ID of the field that changed. |
field_name | string | Name of the field that changed. |
field_desc | string | Description of the change. |
old_value | string | Previous value. |
new_value | string | New value after change. |
who | string | Name of the user who made the change. |
who_id | integer | ID of the user who made the change. |
datetime | datetime | When the change occurred. |
old_client | integer | Previous client ID (if changed). |
new_client | integer | New client ID (if changed). |
old_site | integer | Previous site ID (if changed). |
new_site | integer | New site ID (if changed). |
customfield_id | integer | Custom field ID if a custom field changed. |
software_id | integer | Software record ID if a software change. |
software_user_id | integer | User ID associated with the software change. |
Licence_List
Software licence record used in list and create operations.
| Property | Type | Description |
|---|---|---|
id | integer | Licence ID. |
name | string | Licence/product name. |
type | integer | Licence type. |
count | integer | Total licence seats. |
consumedcount | integer | Consumed licence seats. |
licences_in_use | integer | Licences currently in use. |
licences_available | integer | Licences available. |
client_id | integer | Owning client ID. |
client_name | string | Owning client name. |
site_id | integer | Site ID. |
site_name | string | Site name. |
tenant_id | string | Tenant ID (for M365/cloud licences). |
tenant_name | string | Tenant name. |
purchase_price | number | Purchase price. |
price | number | Current price. |
monthly_price | number | Monthly price. |
monthly_cost | number | Monthly cost. |
start_date | datetime | Licence start date. |
end_date | datetime | Licence end date. |
manufacturer | string | Licence manufacturer/publisher. |
vendor | string | Vendor name. |
supplier_id | integer | Supplier ID. |
billing_cycle | string | Billing cycle (e.g., monthly, annual). |
term_duration | string | Term duration. |
status | string | Licence status. |
autorenew | boolean | Whether the licence auto-renews. |
is_active | boolean | Whether the licence is active. |
licence_roles | array[LicenceRole] | Role assignments for the licence. |
configuration_items | array[Device_List] | Devices assigned to this licence. |
parent_id | integer | Parent licence ID. |
azure_connection_id | integer | Linked Azure AD connection ID. |
product_sku | string | Product SKU. |
vendor_product_sku | string | Vendor product SKU. |
notes | string | Licence notes. |
LicenceInfo
Instance-level licence information (HaloPSA platform licence details).
| Property | Type | Description |
|---|---|---|
id | uuid | LicenceInfo record ID. |
site_id | integer | Site ID. |
client_id | integer | Client ID. |
client_name | string | Client name. |
version | string | HaloPSA version. |
apiurl | string | API URL for this instance. |
organisationname | string | Organisation name. |
is_trial | boolean | Whether this is a trial instance. |
support_type | integer | Support type. |
trialexpiry | datetime | Trial expiry date. |
registrationdate | datetime | Registration date. |