Skip to main content
Skip table of contents

Assets

This resource provides a set of operations to search, retrieve asset details, and also to update the asset Bin and shelf details. Along with this, you can also retrieve the change history of the Bin and shelf of the asset.

GET

End Point: /assets

This method allows you to fetch the asset list.

Also, you can search the asset using the last used order id or order description.

You can search for any existing assets using filters as defined here.

Pagination is supported. Click here to see the details of it.

Sample response payload

CODE
[
 {
  "recordid": "string",
  "assetid": "string",
  "description": "string",
  "secondaryassetid": "string",
  "assetstatus": "In",
  "receiveddate": "MM/dd/yyyy HH:mm",
  "available": true,
  "damaged": true,
  "retired": true,
  "shelfid": "string",
  "binnumber": "string",
  "manufacturer": "string",
  "mfgserialnum": "string",
  "model": "string",
  "year": 0,
  "meter": 0,
  "lockedto": "string",
  "ownersiteid": "string",
  "ownersitename": "string",
  "currentsiteid": "string",
  "currentsitename": "string",
  "currentlocation": "string",
  "underwarranty": true,
  "warrantyexpirydate": "MM/dd/yyyy HH:mm",
  "hascomments": true,
  "productid": "string",
  "productdescription": "string",
  "active": true,
  "searchable": true,
  "exchangegroup": "string",
  "lastorderid": "string",
  "lastorderdescription": "string",
  "lastorderreturndate": "MM/dd/yyyy HH:mm",
  "purchaseorderid": "string",
  "transferorderid": "string"
  "iscontainer": true
 }
]

GET by ID (Asset information)

End Point: /assets/{id}

You can retrieve information of an existing asset by providing its Asset ID or Record ID.

  • The GET /Assets/{ID} operation enhanced to retrieve details for Serial Kit assets.

  • The API response includes a Page-Count header, providing the total number of available pages.

  • This improves pagination capabilities, making it easier your applications to handle large lists of assets efficiently.

Sample response payload

CODE
{
  "recordid": "string",
  "assetid": "string",
  "description": "string",
  "secondaryassetid": "string",
  "productid": "string",
  "receiveddate": "MM/dd/yyyy HH:mm",
  "assetstatus": "In",
  "statusdate": "MM/dd/yyyy HH:mm",
  "servicestatus": "Normal",
  "shelfid": "string",
  "binnumber": "string",
  "options": true,
  "retire": true,
  "available": true,
  "consigned": true,
  "damaged": true,
  "offrent": true,
  "ownersiteid": "string",
  "ownersitename": "string",
  "currentsiteid": "string",
  "currentsitename": "string",
  "currentlocation": "string",
  "warrantyexpirydate": "MM/dd/yyyy HH:mm",
  "usefromdate": "MM/dd/yyyy HH:mm",
  "cost": 0,
  "replacementcost": 0,
  "sellprice": 0,
  "life": 0,
  "remaininglife": 0,
  "nbv": 0,
  "nbvason": "MM/dd/yyyy HH:mm",
  "accdepreciatedamount": 0,
  "salvagevalue": 0,
  "weight": 0,
  "manufacturer": "string",
  "mfgserialnum": "string",
  "model": "string",
  "year": 0,
  "batchno": "string",
  "batchreceiveddate": "MM/dd/yyyy HH:mm",
  "poid": "string",
  "vendorname": "string",
  "lockedto": "string",
  "cogsglaccountid": "string",
  "discountglaccountid": "string",
  "rentglaccountid": "string",
  "inventoryglaccountid": "string",
  "salesglaccountid": "string",
  "depreciationglaccountid": "string",
  "accdepreciationglaccountid": "string",
  "writeoffglaccountid": "string",
  "lastorderid": "string",
  "lastorderdescription": "string",
  "lastordercustomername": "string",
  "udfs": 
        [
         {
          "caption": "string",
          "value": "string"
         }
        ],
  "comments": 
            [
             {
              "recordid": "string",
              "comment": "string"
             }
            ],
  "warnings": 
            [
             {
              "recordid": "string",
              "comment": "string"
             }
            ]
}

GET by ID (Change history)

End Point: /assets/{id}/changehistory

This resource allows you to fetch the change history for attributes such as Bin/ Shelf for Serial Item Assets and Serial Kits using the GET by ID method.

You can search for any existing change history (including Asset's Bin and Shelf information) using filters as defined here.

Pagination is supported for this resource. Click here to see the details of it.

Sample response payload

CODE
[
  {
    "assetid": "string",
    "description": "string",
    "modifiedfield": "string",
    "oldvalue": "string",
    "newvalue": "string",
    "modifiedbyempid": "string",
    "modifiedbyempname": "string",
    "modifieddate": "MM/dd/yyyy HH:mm",
    "productid": "string",
    "productdescription": "string"
  }
]

PUT

End Point: /assets/{id}

You can modify the details of an existing Asset fields like Bin, Shelf, Comments, UDFs and other updatable fields.

  • The PUT /Assets/{ID} operation allows updates to the following fields for Serial Kit assets:

    • Shelf ID

    • Bin Number

    • Current Location

    • UDF (User-Defined Fields)

After a successful update, you will see the entire object in the response.

Sample response payload

CODE
{
  "description": "string",
  "secondaryassetid": "string",
  "shelfid": "string",
  "binnumber": "string",
  "consigned": true,
  "ownersiteid": "string",
  "currentsiteid": "string",
  "currentlocation": "string",
  "warrantyexpirydate": "MM/dd/yyyy HH:mm",
  "usefromdate": "MM/dd/yyyy HH:mm",
  "cost": 0,
  "replacementcost": 0,
  "sellprice": 0,
  "life": 0,
  "salvagevalue": 0,
  "weight": 0,
  "manufacturer": "string",
  "mfgserialnum": "string",
  "model": "string",
  "year": 0,
  "cogsglaccountid": "string",
  "discountglaccountid": "string",
  "rentglaccountid": "string",
  "inventoryglaccountid": "string",
  "salesglaccountid": "string",
  "depreciationglacountid": "string",
  "accdepreciationglaccountid": "string",
  "writeoffglaccountid": "string",
  "udfs": 
        [
          {
           "caption": "string",
           "value": "string"
          }
         ],
  "comments": 
            [
             {
              "recordid": "string",
              "comment": "string"
             }
             ],
  "warnings":
            [
             {
              "recordid": "string",
              "comment": "string"
             }
            ]
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.