Asset classifications

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

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List asset classifications

get/objects/fixed-assets/asset-classification

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

Permissions and other requirements
SubscriptionFixed Assets Management
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Asset Classification
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.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsCreate Asset Classifications







SecurityOAuth2 
Request 
Request Body schema: application/json
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.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness, Employee, Project Manager, and Warehouse


PermissionsList, View Asset Classification







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the asset classification.


 
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.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsEdit Asset Classifications







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the asset classification.


 
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.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


Permissionsnull







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the asset classification.


 
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
    }
}
Query asset classifications
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "fixed-assets/asset-classification"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}