GET
View a fixed asset (client account)
Client space Accounting module For: Accountant · Permission: fixed_assets.retrieve Conditions
  • The accounting module must be part of the organization’s plan.
Part of Fixed assets and depreciation.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fixedAsset
string
required

Identifier of the fixed asset (27-character KSUID).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, code, name, description, asset_account_id, depreciation_account_id, expense_account_id, acquisition_date, in_service_date, acquisition_cost, salvage_value, useful_life_months, method, fiscal_method, fiscal_rate, fiscal_useful_life_months, fiscal_accumulated_depreciation, status, accumulated_depreciation, acquisition_journal_entry_id, disposal_date, disposal_proceeds, disposal_journal_entry_id, currency_code, currency_exponent, created_by, created_by_type, version, created_at, updated_at, net_book_value.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: assetAccount, depreciationAccount, expenseAccount.

Response

Resource.

id

Identifier of the asset (27-character KSUID).

owner_type

Kind of book that owns the asset; set by the server.

code

Asset number allocated by the server per book, in the form IM-000001.

name

Name of the asset.

description

Free-text description; null when none.

asset_account_id

Identifier of the asset account (class 2) the cost is carried on.

asset_account
object

The asset account, an object, present only with ?include=assetAccount and when the caller may retrieve accounting accounts.

depreciation_account_id

Identifier of the accumulated depreciation account (class 28).

depreciation_account
object

The depreciation account, an object, present only with ?include=depreciationAccount and when the caller may retrieve accounting accounts.

expense_account_id

Identifier of the depreciation expense account (class 68).

expense_account
object

The expense account, an object, present only with ?include=expenseAccount and when the caller may retrieve accounting accounts.

acquisition_date

Date the asset was acquired, ISO 8601 date.

in_service_date

Date depreciation starts from, ISO 8601 date. The service month counts when its day is 15 or earlier.

acquisition_cost
integer

Cost of the asset in minor units (divide by 10 to the power currency_exponent).

salvage_value
integer

Residual value in minor units, below the cost; 0 when not sent. The depreciable base is cost minus salvage value.

useful_life_months
integer

Economic useful life in months, between 1 and 1200.

method

Economic depreciation method; always linear, set by the server.

fiscal_method

Fiscal depreciation method, linear or declining; null when the asset follows its economic plan for tax too.

fiscal_rate
integer | null

Rate of the declining fiscal method; null otherwise. Integer from 1 to 100000, used in the declining-balance computation: each month takes the larger of the remaining base times rate divided by 120000 and the remaining base spread over the months left.

fiscal_useful_life_months
integer | null

Fiscal useful life in months; null without a fiscal plan.

fiscal_accumulated_depreciation
integer

Fiscal depreciation recorded so far, in minor units.

status

active while depreciation can still run, fully_depreciated once the depreciable base is reached, disposed after a sale or scrapping.

accumulated_depreciation
integer

Economic depreciation posted so far, in minor units.

net_book_value
integer

Acquisition cost minus accumulated depreciation, in minor units; computed by the server.

acquisition_journal_entry_id

Identifier of the posted accounting entry that recorded the purchase, when linked; null otherwise.

disposal_date

Date of the disposal, ISO 8601 date; null until disposed.

disposal_proceeds
integer | null

Proceeds of the disposal in minor units; null until disposed.

disposal_journal_entry_id

Identifier of the disposal accounting entry; null until disposed.

currency_code

Three-letter currency code, taken from the fiscal year of the in-service date.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

created_by

Identifier of the member or agent account that registered the asset.

created_by_type

Kind of actor that registered the asset.

version
integer

Counter starting at 1 and increased by every change, run, rollback or disposal.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).