All API resources
Fixed assets
Fixed assets and their types, for depreciation.
Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.
List fixed asset types (categories) for an entity
/api/public/v1/entities/{entityId}/fixed-asset-typesSDK: prosaic.fixedAssetTypes.list(entityId)
Returns all fixed asset types (categories) configured for the specified entity. Asset types define default depreciation settings and account mappings. Includes mappedCode on accounts to support external system integrations (e.g., Xero).
Path parameters
entityIdstringrequired
Responses
200 Successful response
dataarray of objectsrequiredShow 9 child attributesHide child attributes
idstringrequirednamestringrequireddepreciationMethodstringrequiredusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullableassetAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
accumulatedDepreciationAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
depreciationExpenseAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
privateUseAccountobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Bad request - missing or invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const { data } = await prosaic.fixedAssetTypes.list(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-asset-types \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a new fixed asset type (category)
/api/public/v1/entities/{entityId}/fixed-asset-typesSDK: prosaic.fixedAssetTypes.create(entityId, params)
Creates a new fixed asset type for the specified entity. Asset types define default depreciation settings and account mappings for fixed assets.
Path parameters
entityIdstringrequired
Request body
application/json
namestringrequireddepreciationMethodstringrequiredassetAccountIdstringrequiredaccumulatedDepreciationAccountIdstringrequireddepreciationExpenseAccountIdstringrequiredprivateUseAccountIdstringrequirednullableusefulLifeYearsnumbernullabledepreciationRatenumbernullable
Responses
201 Successful response
dataobjectrequiredShow 9 child attributesHide child attributes
idstringrequirednamestringrequireddepreciationMethodstringrequiredusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullableassetAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
accumulatedDepreciationAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
depreciationExpenseAccountobjectrequiredShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
privateUseAccountobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredmappedCodestringrequirednullable
400Bad request - validation failed401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const { data } = await prosaic.fixedAssetTypes.create(entityId, {
name: 'Example Ltd',
depreciationMethod: 'string',
assetAccountId: 'ASSET_ACCOUNT_ID',
accumulatedDepreciationAccountId: 'ACCUMULATED_DEPRECIATION_ACCOUNT_ID',
depreciationExpenseAccountId: 'DEPRECIATION_EXPENSE_ACCOUNT_ID',
privateUseAccountId: 'PRIVATE_USE_ACCOUNT_ID',
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-asset-types \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"depreciationMethod": "string",
"assetAccountId": "ASSET_ACCOUNT_ID",
"accumulatedDepreciationAccountId": "ACCUMULATED_DEPRECIATION_ACCOUNT_ID",
"depreciationExpenseAccountId": "DEPRECIATION_EXPENSE_ACCOUNT_ID",
"privateUseAccountId": "PRIVATE_USE_ACCOUNT_ID"
}'List fixed assets for an entity
/api/public/v1/entities/{entityId}/fixed-assetsSDK: prosaic.fixedAssets.list(entityId, params)
Returns paginated fixed assets for the specified entity. Includes asset details, depreciation information, and current book values.
Path parameters
entityIdstringrequired
Query parameters
pageintegerPage number (starts at 1)
Default:
1pageSizeintegerNumber of items per page
Default:
20statusstringFilter by asset status
One of:
draft,active,disposed
Responses
200 Successful response
dataarray of objectsrequiredShow 22 child attributesHide child attributes
idstringrequirednamestringrequiredassetNumberstringrequirednullabledescriptionstringrequirednullablestatusstringrequiredpurchaseDatestringrequirednullablestartDatestringrequirednullablepurchasePricenumberrequirednullableresidualValuenumberrequirednullablebusinessUsePercentagenumberrequirednullableinitialAccumulatedDepreciationnumberrequirednullabledepreciationMethodstringrequirednullableusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullablemethodParamsanyrequireddisposalDatestringrequirednullabledisposalProceedsnumberrequirednullablebookValuenumberrequirednullableassetTypeobjectrequirednullableShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
mostRecentDepreciationRunobjectrequirednullableShow 3 child attributesHide child attributes
yearnumberrequiredmonthnumberrequiredaccumulatedDepreciationnumberrequired
createdAtstringrequiredupdatedAtstringrequirednullable
paginationobjectrequiredShow 6 child attributesHide child attributes
currentPagenumberrequiredpageSizenumberrequiredtotalCountnumberrequiredtotalPagesnumberrequiredhasNextPagebooleanrequiredhasPreviousPagebooleanrequired
400Bad request - missing or invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const page = await prosaic.fixedAssets.list(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-assets \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get a single fixed asset by ID
/api/public/v1/entities/{entityId}/fixed-assets/{assetId}SDK: prosaic.fixedAssets.retrieve(entityId, assetId)
Returns a single fixed asset by its ID for the specified entity. Includes asset details, depreciation information, and current book value.
Path parameters
entityIdstringrequiredassetIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 22 child attributesHide child attributes
idstringrequirednamestringrequiredassetNumberstringrequirednullabledescriptionstringrequirednullablestatusstringrequiredpurchaseDatestringrequirednullablestartDatestringrequirednullablepurchasePricenumberrequirednullableresidualValuenumberrequirednullablebusinessUsePercentagenumberrequirednullableinitialAccumulatedDepreciationnumberrequirednullabledepreciationMethodstringrequirednullableusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullablemethodParamsanyrequireddisposalDatestringrequirednullabledisposalProceedsnumberrequirednullablebookValuenumberrequirednullableassetTypeobjectrequirednullableShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
mostRecentDepreciationRunobjectrequirednullableShow 3 child attributesHide child attributes
yearnumberrequiredmonthnumberrequiredaccumulatedDepreciationnumberrequired
createdAtstringrequiredupdatedAtstringrequirednullable
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Bad request - missing or invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity or asset404Not found - Asset not found500Internal server error
const { data } = await prosaic.fixedAssets.retrieve(entityId, assetId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-assets/$ASSET_ID \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a new fixed asset
/api/public/v1/entities/{entityId}/fixed-assetsSDK: prosaic.fixedAssets.create(entityId, params)
Creates a new fixed asset for the specified entity. Can create the asset as either a draft or immediately as active. When creating as active, all required fields must be provided and pass validation.
Path parameters
entityIdstringrequired
Request body
application/json
One of — status: active
namestringrequiredentityFixedAssetTypeIdanyrequiredpurchaseDatestringrequiredstartDatestringrequiredpurchasePriceanyrequireddepreciationMethodstringrequiredassetNumberstringdescriptionstringcostLimitanyresidualValueanybusinessUsePercentagenumberinitialAccumulatedDepreciationanyusefulLifeYearsnumberdepreciationRatenumbernullableimmediateExpensePercentagenumberdimensionOptionIdsarray of stringsstatusstringrequiredOne of:
active
One of — status: draft
namestringrequiredentityFixedAssetTypeIdstringnullableassetNumberstringdescriptionstringpurchaseDatestringstartDatestringpurchasePriceanycostLimitanyresidualValueanybusinessUsePercentagenumberinitialAccumulatedDepreciationanydepreciationMethodstringnullableusefulLifeYearsnumberdepreciationRatenumbernullableimmediateExpensePercentagenumberdimensionOptionIdsarray of stringsstatusstringOne of:
draft
Responses
201 Successful response
dataobjectrequiredShow 22 child attributesHide child attributes
idstringrequirednamestringrequiredassetNumberstringrequirednullabledescriptionstringrequirednullablestatusstringrequiredpurchaseDatestringrequirednullablestartDatestringrequirednullablepurchasePricenumberrequirednullableresidualValuenumberrequirednullablebusinessUsePercentagenumberrequirednullableinitialAccumulatedDepreciationnumberrequirednullabledepreciationMethodstringrequirednullableusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullablemethodParamsanyrequireddisposalDatestringrequirednullabledisposalProceedsnumberrequirednullablebookValuenumberrequirednullableassetTypeobjectrequirednullableShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
mostRecentDepreciationRunobjectrequirednullableShow 3 child attributesHide child attributes
yearnumberrequiredmonthnumberrequiredaccumulatedDepreciationnumberrequired
createdAtstringrequiredupdatedAtstringrequirednullable
400Bad request - validation failed401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity404Asset type not found500Internal server error
const { data } = await prosaic.fixedAssets.create(entityId, {
name: 'Example Ltd',
entityFixedAssetTypeId: 'ENTITY_FIXED_ASSET_TYPE_ID',
purchaseDate: '2026-04-01',
startDate: '2026-04-01',
purchasePrice: '100.00',
depreciationMethod: 'string',
status: 'active',
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-assets \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"entityFixedAssetTypeId": "ENTITY_FIXED_ASSET_TYPE_ID",
"purchaseDate": "2026-04-01",
"startDate": "2026-04-01",
"purchasePrice": "100.00",
"depreciationMethod": "string",
"status": "active"
}'Update a draft fixed asset
/api/public/v1/entities/{entityId}/fixed-assets/{assetId}SDK: prosaic.fixedAssets.update(entityId, assetId, params)
Updates only the supplied fields on a draft fixed asset. Omitted fields keep their stored values; send null to clear a nullable field. The asset's own depreciation method, rate and useful life override its asset type's defaults. Rate and useful life are exclusive: setting one clears the other, and method "none" clears both. Active and disposed assets cannot be edited here.
Path parameters
entityIdstringrequiredassetIdstringrequired
Request body
application/json
namestringdimensionOptionIdsarray of stringsdepreciationRatenumbernullablepurchaseDatestringstartDatestringpurchasePriceanyresidualValueanyinitialAccumulatedDepreciationanyentityFixedAssetTypeIdstringnullableassetNumberstringnullabledescriptionstringnullablebusinessUsePercentagenumbernullabledepreciationMethodstringnullableOne of:
none,straight_line,diminishing_valueusefulLifeYearsnumbernullableimmediateExpensePercentagenumber
Responses
200 Successful response
dataobjectrequiredShow 22 child attributesHide child attributes
idstringrequirednamestringrequiredassetNumberstringrequirednullabledescriptionstringrequirednullablestatusstringrequiredpurchaseDatestringrequirednullablestartDatestringrequirednullablepurchasePricenumberrequirednullableresidualValuenumberrequirednullablebusinessUsePercentagenumberrequirednullableinitialAccumulatedDepreciationnumberrequirednullabledepreciationMethodstringrequirednullableusefulLifeYearsnumberrequirednullabledepreciationRatenumberrequirednullablemethodParamsanyrequireddisposalDatestringrequirednullabledisposalProceedsnumberrequirednullablebookValuenumberrequirednullableassetTypeobjectrequirednullableShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
mostRecentDepreciationRunobjectrequirednullableShow 3 child attributesHide child attributes
yearnumberrequiredmonthnumberrequiredaccumulatedDepreciationnumberrequired
createdAtstringrequiredupdatedAtstringrequirednullable
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Invalid body, or depreciation, business use, asset number or dimension rules failed401Unauthorized - Invalid or missing API key403Forbidden - No edit access to the specified entity404Fixed asset or asset type not found409The asset is not a draft500Internal server error
const { data } = await prosaic.fixedAssets.update(entityId, assetId, {
name: 'Example Ltd',
dimensionOptionIds: ['DIMENSION_OPTION_ID'],
depreciationRate: 1,
purchaseDate: '2026-04-01',
startDate: '2026-04-01',
purchasePrice: '100.00',
residualValue: 'string',
initialAccumulatedDepreciation: 'string',
entityFixedAssetTypeId: 'ENTITY_FIXED_ASSET_TYPE_ID',
assetNumber: 'string',
description: 'Office supplies',
businessUsePercentage: 1,
depreciationMethod: 'none',
usefulLifeYears: 1,
immediateExpensePercentage: 1,
});curl -X PATCH https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/fixed-assets/$ASSET_ID \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"dimensionOptionIds": [
"DIMENSION_OPTION_ID"
],
"depreciationRate": 1,
"purchaseDate": "2026-04-01",
"startDate": "2026-04-01",
"purchasePrice": "100.00",
"residualValue": "string",
"initialAccumulatedDepreciation": "string",
"entityFixedAssetTypeId": "ENTITY_FIXED_ASSET_TYPE_ID",
"assetNumber": "string",
"description": "Office supplies",
"businessUsePercentage": 1,
"depreciationMethod": "none",
"usefulLifeYears": 1,
"immediateExpensePercentage": 1
}'