All API resources
API reference

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

GET/api/public/v1/entities/{entityId}/fixed-asset-types

SDK: 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 objectsrequired
    Show 9 child attributes
    • idstringrequired
    • namestringrequired
    • depreciationMethodstringrequired
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • assetAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • accumulatedDepreciationAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • depreciationExpenseAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • privateUseAccountobjectrequirednullable
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Bad request - missing or invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const { data } = await prosaic.fixedAssetTypes.list(entityId);
curl
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)

POST/api/public/v1/entities/{entityId}/fixed-asset-types

SDK: 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

  • namestringrequired
  • depreciationMethodstringrequired
  • assetAccountIdstringrequired
  • accumulatedDepreciationAccountIdstringrequired
  • depreciationExpenseAccountIdstringrequired
  • privateUseAccountIdstringrequirednullable
  • usefulLifeYearsnumbernullable
  • depreciationRatenumbernullable

Responses

201 Successful response

  • dataobjectrequired
    Show 9 child attributes
    • idstringrequired
    • namestringrequired
    • depreciationMethodstringrequired
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • assetAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • accumulatedDepreciationAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • depreciationExpenseAccountobjectrequired
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
    • privateUseAccountobjectrequirednullable
      Show 4 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • mappedCodestringrequirednullable
  • 400 Bad request - validation failed
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
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
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

GET/api/public/v1/entities/{entityId}/fixed-assets

SDK: 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

  • pageinteger

    Page number (starts at 1)

    Default: 1

  • pageSizeinteger

    Number of items per page

    Default: 20

  • statusstring

    Filter by asset status

    One of: draft, active, disposed

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 22 child attributes
    • idstringrequired
    • namestringrequired
    • assetNumberstringrequirednullable
    • descriptionstringrequirednullable
    • statusstringrequired
    • purchaseDatestringrequirednullable
    • startDatestringrequirednullable
    • purchasePricenumberrequirednullable
    • residualValuenumberrequirednullable
    • businessUsePercentagenumberrequirednullable
    • initialAccumulatedDepreciationnumberrequirednullable
    • depreciationMethodstringrequirednullable
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • methodParamsanyrequired
    • disposalDatestringrequirednullable
    • disposalProceedsnumberrequirednullable
    • bookValuenumberrequirednullable
    • assetTypeobjectrequirednullable
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
    • mostRecentDepreciationRunobjectrequirednullable
      Show 3 child attributes
      • yearnumberrequired
      • monthnumberrequired
      • accumulatedDepreciationnumberrequired
    • createdAtstringrequired
    • updatedAtstringrequirednullable
  • paginationobjectrequired
    Show 6 child attributes
    • currentPagenumberrequired
    • pageSizenumberrequired
    • totalCountnumberrequired
    • totalPagesnumberrequired
    • hasNextPagebooleanrequired
    • hasPreviousPagebooleanrequired
  • 400 Bad request - missing or invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const page = await prosaic.fixedAssets.list(entityId);
curl
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

GET/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

  • entityIdstringrequired
  • assetIdstringrequired

Responses

200 Successful response

  • dataobjectrequired
    Show 22 child attributes
    • idstringrequired
    • namestringrequired
    • assetNumberstringrequirednullable
    • descriptionstringrequirednullable
    • statusstringrequired
    • purchaseDatestringrequirednullable
    • startDatestringrequirednullable
    • purchasePricenumberrequirednullable
    • residualValuenumberrequirednullable
    • businessUsePercentagenumberrequirednullable
    • initialAccumulatedDepreciationnumberrequirednullable
    • depreciationMethodstringrequirednullable
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • methodParamsanyrequired
    • disposalDatestringrequirednullable
    • disposalProceedsnumberrequirednullable
    • bookValuenumberrequirednullable
    • assetTypeobjectrequirednullable
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
    • mostRecentDepreciationRunobjectrequirednullable
      Show 3 child attributes
      • yearnumberrequired
      • monthnumberrequired
      • accumulatedDepreciationnumberrequired
    • createdAtstringrequired
    • updatedAtstringrequirednullable
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Bad request - missing or invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity or asset
  • 404 Not found - Asset not found
  • 500 Internal server error
Node SDK
const { data } = await prosaic.fixedAssets.retrieve(entityId, assetId);
curl
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

POST/api/public/v1/entities/{entityId}/fixed-assets

