Assets

Assets are resources used in the operations of a business, such as buildings, manufacturing equipment, office equipment, furniture, fixtures, and vehicles.

The asset object holds information about the asset, including the in-service date, asset cost, and dimensions required to post to the GL. These properties are used to automatically generate depreciation schedules. From period to period, post your depreciation schedule entries until the asset is fully depreciated or disposed.

The Fixed Assets Management application supports both depreciable and non-depreciable assets. Assets that are not depreciable do not have depreciation schedules.

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 assets

get/objects/fixed-assets/asset

Returns up to 100 object references from the collection with a key, ID, and link for each asset. 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 Assets
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "CE_ASSET-2",
      • "href": "/objects/fixed-assets/asset/2"
      },
    • {
      • "key": "3",
      • "id": "CE_ASSET-3",
      • "href": "/objects/fixed-assets/asset/3"
      },
    • {
      • "key": "4",
      • "id": "VEH_ASSET-1",
      • "href": "/objects/fixed-assets/asset/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 3,
    • "totalError": 0
    }
}
Create an asset
post/objects/fixed-assets/asset
Creates a new asset.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsAdd Asset







SecurityOAuth2 
Request 
Request Body schema: application/json
Creates an asset


id
required
string
ID for the asset.


 
 Example:  "CE_ASSET-1"
name
required
string
Name for the asset.


 
 Example:  "Laptop"
state
string
 Default:  "readyForReview"
Represents stages in the asset life cycle:


    

  • readyForReview - new asset exists in Sage Intacct but it is not yet depreciating.
    • 

  • inService - the asset is currently in use by a business and its value can depreciate on a schedule.
    • 

  • disposed - the asset was removed from service, typically due to a sale.
    • 



Assets are moved from readyForReview to inService and ultimately to disposed state.


 Enum: "disposed" "inService" "readyForReview"  
 Example:  "inService"
assetCost
string
The amount that the asset was purchased for. It must be a positive number.


This property is required for assets in service. It is also required if there is a salvage value.


 
 Example:  "3000"
salvageValue
string
The estimated value of the asset at the end of its useful life. It must be less than the asset cost.


 
 Example:  "300"
inServiceDate
string <date> 
The date when the asset is available for use. This date, along with the convention, determines when the asset starts to depreciate. The in-service date must be on or after the acquisition date.


 
 Example:  "2020-01-01"
serialNumber
string
Product serial number of the asset.


 
 Example:  "CE_ASSET-1"
assetTag
string
Product asset tag for the asset.


 
 Example:  "ASSET_TAG-0001"
object
The location of the entity associated with the asset.


 
object
Supporting document associated with the asset.


 
key
string
System-assigned key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 Example:  "Jan23Xls"
quantity
integer
 Default:  1
Number of units of the asset.


 
 Example:  1
acquisitionDate
string <date> 
The date the asset was purchased or obtained by your business.


 
 Example:  "2020-01-01"
description
string
Description of the asset.


 
 Example:  "Lenovo ThinkPad"
notes
string
Notes or comments about the asset.


 
 Example:  "Next major service due at 3,000 hours"
isDepreciable
boolean
 Default:  true
Set to true if the cost of the asset will be allocated over time. Depreciation schedules are generated when the asset is placed in service.


Set to false for tracking non-depreciable assets such as land, art, coins, or collectibles. No depreciation schedules will be generated.


If the asset is not depreciable, do not specify the following properties:


    

  • salvageValue
    • 

  • accumulatedDepreciationGLAccount
    • 

  • depreciationExpenseGLAccount
    • 

  • depreciationRules
    • 



 
 Example:  true
disposalDate
string <date> 
The date the asset was removed from business operations. 


This date also serves as the General Ledger posting date for the disposal journal entry. The disposal date must be after the last posted period date and before the next un-posted period date. If no periods are posted yet, it must be after the in-service date and before the first period's posting date.


 
 Example:  "2022-01-01"
disposalType
string
 Default:  null
The reason for disposal of the asset.


    

  • sale - you receive a payment in exchange for the asset.
    • 

  • casualtyLoss - the asset is destroyed or damaged due to an unforeseen event or accident. No payment is received.
    • 

  • theft - the asset is stolen. No payment is received.
    • 

  • other - the asset is removed from service for any other reason. The asset might still be in your possession, but it reached the end of its useful life or has no resale value. No payment is received.
    • 



