For the complete documentation index, see llms.txt. This page is also available as Markdown.

🏭 Assets

Company asset tracking and management

List assets

get
/api/v1.0/organisation/{org_uid}/assets/

Get a paginated list of assets with optional filters

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Query parameters
asset_typestringOptional

Filter assets by asset type

assigned_tostringOptional

Filter assets by assigned person unique_id

categorystringOptional

Filter assets by category

conditionstringOptional

Filter assets by condition

namestringOptional

Filter assets by name (case-insensitive partial match)

searchstringOptional

Search assets by name, asset code, or serial number

statusstringOptional

Filter assets by status (active, inactive, disposed, etc.)

Responses
200Success
application/json

Lightweight serializer for asset lists.

unique_idstring Β· max: 100 Β· nullableOptional
namestringRead-onlyRequired
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional
  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Original purchase price

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
purchase_datestring Β· dateRequired
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
image_urlstring Β· nullableRead-onlyRequired
is_warranty_expiredbooleanRead-onlyRequired
date_createdstring Β· date-time Β· nullableOptional
get
/api/v1.0/organisation/{org_uid}/assets/

Create asset

post
/api/v1.0/organisation/{org_uid}/assets/create/

Create a new asset

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Body

Full serializer for Asset creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Required
descriptionstring Β· nullableOptional
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumRequired

Asset type is required.

  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Purchase price is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired

Purchase date is required.

warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
assigned_to_idstring Β· min: 1 Β· nullableWrite-onlyOptional

Unique ID of person to assign asset to

imagestring Β· binary Β· nullableOptional

Asset image for identification

receipt_documentstring Β· binary Β· nullableOptional

Upload receipt, invoice, or purchase document (PDF, DOC, DOCX, JPG, PNG)

supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
Responses
post
/api/v1.0/organisation/{org_uid}/assets/create/

Retrieve asset

get
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/

Get detailed information about a specific asset

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
200Success
application/json

Detailed serializer for single asset retrieval.

unique_idstring Β· max: 100 Β· nullableOptional
namestringRead-onlyRequired
descriptionstringRead-onlyRequired
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional
  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Original purchase price

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired
warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
image_urlstring Β· nullableRead-onlyRequired
receipt_document_urlstring Β· nullableRead-onlyRequired
supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
is_warranty_expiredbooleanRead-onlyRequired
years_since_purchaseinteger Β· nullableRead-onlyRequired
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
get
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/

Update asset

put
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/update/

Update asset information (PUT for full update, PATCH for partial)

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Full serializer for Asset creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Required
descriptionstring Β· nullableOptional
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumRequired

Asset type is required.

  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Purchase price is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired

Purchase date is required.

warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
assigned_to_idstring Β· min: 1 Β· nullableWrite-onlyOptional

Unique ID of person to assign asset to

imagestring Β· binary Β· nullableOptional

Asset image for identification

receipt_documentstring Β· binary Β· nullableOptional

Upload receipt, invoice, or purchase document (PDF, DOC, DOCX, JPG, PNG)

supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
Responses
200Success
application/json

Detailed serializer for single asset retrieval.

unique_idstring Β· max: 100 Β· nullableOptional
namestringRead-onlyRequired
descriptionstringRead-onlyRequired
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional
  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Original purchase price

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired
warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
image_urlstring Β· nullableRead-onlyRequired
receipt_document_urlstring Β· nullableRead-onlyRequired
supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
is_warranty_expiredbooleanRead-onlyRequired
years_since_purchaseinteger Β· nullableRead-onlyRequired
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
put
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/update/

Update asset

patch
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/update/

Update asset information (PUT for full update, PATCH for partial)

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Full serializer for Asset creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Optional
descriptionstring Β· nullableOptional
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional

Asset type is required.

  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalOptional

Purchase price is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateOptional

Purchase date is required.

warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
assigned_to_idstring Β· min: 1 Β· nullableWrite-onlyOptional

Unique ID of person to assign asset to

imagestring Β· binary Β· nullableOptional

Asset image for identification

receipt_documentstring Β· binary Β· nullableOptional

Upload receipt, invoice, or purchase document (PDF, DOC, DOCX, JPG, PNG)

supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
Responses
200Success
application/json

Detailed serializer for single asset retrieval.

unique_idstring Β· max: 100 Β· nullableOptional
namestringRead-onlyRequired
descriptionstringRead-onlyRequired
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional
  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Original purchase price

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired
warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
image_urlstring Β· nullableRead-onlyRequired
receipt_document_urlstring Β· nullableRead-onlyRequired
supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
is_warranty_expiredbooleanRead-onlyRequired
years_since_purchaseinteger Β· nullableRead-onlyRequired
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
patch
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/update/

Perform action on asset

get
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/action/

Perform actions on an asset (deactivate, mark_disposed). Uses query parameters.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Query parameters
actionstring Β· enumRequired

Action to perform: deactivate or mark_disposed

Possible values:
Responses
200Success
application/json

Detailed serializer for single asset retrieval.

unique_idstring Β· max: 100 Β· nullableOptional
namestringRead-onlyRequired
descriptionstringRead-onlyRequired
asset_codestring Β· max: 100 Β· nullableOptional
serial_numberstring Β· max: 200 Β· nullableOptional
asset_typestring Β· enumOptional
  • ppe - Property, Plant & Equipment
  • equipment - Equipment
  • furniture - Furniture & Fixtures
  • vehicle - Vehicle
  • computer - Computer & IT Equipment
  • software - Software
  • building - Building
  • land - Land
  • intangible - Intangible Asset
  • other - Other
Possible values:
categorystring Β· max: 200 Β· nullableOptional
brandstring Β· max: 200 Β· nullableOptional
modelstring Β· max: 200 Β· nullableOptional
purchase_pricestring Β· decimalRequired

Original purchase price

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
useful_life_yearsinteger Β· min: 1 Β· max: 100Optional

Expected useful life in years

purchase_datestring Β· dateRequired
warranty_expiry_datestring Β· date Β· nullableOptional
disposal_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • active - Active
  • inactive - Inactive
  • disposed - Disposed
  • sold - Sold
  • damaged - Damaged
  • under_repair - Under Repair
  • stolen - Stolen
Possible values:
conditionstring Β· enumOptional
  • excellent - Excellent
  • good - Good
  • fair - Fair
  • poor - Poor
  • damaged - Damaged
Possible values:
locationstring Β· max: 300 Β· nullableOptional
image_urlstring Β· nullableRead-onlyRequired
receipt_document_urlstring Β· nullableRead-onlyRequired
supplier_namestring Β· max: 300 Β· nullableOptional
purchase_order_numberstring Β· max: 100 Β· nullableOptional
invoice_numberstring Β· max: 100 Β· nullableOptional
is_warranty_expiredbooleanRead-onlyRequired
years_since_purchaseinteger Β· nullableRead-onlyRequired
date_createdstring Β· date-time Β· nullableOptional
last_updatedstring Β· date-time Β· nullableOptional
get
/api/v1.0/organisation/{org_uid}/assets/{unique_id}/action/

Last updated