SDK: 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

  • namestringrequired
  • entityFixedAssetTypeIdanyrequired
  • purchaseDatestringrequired
  • startDatestringrequired
  • purchasePriceanyrequired
  • depreciationMethodstringrequired
  • assetNumberstring
  • descriptionstring
  • costLimitany
  • residualValueany
  • businessUsePercentagenumber
  • initialAccumulatedDepreciationany
  • usefulLifeYearsnumber
  • depreciationRatenumbernullable
  • immediateExpensePercentagenumber
  • dimensionOptionIdsarray of strings
  • statusstringrequired

    One of: active

One of — status: draft

  • namestringrequired
  • entityFixedAssetTypeIdstringnullable
  • assetNumberstring
  • descriptionstring
  • purchaseDatestring
  • startDatestring
  • purchasePriceany
  • costLimitany
  • residualValueany
  • businessUsePercentagenumber
  • initialAccumulatedDepreciationany
  • depreciationMethodstringnullable
  • usefulLifeYearsnumber
  • depreciationRatenumbernullable
  • immediateExpensePercentagenumber
  • dimensionOptionIdsarray of strings
  • statusstring

    One of: draft

Responses

201 Successful response

  • dataobjectrequired
    Show 22 child attributes
    • idstringrequired
    • namestringrequired
    • assetNumberstringrequirednullable
    • descriptionstringrequirednullable
    • statusstringrequired
    • purchaseDatestringrequirednullable
    • startDatestringrequirednullable
    • purchasePricenumberrequirednullable
    • residualValuenumberrequirednullable
    • businessUsePercentagenumberrequirednullable
    • initialAccumulatedDepreciationnumberrequirednullable
    • depreciationMethodstringrequirednullable
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • methodParamsanyrequired
    • disposalDatestringrequirednullable
    • disposalProceedsnumberrequirednullable
    • bookValuenumberrequirednullable
    • assetTypeobjectrequirednullable
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
    • mostRecentDepreciationRunobjectrequirednullable
      Show 3 child attributes
      • yearnumberrequired
      • monthnumberrequired
      • accumulatedDepreciationnumberrequired
    • createdAtstringrequired
    • updatedAtstringrequirednullable
  • 400 Bad request - validation failed
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 404 Asset type not found
  • 500 Internal server error
Node SDK
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
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

PATCH/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

  • entityIdstringrequired
  • assetIdstringrequired

Request body

application/json

  • namestring
  • dimensionOptionIdsarray of strings
  • depreciationRatenumbernullable
  • purchaseDatestring
  • startDatestring
  • purchasePriceany
  • residualValueany
  • initialAccumulatedDepreciationany
  • entityFixedAssetTypeIdstringnullable
  • assetNumberstringnullable
  • descriptionstringnullable
  • businessUsePercentagenumbernullable
  • depreciationMethodstringnullable

    One of: none, straight_line, diminishing_value

  • usefulLifeYearsnumbernullable
  • immediateExpensePercentagenumber

Responses

200 Successful response

  • dataobjectrequired
    Show 22 child attributes
    • idstringrequired
    • namestringrequired
    • assetNumberstringrequirednullable
    • descriptionstringrequirednullable
    • statusstringrequired
    • purchaseDatestringrequirednullable
    • startDatestringrequirednullable
    • purchasePricenumberrequirednullable
    • residualValuenumberrequirednullable
    • businessUsePercentagenumberrequirednullable
    • initialAccumulatedDepreciationnumberrequirednullable
    • depreciationMethodstringrequirednullable
    • usefulLifeYearsnumberrequirednullable
    • depreciationRatenumberrequirednullable
    • methodParamsanyrequired
    • disposalDatestringrequirednullable
    • disposalProceedsnumberrequirednullable
    • bookValuenumberrequirednullable
    • assetTypeobjectrequirednullable
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
    • mostRecentDepreciationRunobjectrequirednullable
      Show 3 child attributes
      • yearnumberrequired
      • monthnumberrequired
      • accumulatedDepreciationnumberrequired
    • createdAtstringrequired
    • updatedAtstringrequirednullable
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Invalid body, or depreciation, business use, asset number or dimension rules failed
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No edit access to the specified entity
  • 404 Fixed asset or asset type not found
  • 409 The asset is not a draft
  • 500 Internal server error
Node SDK
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
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
  }'