Assets & Companies

API: Assets & Companies

This page requires the X-Api-Key header and ?companyId= parameter described in the Developer REST API overview.

Endpoints

GET /api/v1/companies

List all companies in your tenant. No companyId parameter needed.

curl -s "https://acme.activohq.cloud/api/v1/companies" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY"

Response:

{
  "items": [
    { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Acme Corp" }
  ],
  "total": 1,
  "skip": 0,
  "take": 50
}

GET /api/v1/assets

Paginated asset list. Optionally filter with search (matches AssetCode, Name, or RFID EPC).

curl -s "https://acme.activohq.cloud/api/v1/assets?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6&search=laptop&skip=0&take=20" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY"

Response items include the full AssetDto (see below).

GET /api/v1/assets/

Retrieve a single asset by its GUID.

curl -s "https://acme.activohq.cloud/api/v1/assets/f47edba8-67fe-42ce-8209-0e20e1abc17e?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY"

Response fields include accumulatedDepreciation and netBookValue (read-only, computed). Linked records (category, location, custodian, etc.) are returned as { "id", "code", "name" } objects.

POST /api/v1/assets

Create an asset. Returns 201 Created with a Location header pointing to the new resource.

curl -s -X POST "https://acme.activohq.cloud/api/v1/assets?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assetCode": "LAP-0042",
    "name": "Dell Latitude 5540",
    "categoryId": "b1e2c3d4-e5f6-7890-abcd-ef1234567890",
    "acquisitionDate": "2024-01-15",
    "acquisitionCost": 1250.00,
    "salvageValue": 100.00,
    "usefulLifeMonths": 60,
    "depreciationMethod": "StraightLine",
    "status": "Active",
    "availability": "Available"
  }'

If your plan's asset limit is reached the API returns 400 with {"error":"Asset limit reached -- upgrade your plan."}.

PUT /api/v1/assets/

Update an existing asset. Returns 200 OK with the updated asset.

curl -s -X PUT "https://acme.activohq.cloud/api/v1/assets/f47edba8-67fe-42ce-8209-0e20e1abc17e?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assetCode": "LAP-0042",
    "name": "Dell Latitude 5540 (updated)",
    "categoryId": "b1e2c3d4-e5f6-7890-abcd-ef1234567890",
    "acquisitionDate": "2024-01-15",
    "acquisitionCost": 1250.00
  }'

Asset write payload (POST / PUT)

All fields are camelCase JSON. Supply these when creating or updating an asset.

Field	Type	Required	Notes
`assetCode`	string	Yes	Unique code within the company.
`name`	string	Yes	Display name.
`rfidEpc`	string	No	RFID Electronic Product Code.
`description`	string	No	Free-text description.
`serialNumber`	string	No	Manufacturer serial number.
`categoryId`	guid	Yes	Use `GET /api/v1/categories` to list ids.
`locationId`	guid	No	Use `GET /api/v1/locations`.
`costCenterId`	guid	No	Use `GET /api/v1/cost-centers`.
`custodianId`	guid	No	Use `GET /api/v1/custodians`.
`depreciationBookId`	guid	No	Use `GET /api/v1/depreciation-books`.
`assignedEmployeeId`	guid	No	Use `GET /api/v1/employees`.
`acquisitionDate`	date (ISO)	Yes	e.g. `"2024-01-15"`.
`inServiceDate`	date (ISO)	No	When the asset was placed in service.
`acquisitionCost`	decimal	Yes	Original purchase cost.
`salvageValue`	decimal	No	Residual/salvage value at end of life.
`usefulLifeMonths`	integer	No	Used for straight-line and declining-balance.
`totalEstimatedUnits`	integer	No	Used only for `UnitsOfProduction` method.
`depreciationMethod`	string	No	`StraightLine`, `DecliningBalance`, or `UnitsOfProduction`.
`status`	string	No	`Draft`, `Active`, or other defined statuses.
`availability`	string	No	`Available` or `CheckedOut`.

Read-only response fields

The AssetDto returned by GET and POST/PUT includes these additional computed fields:

Field	Notes
`accumulatedDepreciation`	Total depreciation posted to date.
`netBookValue`	`acquisitionCost - accumulatedDepreciation`.

Was this page helpful?

Previous Developer REST API Next Lookups & Master Data