If the reason for disposal is sale, then the salePrice and disposalGLAccount properties must be specified.


 Enum: "casualtyLoss" null "other" "sale" "theft"  
 Example:  "sale"
salePrice
string
The amount the asset was sold for. Specify for assets with disposalType set to sale.


 
 Example:  "1000"
disposalComments
string
Notes about the disposal of the asset.


 
 Example:  "Sold to Lincoln Avenue Veterinary Clinic"
type
string
 Default:  "tangible"
The type of the asset.


Tangible assets have physical substance, such as equipment or land.
Intangible assets do not have physical substance, such as patents or copyrights.
At this time, the Fixed Assets Management application only supports tangible assets.


 Enum: "intangible" "tangible"  
 Example:  "tangible"
object
The bill the asset was created from.


 
headerType
string
Type for the source header.


 
 Example:  "IA.BILL"
headerKey
string
Key for the source header.


 
 Example:  "3874"
headerId
string
ID for the source header.


 
 Example:  "Bill-00302"
lineKey
string
Key for the source line.


 
 Example:  "89483"
lineNumber
string
Source line number.


 
 Example:  "3"
gainLossAmount
string
Amount of gain or loss when the asset is disposed for non-depreciable assets.


 
 Example:  "300"
object
Disposed journal entry for a non-depreciable asset.


 
key
string
System-assigned unique key for the disposed journal entry.


 
 Example:  "6725"
id
string
ID for the disposed journal entry.


 
 Example:  "6725"
object
The journal where transactions related to non-depreciable assets are recorded. Use an active and non-statistical journal.


 
key
string
Unique key for the journal.


 
 Example:  "46"
id
string
ID for the journal.


 
 Example:  "TAX"
object
Allocation entry associated with the asset.


 
key
string
System-assigned unique key for the allocation entry.


 
 Example:  "1"
id
string
ID for the allocation entry.


 
 Example:  "1"
object
Use dimensions to assign the asset to a project, department, or any other dimension value.


The location dimension is always required. Other dimensions might be required depending on the configuration of your accumulated depreciation and depreciation expense GL accounts.


 
object or null
The class associated with this asset.


 
key
string or null
System-assigned key for the class.


 
 Example:  "1"
id
string or null
ID for the class.


 
 Example:  "1"
object or null
The contract associated with the asset.


 
key
string or null
System-assigned key for the contract.


 
 Example:  "1"
id
string or null
ID for the contract.


 
 Example:  "1"
object or null
The cost type for the asset.


 
key
string or null
System-assigned key for the cost type.


 
 Example:  "7"
id
string or null
ID for the cost type.


 
 Example:  "LABOR"
object or null
The customer associated with the asset.


 
key
string or null
System-assigned key for the customer.


 
 Example:  "1"
id
string or null
ID for the customer.


 
 Example:  "1"
object or null
The department associated with the asset.


 
key
string or null
System-assigned key for the department.


 
 Example:  "3"
id
string or null
ID for the department.


 
 Example:  "3"
object or null
The employee associated with the asset.


 
key
string or null
System-assigned key for the employee.


 
 Example:  "1"
id
string or null
ID for the employee.


 
 Example:  "1"
object or null
The item associated with the asset.


 
key
string or null
System-assigned key for the item.


 
 Example:  "1"
id
string or null
ID for the item.


 
 Example:  "1"
object
The location associated with the asset.


 
key
string or null
System-assigned key for the location.


 
 Example:  "1"
id
string or null
ID for the location.


 
 Example:  "1"
object or null
The project associated with the asset.


 
key
string or null
System-assigned key for the project.


 
 Example:  "8"
id
string or null
ID for the project.


 
 Example:  "8"
object or null
The task associated with the asset.


 
key
string or null
System-assigned key for the task.


 
 Example:  "8"
id
string or null
ID for the task.


 
 Example:  "01-041"
object or null
The vendor associated with the asset.


 
key
string or null
System-assigned key for the vendor.


 
 Example:  "43"
id
string or null
ID for the vendor.


 
 Example:  "1099 Int"
object or null
The warehouse associated with the asset.


 
key
string or null
System-assigned key for the warehouse.


 
 Example:  "1"
