TRANXACT.AI Help

Accounting · Asset Accounting

Asset Classes

What kind of thing it is, and where its postings go — so a hundred laptops do not each carry their own account determination typed by hand.

Type REST6 operationsBase path /api/accounting/asset-classesPublished as /api/v1/asset-classes

Download specification (OpenAPI 3.1) Screen: Asset Classes

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Asset Classes on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableacct.asset_classes · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/asset-classesList asset classes

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "category": "text",
      "cost_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "accum_depr_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "depr_expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "disposal_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "gain_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "loss_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "impairment_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "revaluation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/asset-classes?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/asset-classes/{id}Read one asset class

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category": "text",
  "cost_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "accum_depr_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "depr_expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "disposal_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gain_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "impairment_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "revaluation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/asset-classes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/asset-classesCreate a asset class

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
parent_iduuidNoParent class
categorytextNoCategory
cost_account_iduuidNoCost account
accum_depr_account_iduuidNoAccumulated depreciation account
depr_expense_account_iduuidNoDepreciation expense account
disposal_account_iduuidNoDisposal account
gain_account_iduuidNoGain on disposal account
loss_account_iduuidNoLoss on disposal account
impairment_account_iduuidNoImpairment account
revaluation_reserve_account_iduuidNoRevaluation reserve account
default_life_monthsintegerNoDefault useful life (months)
default_methodtextNoDefault method
default_salvage_pctnumericNoDefault salvage %
low_value_thresholdnumericNoLow-value threshold — Below this an asset is written off in the year of purchase rather than capitalised.
capitalisation_thresholdnumericNoCapitalisation threshold
requires_locationbooleanNoRequires a location
requires_custodianbooleanNoRequires a custodian
requires_serialbooleanNoRequires a serial number
number_prefixtextNoNumber prefix
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category": "text",
  "cost_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "accum_depr_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category": "text",
  "cost_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "accum_depr_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "depr_expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "disposal_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gain_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "impairment_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "revaluation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/asset-classes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","category":"text","cost_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","accum_depr_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/asset-classes/{id}Change a asset class

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
parent_iduuidNoParent class
categorytextNoCategory
cost_account_iduuidNoCost account
accum_depr_account_iduuidNoAccumulated depreciation account
depr_expense_account_iduuidNoDepreciation expense account
disposal_account_iduuidNoDisposal account
gain_account_iduuidNoGain on disposal account
loss_account_iduuidNoLoss on disposal account
impairment_account_iduuidNoImpairment account
revaluation_reserve_account_iduuidNoRevaluation reserve account
default_life_monthsintegerNoDefault useful life (months)
default_methodtextNoDefault method
default_salvage_pctnumericNoDefault salvage %
low_value_thresholdnumericNoLow-value threshold — Below this an asset is written off in the year of purchase rather than capitalised.
capitalisation_thresholdnumericNoCapitalisation threshold
requires_locationbooleanNoRequires a location
requires_custodianbooleanNoRequires a custodian
requires_serialbooleanNoRequires a serial number
number_prefixtextNoNumber prefix
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category": "text",
  "cost_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "accum_depr_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "depr_expense_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "disposal_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gain_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "impairment_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "revaluation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/asset-classes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/asset-classes/{id}Delete a asset class

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/asset-classes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/asset-classes/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/asset-classes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a asset class, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
parent_iduuidread, writeParent class
categorytextread, writeCategory
cost_account_iduuidread, writeCost account
accum_depr_account_iduuidread, writeAccumulated depreciation account
depr_expense_account_iduuidread, writeDepreciation expense account
disposal_account_iduuidread, writeDisposal account
gain_account_iduuidread, writeGain on disposal account
loss_account_iduuidread, writeLoss on disposal account
impairment_account_iduuidread, writeImpairment account
revaluation_reserve_account_iduuidread, writeRevaluation reserve account
default_life_monthsintegerread, writeDefault useful life (months)
default_methodtextread, writeDefault method
default_salvage_pctnumericread, writeDefault salvage %
low_value_thresholdnumericread, writeLow-value threshold — Below this an asset is written off in the year of purchase rather than capitalised.
capitalisation_thresholdnumericread, writeCapitalisation threshold
requires_locationbooleanread, writeRequires a location
requires_custodianbooleanread, writeRequires a custodian
requires_serialbooleanread, writeRequires a serial number
number_prefixtextread, writeNumber prefix
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Asset Classes for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.