Capital asset types

List, create, update, and delete capital asset type reference data used by capital assets and journal entries.

   
SDK service client.CapitalAssetTypes (CapitalAssetTypesService)
FreeAgent docs dev.freeagent.com/docs/capital_asset_types
Sample app /capital-asset-types (list), /capital-asset-types/detail (CRUD)

Methods

ListAsync

Task<IReadOnlyList<CapitalAssetType>> ListAsync(CancellationToken cancellationToken = default)

HTTP: GET /v2/capital_asset_types

Returns: All capital asset types for the company (not paginated).


GetCapitalAssetTypeAsync

Task<CapitalAssetType> GetCapitalAssetTypeAsync(long capitalAssetTypeId, CancellationToken cancellationToken = default)

HTTP: GET /v2/capital_asset_types/:id


CreateCapitalAssetTypeAsync

Task<CapitalAssetType> CreateCapitalAssetTypeAsync(
    CreateCapitalAssetTypeRequest request,
    CancellationToken cancellationToken = default)

HTTP: POST /v2/capital_asset_types

Required request field: name.

Sample:

var type = await client.CapitalAssetTypes.CreateCapitalAssetTypeAsync(new CreateCapitalAssetTypeRequest
{
    Name = "Workshop equipment"
});

UpdateCapitalAssetTypeAsync

Task<CapitalAssetType> UpdateCapitalAssetTypeAsync(
    long capitalAssetTypeId,
    UpdateCapitalAssetTypeRequest request,
    CancellationToken cancellationToken = default)

HTTP: PUT /v2/capital_asset_types/:id

Only user-created types with no linked capital asset items can be updated.


DeleteCapitalAssetTypeAsync

Task DeleteCapitalAssetTypeAsync(long capitalAssetTypeId, CancellationToken cancellationToken = default)

HTTP: DELETE /v2/capital_asset_types/:id

Only user-created types with no linked capital asset items can be deleted.

Models

Type Role
CapitalAssetType Read model (url, name, system_default, created_at, updated_at)
CreateCapitalAssetTypeRequest Create payload (name)
UpdateCapitalAssetTypeRequest Update payload (name)
CapitalAssetTypeReference Typed URI reference for linked resources

Copyright © Mark Heydon. Distributed under the MIT licence.

This site uses Just the Docs, a documentation theme for Jekyll.