id
string or null
ID for the warehouse.


 
 Example:  "WH01"
object
Required if state is set to inService. The General Ledger account where transactions involving asset cost and disposal are recorded as debits and credits.


 
key
string
System-assigned key for the asset GL account.


 
 Example:  "93"
id
string
ID for the asset GL account.


 
 Example:  "1500"
object
Use only if isDepreciable is set to true. Required if state is set to inService. The General Ledger account where depreciation transactions are recorded as credits. It offsets the depreciation expense account.


 
key
string
System-assigned key for the accumulated depreciation GL account.


 
 Example:  "98"
id
string
ID for the accumulated depreciation GL account.


 
 Example:  "1901"
object
Use only if isDepreciable is set to true. Required if state is set to inService. The General Ledger account where depreciation transactions are recorded as debits.


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


 
 Example:  "270"
id
string
ID for the depreciation expense GL account.


 
 Example:  "6350"
object
The General Ledger account where the sales price is recorded as a debit. Typically, it is a depreciation expense account or a gain and loss account. 


Specify this property when the disposalType is set to sale. Required when the salesPrice is greater than zero.


The account must be active and non-statistical. Specify a different account than the gainLossGLAccount.


 
key
string
System-assigned key for the disposal GL account.


 
 Example:  "101"
id
string
ID for the disposal GL account.


 
 Example:  "1904"
object
The General Ledger account where the gain or loss on disposal amount is recorded as a debit or credit.


The account must be active and non-statistical. Specify a different account than the disposalGLAccount.


 
key
string
System-assigned key for the gain loss GL account.


 
 Example:  "94"
id
string
ID for the gain loss GL account.


 
 Example:  "1501"
object
Required if state is set to inService. Provides the GL accounts and depreciation rules properties with default values for assets of that category.


You can customize the GL accounts and depreciation rules per asset, after the asset has been created.


 
key
string
System-assigned key for the classification.


 
 Example:  "3"
id
string
ID for the classification.


 
 Example:  "Computer Equipment"
object
By linking parent assets, you can create a hierarchy of assets. An asset can only have one parent. An asset cannot reference itself as the parent.


 
key
string
System-assigned key for the parent asset.


 
 Example:  "1"
id
string
ID for the parent asset.


 
 Example:  "CE_ASSET-0"
Array of objects
Depreciation rules contain information about the depreciation method, convention, and useful life for the asset.


If the asset state is set to inService and isDepreciable is set to true, it must have at least one depreciation rule. 
Assets that are not depreciable cannot have any depreciation rules.


 
 Array 
key
string
System-assigned unique key for the asset depreciation rule.


 
 Example:  "9"
usefulLife
integer
An estimate of the expected service life of an asset. Specify a useful life in months or years as determined by the posting rule configuration. The value must not exceed 500 if usefulLifeUnits is set to months, and must not exceed 100 if usefulLifeUnits is set to years.


 
 Example:  60
