Asset classifications

Asset classifications contain information about General Ledger (GL) accounts and depreciation rules. Use asset classifications to ensure consistent treatment of similar assets.

List asset classifications

get/objects/fixed-assets/asset-classification

Returns a collection with a key, ID, and link for each asset classification. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "101",
      • "id": "Classification Id 101",
      • "href": "/objects/fixed-assets/asset-classification/101"
      },
    • {
      • "key": "102",
      • "id": "Classification Id 102",
      • "href": "/objects/fixed-assets/asset-classification/102"
      },
    • {
      • "key": "103",
      • "id": "Classification Id 103",
      • "href": "/objects/fixed-assets/asset-classification/103"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 3,
    • "totalError": 0
    }
}

Create an asset classification

post/objects/fixed-assets/asset-classification

Creates a new asset classification.

SecurityOAuth2
Request
Request Body schema: application/json
required

Creates an asset classification

id
required
string

Unique ID for the asset classification.

Example: "CE-1"
name
required
string

Name for the asset classification.

Example: "Computer Equipment"
object

Multi-entity location.

object

The General Ledger (GL) account for transactions involving asset cost and disposal.

key
string

System-assigned unique key for the asset GL account.

Example: "93"
id
string

Unique ID for the asset GL account.

Example: "1500"
object

The General Ledger (GL) account where depreciation transactions are recorded as credits.

key
string

System-assigned key for the accumulated depreciation GL account.

Example: "98"
id
string

Unique ID for the accumulated depreciation GL account.

Example: "1901"
object

The General Ledger (GL) account where depreciation transactions are recorded as debits.

key
string

System-assigned unique key for the depreciation expense GL account.

Example: "270"
id
string

Unique ID for the depreciation expense GL account.

Example: "6350"
object

The General Ledger account where the sale price is recorded as a debit. Typically, it is a depreciation expense account or a gain and loss account.

Required before disposing any asset.

The account must be active and non-statistical.

key
string

System-assigned key for the disposal GL account.

Example: "101"
id
string

ID for the disposal GL account.

Example: "1904"
Array of objects

Depreciation rules used to calculate depreciation for the asset classification.

Array
key
string

System-assigned unique key for the classification depreciation rule.

Example: "6"
usefulLife
integer

Specify a value for the useful life, which is either in months or years as established by the usefulLifeUnits field in the posting rule. The value must not exceed 500 if usefulLifeUnits is set to months, and must not exceed 100 if usefulLifeUnits is set to years.

Example: 3
object

Posting rule determines which journals the Fixed Assets Management application can post to and how.

object

Asset classification associated with this depreciation rule.

object

Depreciation method.

depreciationRate
string

Rate used to calculate depreciation amount. For example, a value of 30.00 applies a rate of 30.00%. The value must be between 1.00 and 100.00.

Example: "30.00"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "name": "Furniture & Fixtures",
  • "id": "Classification Id 100",
  • "status": "active",
  • "assetGLAccount": {
    • "key": "29",
    • "id": "1014",
    • "title": "Shared Banks"
    },
  • "accumulatedDepreciationGLAccount": {
    • "key": "9",
    • "id": "1000",
    • "title": "Bank of America A/c."
    },
  • "depreciationExpenseGLAccount": {
    • "key": "194",
    • "id": "4000",
    • "title": "Sales"
    },
  • "disposalGLAccount": {
    • "key": "101",
    • "id": "1904",
    • "title": "Computer Equipment"
    },
  • "depreciationRules": [
    • {
      • "postingRule": {
        },
      • "depreciationMethod": {
        },
      • "usefulLife": 60
      },
    • {
      • "postingRule": {
        },
      • "depreciationMethod": {
        },
      • "usefulLife": 12
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "981",
    • "id": "Classification Id 100",
    • "href": "/objects/fixed-assets/asset-classification/981"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get an asset classification

get/objects/fixed-assets/asset-classification/{key}

Returns detailed information for a specified asset classification.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the asset classification.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "name": "Furniture & Fixtures",
    • "id": "Classification Id 100",
    • "key": "100",
    • "status": "active",
    • "assetGLAccount": {
      • "key": "29",
      • "id": "1014",
      • "title": "Shared Banks"
      },
    • "accumulatedDepreciationGLAccount": {
      • "key": "9",
      • "id": "1000",
      • "title": "Bank of America A/c."
      },
    • "depreciationExpenseGLAccount": {
      • "key": "194",
      • "id": "4000",
      • "title": "Sales"
      },
    • "disposalGLAccount": {
      • "key": "101",
      • "id": "1904",
      • "title": "Computer Equipment"
      },
    • "depreciationRules": [
      • {
        },
      • {
        }
      ]
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an asset classification

patch/objects/fixed-assets/asset-classification/{key}

Updates an existing asset classification by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the asset classification.

Example: 99
Request Body schema: application/json
id
string

Unique ID for the asset classification.

Example: "CE-1"
name
string

Name for the asset classification.

Example: "Computer Equipment"
object

Multi-entity location.

object

The General Ledger (GL) account for transactions involving asset cost and disposal.

key
string

System-assigned unique key for the asset GL account.

Example: "93"
id
string

Unique ID for the asset GL account.

Example: "1500"
object

The General Ledger (GL) account where depreciation transactions are recorded as credits.

key
string

System-assigned key for the accumulated depreciation GL account.

Example: "98"
id
string

Unique ID for the accumulated depreciation GL account.

Example: "1901"
object

The General Ledger (GL) account where depreciation transactions are recorded as debits.

key
string

System-assigned unique key for the depreciation expense GL account.

Example: "270"
id
string

Unique ID for the depreciation expense GL account.

Example: "6350"
object

The General Ledger account where the sale price is recorded as a debit. Typically, it is a depreciation expense account or a gain and loss account.

Required before disposing any asset.

The account must be active and non-statistical.

key
string

System-assigned key for the disposal GL account.

Example: "101"
id
string

ID for the disposal GL account.

Example: "1904"
Array of objects

Depreciation rules used to calculate depreciation for the asset classification.

Array
key
string

System-assigned unique key for the classification depreciation rule.

Example: "6"
usefulLife
integer

Specify a value for the useful life, which is either in months or years as established by the usefulLifeUnits field in the posting rule. The value must not exceed 500 if usefulLifeUnits is set to months, and must not exceed 100 if usefulLifeUnits is set to years.

Example: 3
object

Posting rule determines which journals the Fixed Assets Management application can post to and how.

object

Asset classification associated with this depreciation rule.

object

Depreciation method.

depreciationRate
string

Rate used to calculate depreciation amount. For example, a value of 30.00 applies a rate of 30.00%. The value must be between 1.00 and 100.00.

Example: "30.00"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "name": "Updated Furniture",
  • "id": "Classification Id 100",
  • "accumulatedDepreciationGLAccount": {
    • "key": "10"
    },
  • "depreciationExpenseGLAccount": {
    • "key": "11"
    }
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "981",
    • "id": "Classification Id 100",
    • "href": "/objects/fixed-assets/asset-classification/981"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete an asset classification

delete/objects/fixed-assets/asset-classification/{key}

Deletes an asset classification.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the asset classification.

Example: 99
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}