GET
/
fixed-assets
Get Fixed Assets
curl --request GET \
  --url https://api.clemta.com/fixed-assets \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Fixed assets retrieved successfully",
  "data": {
    "fixed_assets": [
      {
        "id": "64b8f1a2e4b0c8d9f0123456",
        "created_at": 1640995200,
        "updated_at": 1640995200,
        "title": "Office Computer",
        "placed_in_service": 1640995200,
        "cost": 1500,
        "salvage_value": 150,
        "business_use": 100,
        "fixed_asset_number": 1,
        "fixed_asset_number_text": "AST-1"
      }
    ],
    "total": 123
  }
}

List Fixed Assets

This endpoint allows you to retrieve a list of fixed assets for a company with optional filtering and pagination.

Headers

ParameterTypeDescription
X-API-KEYstringFormation API Key (required)

Query Parameters

ParameterTypeRequiredDescription
company_idstringYesCompany ID to filter fixed assets
skipstringNoNumber of records to skip (pagination)
limitstringNoNumber of records to return (pagination)
searchstringNoSearch term to filter fixed assets
sortstringNoField to sort by
orderstringNoSort order: “asc” or “desc”
fixed_asset_numberstringNoFixed asset number filter
fixed_asset_number_valuestringNoFixed asset number value
titlestringNoTitle filter
title_valuestringNoTitle value
placed_in_servicestringNoPlaced in service filter
placed_in_service_valuestringNoPlaced in service value (timestamp)
end_placed_in_service_valuestringNoEnd placed in service value (timestamp)
coststringNoCost filter
cost_valuestringNoCost value
end_cost_valuestringNoEnd cost value
salvage_valuestringNoSalvage value filter
salvage_value_valuestringNoSalvage value
end_salvage_valuestringNoEnd salvage value
business_usestringNoBusiness use filter
business_use_valuestringNoBusiness use value
end_business_use_valuestringNoEnd business use value
created_atstringNoCreated at filter
created_at_valuestringNoCreated at value (timestamp)
end_datestringNoEnd date value (timestamp)

Parameter Examples

  • Basic request: GET /fixed-assets?company_id=64b8f1a2e4b0c8d9f0123456
  • With pagination: GET /fixed-assets?company_id=64b8f1a2e4b0c8d9f0123456&skip=0&limit=10
  • With search: GET /fixed-assets?company_id=64b8f1a2e4b0c8d9f0123456&search=computer
  • With sorting: GET /fixed-assets?company_id=64b8f1a2e4b0c8d9f0123456&sort=created_at&order=desc
  • With cost filter: GET /fixed-assets?company_id=64b8f1a2e4b0c8d9f0123456&cost=cost_value&cost_value=1000&end_cost_value=2000

Response

{
  "success": true,
  "message": "Fixed assets retrieved successfully",
  "data": {
    "fixed_assets": [
      {
        "id": "64b8f1a2e4b0c8d9f0123456",
        "title": "Office Computer",
        "placed_in_service": 1640995200,
        "cost": 1500.0,
        "salvage_value": 150.0,
        "business_use": 100.0,
        "fixed_asset_number": 1,
        "fixed_asset_number_text": "AST-1",
        "created_at": 1640995200,
        "updated_at": 1640995200
      },
      {
        "id": "64b8f1a2e4b0c8d9f0123457",
        "title": "Office Desk",
        "placed_in_service": 1640995200,
        "cost": 800.0,
        "salvage_value": 80.0,
        "business_use": 100.0,
        "fixed_asset_number": 2,
        "fixed_asset_number_text": "AST-2",
        "created_at": 1640995200,
        "updated_at": 1640995200
      }
    ],
    "total": 2
  }
}

Response Parameters

ParameterTypeDescription
successbooleanIndicates if the operation was successful
messagestringAdditional information about the operation
dataobjectResponse data for successful requests
data.fixed_assetsarrayArray of fixed asset objects
data.totalintegerTotal number of fixed assets

Fixed Asset Object Parameters

ParameterTypeDescription
idstringUnique identifier for the fixed asset
titlestringTitle/name of the fixed asset
placed_in_serviceintegerTimestamp when asset was placed in service
costnumberOriginal cost of the fixed asset
salvage_valuenumberEstimated salvage value of the asset
business_usenumberPercentage of business use (0-100)
fixed_asset_numberintegerAuto-generated fixed asset number
fixed_asset_number_textstringFormatted fixed asset number text
created_atintegerCreation timestamp
updated_atintegerLast update timestamp

Error Responses

Invalid Request (400)

{
  "success": false,
  "message": "Invalid request",
  "error": {
    "code": "INVALID_REQUEST",
    "details": "Company ID is required"
  }
}

Unauthorized (401)

{
  "success": false,
  "message": "API key is required",
  "error": {
    "code": "API_KEY_REQUIRED",
    "details": ""
  }
}

Company Not Found (404)

{
  "success": false,
  "message": "Company not found",
  "error": {
    "code": "COMPANY_NOT_FOUND",
    "details": ""
  }
}

Internal Server Error (500)

{
  "success": false,
  "message": "Internal server error",
  "error": {
    "code": "INTERNAL_ERROR",
    "details": "An unexpected error occurred."
  }
}

Notes

  • The company_id parameter is required for all requests
  • Pagination parameters (skip and limit) are optional but recommended for large datasets
  • Search functionality works across title and description fields
  • Timestamp filters should be provided in Unix timestamp format
  • Cost and salvage value filters support range queries using _value and end_ parameters

Authorizations

X-API-Key
string
header
required

Formation API key for authentication.

Query Parameters

company_id
string
required

Company ID

skip
string

Number of records to skip

limit
string

Number of records to return

Search term

sort
string

Sort field

order
enum<string>

Sort order (asc/desc)

Available options:
asc,
desc
fixed_asset_number
string

Fixed asset number filter

fixed_asset_number_value
string

Fixed asset number value

title
string

Title filter

title_value
string

Title value

placed_in_service
string

Placed in service filter

placed_in_service_value
string

Placed in service value (timestamp)

end_placed_in_service_value
string

End placed in service value (timestamp)

cost
string

Cost filter

cost_value
string

Cost value

end_cost_value
string

End cost value

salvage_value
string

Salvage value filter

salvage_value_value
string

Salvage value

end_salvage_value
string

End salvage value

business_use
string

Business use filter

business_use_value
string

Business use value

end_business_use_value
string

End business use value

created_at
string

Created at filter

created_at_value
string

Created at value (timestamp)

end_date
string

End date value (timestamp)

Response

200
application/json

Fixed assets retrieved successfully

The response is of type object.