object
Posting rules determines which journals the Fixed Assets Management application can post to and how.


 
object
Asset corresponding to this depreciation rule.


 
object
Depreciation method for the asset depreciation rule.


 
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
{
  • "id": "CE_ASSET-1",
  • "name": "Laptop",
  • "serialNumber": "CE_ASSET-1",
  • "assetTag": "ASSET_TAG-0001",
  • "state": "inService",
  • "inServiceDate": "2021-03-15",
  • "status": "active",
  • "assetCost": "5000",
  • "salvageValue": "200",
  • "acquisitionDate": "2020-04-22",
  • "isDepreciable": true,
  • "description": "Lenovo ThinkPad",
  • "dimensions": {
    • "location": {
      • "key": "1"
      }
    },
  • "classification": {
    • "key": "3"
    },
  • "allocation": {
    • "key": "1"
    },
  • "depreciationRules": [
    • {
      • "postingRule": {
        },
      • "depreciationMethod": {
        },
      • "usefulLife": 5
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "11",
    • "id": "CE_ASSET-2",
    • "href": "/objects/fixed-assets/asset/11"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an asset
get/objects/fixed-assets/asset/{key}
Returns detailed information for a specified asset.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness, Employee, Project Manager, and Warehouse


PermissionsList, View Assets







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


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "accumulatedDepreciationGLAccount": {
      • "name": "Accumulated Depreciation",
      • "id": "1901",
      • "title": "Accumulated Depreciation",
      • "key": "98"
      },
    • "depreciationExpenseGLAccount": {
      • "name": "Depreciation Expense",
      • "id": "6350",
      • "key": "270"
      },
    • "assetGLAccount": {
      • "name": "Computer Equipment",
      • "id": "1500",
      • "key": "93"
      },
    • "classification": {
      • "name": "Computer Equipment",
      • "id": "CE-1",
      • "key": "3"
      },
    • "depreciationRules": [
      • {
        },
      • {
        }
      ],
    • "audit": {
      • "createdBy": "1",
      • "createdDateTime": "2022-11-02T05:12:15Z",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2022-11-02T05:12:19Z"
      },
    • "dimensions": {
      • "item": {
        },
      • "task": {
        },
      • "vendor": {
        },
      • "project": {
        },
      • "location": {
        },
      • "department": {
        },
      • "employee": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "customer": {
        }
      },
    • "acquisitionDate": "2020-01-01",
    • "assetCost": "3000",
    • "quantity": 1,
    • "serialNumber": "CE_ASSET-1",
    • "assetTag": "ASSET_TAG-0001",
    • "depreciableCost": "2700",
    • "description": "Lenovo thinkpad",
    • "type": "tangible",
    • "name": "Laptop",
    • "salvageValue": "300",
    • "inServiceDate": "2020-01-01",
    • "id": "CE_ASSET-1",
    • "state": "inService",
    • "isDepreciable": true,
    • "key": "2",
    • "status": "active"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an asset
patch/objects/fixed-assets/asset/{key}
Updates an existing asset by setting field values. Any fields not provided remain unchanged.


The asset state determines which fields of the asset may be edited. If the state is set to disposed, you may not edit any fields.
See Editing assets for more details.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsEdit Assets







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


 
Request Body schema: application/json
name
string
Name for the asset.


 
 Example:  "Laptop"
state
string
 Default:  "readyForReview"
Represents stages in the asset life cycle:


    

  • readyForReview - new asset exists in Sage Intacct but it is not yet depreciating.
    • 

  • inService - the asset is currently in use by a business and its value can depreciate on a schedule.
    • 

  • disposed - the asset was removed from service, typically due to a sale.
    • 



Assets are moved from readyForReview to inService and ultimately to disposed state.


 Enum: "disposed" "inService" "readyForReview"  
 Example:  "inService"
assetCost
string
The amount that the asset was purchased for. It must be a positive number.


This property is required for assets in service. It is also required if there is a salvage value.


 
 Example:  "3000"
salvageValue
string
The estimated value of the asset at the end of its useful life. It must be less than the asset cost.


 
 Example:  "300"
inServiceDate
string <date> 
The date when the asset is available for use. This date, along with the convention, determines when the asset starts to depreciate. The in-service date must be on or after the acquisition date.


 
 Example:  "2020-01-01"
serialNumber
string
Product serial number of the asset.


 
 Example:  "CE_ASSET-1"
assetTag
string
Product asset tag for the asset.


 
 Example:  "ASSET_TAG-0001"
object
The location of the entity associated with the asset.


 
object
Supporting document associated with the asset.


 
key
string
System-assigned key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 Example:  "Jan23Xls"
quantity
integer
 Default:  1
Number of units of the asset.


 
 Example:  1
acquisitionDate
string <date> 
The date the asset was purchased or obtained by your business.


 
 Example:  "2020-01-01"
description
string
Description of the asset.


 
 Example:  "Lenovo ThinkPad"
notes
string
Notes or comments about the asset.


 
 Example:  "Next major service due at 3,000 hours"
isDepreciable
boolean
 Default:  true
Set to true if the cost of the asset will be allocated over time. Depreciation schedules are generated when the asset is placed in service.


Set to false for tracking non-depreciable assets such as land, art, coins, or collectibles. No depreciation schedules will be generated.


If the asset is not depreciable, do not specify the following properties:


    

  • salvageValue
    • 

  • accumulatedDepreciationGLAccount
    • 

  • depreciationExpenseGLAccount
    • 

  • depreciationRules
    • 



 
 Example:  true
disposalDate
string <date> 
The date the asset was removed from business operations. 


This date also serves as the General Ledger posting date for the disposal journal entry. The disposal date must be after the last posted period date and before the next un-posted period date. If no periods are posted yet, it must be after the in-service date and before the first period's posting date.


 
 Example:  "2022-01-01"
disposalType
string
 Default:  null
The reason for disposal of the asset.


    

  • sale - you receive a payment in exchange for the asset.
    • 

  • casualtyLoss - the asset is destroyed or damaged due to an unforeseen event or accident. No payment is received.
    • 

  • theft - the asset is stolen. No payment is received.
    • 

  • other - the asset is removed from service for any other reason. The asset might still be in your possession, but it reached the end of its useful life or has no resale value. No payment is received.
    • 



If the reason for disposal is sale, then the salePrice and disposalGLAccount properties must be specified.


 Enum: "casualtyLoss" null "other" "sale" "theft"  
 Example:  "sale"
salePrice
string
The amount the asset was sold for. Specify for assets with disposalType set to sale.


 
 Example:  "1000"
disposalComments
string
Notes about the disposal of the asset.


 
 Example:  "Sold to Lincoln Avenue Veterinary Clinic"
type
string
 Default:  "tangible"
The type of the asset.


Tangible assets have physical substance, such as equipment or land.
Intangible assets do not have physical substance, such as patents or copyrights.
At this time, the Fixed Assets Management application only supports tangible assets.


 Enum: "intangible" "tangible"  
 Example:  "tangible"
object
The bill the asset was created from.


 
headerType
string
Type for the source header.


 
 Example:  "IA.BILL"
headerKey
string
Key for the source header.


 
 Example:  "3874"
headerId
string
ID for the source header.


 
 Example:  "Bill-00302"
lineKey
string
Key for the source line.


 
 Example:  "89483"
lineNumber
string
Source line number.


 
 Example:  "3"
gainLossAmount
string
Amount of gain or loss when the asset is disposed for non-depreciable assets.


 
 Example:  "300"
object
Disposed journal entry for a non-depreciable asset.


 
key
string
System-assigned unique key for the disposed journal entry.


 
 Example:  "6725"
id
string
ID for the disposed journal entry.


 
 Example:  "6725"
object
The journal where transactions related to non-depreciable assets are recorded. Use an active and non-statistical journal.


 
key
string
Unique key for the journal.


 
 Example:  "46"
id
string
ID for the journal.


 
 Example:  "TAX"
object
Allocation entry associated with the asset.


 
key
string
System-assigned unique key for the allocation entry.


 
 Example:  "1"
id
string
ID for the allocation entry.


 
 Example:  "1"
object
Use dimensions to assign the asset to a project, department, or any other dimension value.


The location dimension is always required. Other dimensions might be required depending on the configuration of your accumulated depreciation and depreciation expense GL accounts.


 
object or null
The class associated with this asset.


 
key
string or null
System-assigned key for the class.


 
 Example:  "1"
id
string or null
ID for the class.


 
 Example:  "1"
object or null
The contract associated with the asset.


 
key
string or null
System-assigned key for the contract.


 
 Example:  "1"
id
string or null
ID for the contract.


 
 Example:  "1"
object or null
The cost type for the asset.


 
key
string or null
System-assigned key for the cost type.


 
 Example:  "7"
id
string or null
ID for the cost type.


 
 Example:  "LABOR"
object or null
The customer associated with the asset.


 
key
string or null
System-assigned key for the customer.


 
 Example:  "1"
id
string or null
ID for the customer.


 
 Example:  "1"
object or null
The department associated with the asset.


 
key
string or null
System-assigned key for the department.


 
 Example:  "3"
id
string or null
ID for the department.


 
 Example:  "3"
object or null
The employee associated with the asset.


 
key
string or null
System-assigned key for the employee.


 
 Example:  "1"
id
string or null
ID for the employee.


 
 Example:  "1"
object or null
The item associated with the asset.


 
key
string or null
System-assigned key for the item.


 
 Example:  "1"
id
string or null
ID for the item.


 
 Example:  "1"
object
The location associated with the asset.


 
key
string or null
System-assigned key for the location.


 
 Example:  "1"
id
string or null
ID for the location.


 
 Example:  "1"
object or null
The project associated with the asset.


 
key
string or null
System-assigned key for the project.


 
 Example:  "8"
id
string or null
ID for the project.


 
 Example:  "8"
object or null
The task associated with the asset.


 
key
string or null
System-assigned key for the task.


 
 Example:  "8"
id
string or null
ID for the task.


 
 Example:  "01-041"
object or null
The vendor associated with the asset.


 
key
string or null
System-assigned key for the vendor.


 
 Example:  "43"
id
string or null
ID for the vendor.


 
 Example:  "1099 Int"
object or null
The warehouse associated with the asset.


 
key
string or null
System-assigned key for the warehouse.


 
 Example:  "1"
id
string or null
ID for the warehouse.


 
 Example:  "WH01"
object
Required if state is set to inService. The General Ledger account where transactions involving asset cost and disposal are recorded as debits and credits.


 
key
string
System-assigned key for the asset GL account.


 
 Example:  "93"
id
string
ID for the asset GL account.


 
 Example:  "1500"
object
Use only if isDepreciable is set to true. Required if state is set to inService. The General Ledger account where depreciation transactions are recorded as credits. It offsets the depreciation expense account.


 
key
string
System-assigned key for the accumulated depreciation GL account.


 
 Example:  "98"
id
string
ID for the accumulated depreciation GL account.


 
 Example:  "1901"
object
Use only if isDepreciable is set to true. Required if state is set to inService. The General Ledger account where depreciation transactions are recorded as debits.


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


 
 Example:  "270"
id
string
ID for the depreciation expense GL account.


 
 Example:  "6350"
object
The General Ledger account where the sales price is recorded as a debit. Typically, it is a depreciation expense account or a gain and loss account. 


Specify this property when the disposalType is set to sale. Required when the salesPrice is greater than zero.


The account must be active and non-statistical. Specify a different account than the gainLossGLAccount.


 
key
string
System-assigned key for the disposal GL account.


 
 Example:  "101"
id
string
ID for the disposal GL account.


 
 Example:  "1904"
object
The General Ledger account where the gain or loss on disposal amount is recorded as a debit or credit.


The account must be active and non-statistical. Specify a different account than the disposalGLAccount.


 
key
string
System-assigned key for the gain loss GL account.


 
 Example:  "94"
id
string
ID for the gain loss GL account.


 
 Example:  "1501"
object
Required if state is set to inService. Provides the GL accounts and depreciation rules properties with default values for assets of that category.


You can customize the GL accounts and depreciation rules per asset, after the asset has been created.


 
key
string
System-assigned key for the classification.


 
 Example:  "3"
id
string
ID for the classification.


 
 Example:  "Computer Equipment"
object
By linking parent assets, you can create a hierarchy of assets. An asset can only have one parent. An asset cannot reference itself as the parent.


 
key
string
System-assigned key for the parent asset.


 
 Example:  "1"
id
string
ID for the parent asset.


 
 Example:  "CE_ASSET-0"
Array of objects
Depreciation rules contain information about the depreciation method, convention, and useful life for the asset.


If the asset state is set to inService and isDepreciable is set to true, it must have at least one depreciation rule. 
Assets that are not depreciable cannot have any depreciation rules.


 
 Array 
key
string
System-assigned unique key for the asset depreciation rule.


 
 Example:  "9"
usefulLife
integer
An estimate of the expected service life of an asset. Specify a useful life in months or years as determined by the posting rule configuration. The value must not exceed 500 if usefulLifeUnits is set to months, and must not exceed 100 if usefulLifeUnits is set to years.


 
 Example:  60
object
Posting rules determines which journals the Fixed Assets Management application can post to and how.


 
object
Asset corresponding to this depreciation rule.


 
object
Depreciation method for the asset depreciation rule.


 
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
{
  • "state": "inService",
  • "inServiceDate": "2021-12-28"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "CE_ASSET-2",
    • "href": "/objects/fixed-assets/asset/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an asset
delete/objects/fixed-assets/asset/{key}
Deletes an asset.


You can delete assets that are in the readyForReview state. Assets that are inService or disposed cannot be deleted. Instead, consider changing their status to inactive.


If the asset you want to delete is assigned as a parent asset, edit the children assets to remove the parent association.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsDelete Assets







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


 
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 assets
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"
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
    }
}