Creates an asset.

Endpoint URL

https://{{base_url}}/api/v2/asset

Authentication and rate limits

ItemDetails
Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request POST \
  --url 'https://{{base_url}}/api/v2/asset \
  --header 'Authorization: Bearer $BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-raw '$JSON'

URL Parameters

  • unique_field

    [OPTIONAL]
    Pass this parameter in the request URL if you wish to specify a field as unique, thereby avoiding duplicate values in the system.
    Available fields you can set as unique include:

    • name
    • Name of the asset, which is passed as part of the URL: `/asset?unique_field=name`

    • serial_number
    • Serial number of the asset, which is passed as part of the URL: `/asset?unique_field=serial_number`


Request Syntax

{
    "company": integer,
    "name": "string",
    "contract": integer,
    "category":
    {
        "id": integer,
        "subcategory": "string"
    },
    "manufacturer": "string",
    "serial_number": "string",
    "address": "string",
    "state_province": "string",
    "city": "string",
    "country": integer,
    "location_description": "string",
    "asset_owner": integer,
    "business_unit": integer,
    "warranty_type": "none" | "oem" | "oem_extended" | "third_party" | "advanced_replacement_warranty" | "standard_manufacturer_warranty" | "gold_level_support",
    "warranty_provider": integer,
    "end_of_life_date": "string",
    "warranty_start_date": "string",
    "warranty_end_date": "string",
    "warranty_contact_phone": "string",
    "warranty_contact_email": "string",
    "warranty_notes": "string",
    "support_type": "none" | "oem" | "oem_extended" | "third_party",
    "support_provider": integer,
    "end_of_support_date": "string",
    "support_start_date": "string",
    "support_end_date": "string",
    "support_contact_phone": "string",
    "support_contact_email": "string",
    "support_notes": "string",
    "asset_usage_status": integer,
    "asset_tag": "string",
    "asset_notes": "string",
    "original_cost": decimal,
    "service_start_date": "string",
    "depreciation_schedule": "other" | "3_year_33_percent" | "5_year_20_percent" | "10_year_10_percent",
    "estimated_salvage_value": decimal,
    "financial_notes": "string",
    "customer_part_number": "string",
    "parent_manufacturer_part_number": "string",
    "parent_serial_number": "string",
    "manufacturer_part_number":  "string",
    "asset_hardware_model":  {"id": integer},
    "sales_manager_name":  "string",
    "sales_manager_email":  "string",
    "additional_sales_email":  "string",
    "contract_service_per_item": decimal,
    "asset_location_address": "string",
    "currency": 
    {
         "value": "string",
         "symbol": "string"
    },
  "new_hardware_selling_unit_price":decimal,
   "manufacturer_currency": {
        "value": "string",
        "symbol": "string"
    },
  "manufacturer_warranty_unit_price": decimal,
    "template":
    {
        "id": integer,
        "fields": [
            {
                "id": integer,
                "value": decimal | integer | "string"
            }, 
    		]
    },
    "form_template":[
        {
            "id": integer,
            "custom_form_data":{
                "value1": decimal| integer|"string",
                "value2": decimal| integer|"string"
            }    
        }
    ]
}

Body Parameters

  • company (integer) --

    [REQUIRED]
    The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
    To lookup a specific company ID, see the List Company API.

  • name (string) --

    [REQUIRED]
    The name of the asset.
    Max characters = 50

  • contract (integer) --

    The ID of the contract associated to the asset.
    To lookup a specific contract ID, see the List Contract API.

  • category (dict) --
    • id (integer) --

      The ID of the category.
      To lookup a specific category ID, see the List Category API.

    • subcategory (string) --

      The name of the subcategory.
      To lookup a specific subcategory, see the List Category API.

  • manufacturer (string) --

    The manufacturer of the asset.
    Max characters = 50

  • serial_number (string) --

    The serial number of the asset.
    Max characters = 50

  • address (string) --

    The address of the asset.
    Max characters = 50

  • state_province (string) --

    The state/province of the asset.
    Max characters = 50

  • city (string) --

    The city associated to the asset.
    Max characters = 50

  • country (integer) --

    The numeric code of the country.
    To lookup a specific country numeric code, see the List Country API.

  • location_description (string) --

    The location description of the asset.
    Max characters = 1000

  • asset_owner (integer) --

    The ID of the asset owner.
    To lookup a specific asset owner ID, see the List Asset Owner API.

  • business_unit (integer) --

    The ID of the business unit.
    To lookup a specific business unit ID, see the List Business Unit API.

  • warranty_status (string) --

    The warranty status of the asset.
    Options: none | out_of_warranty | within_warranty

  • warranty_type (string) --

    The warranty type of the asset.
    Options: none | oem | oem_extended | third_party | advanced_replacement_warranty | standard_manufacturer_warranty | gold_level_support

  • warranty_provider (integer) --

    The ID of the warranty provider.
    To lookup a specific warranty provider ID, see the List Supplier API.

  • end_of_life_date (string) --

    The end of life date of the asset.
    Format = yyyy-MM-dd

  • warranty_start_date (string) --

    The warranty start date of the asset.
    Format = yyyy-MM-dd

  • warranty_end_date (string) --

    The warranty end date of the asset.
    Format = yyyy-MM-dd

  • warranty_contact_phone (string) --

    The warranty contact phone of the asset.
    Max characters = 20

  • warranty_contact_email (string) --

    The warranty contact email of the asset.
    Max characters = 254

  • warranty_notes (string) --

    The warranty notes of the asset.
    Max characters = 1000

  • support_status (string) --

    The support status of the asset.
    Options: none | out_of_support | within_support

  • support_type (string) --

    The support type of the asset.
    Options: none | oem | oem_extended | third_party

  • support_provider (integer) --

    The ID of the support provider.
    To lookup a specific support provider ID, see the List Supplier API.

  • end_of_support_date (string) --

    The end of support date of the asset.
    Format = yyyy-MM-dd

  • support_start_date (string) --

    The support start date of the asset.
    Format = yyyy-MM-dd

  • support_end_date (string) --

    The support end date of the asset.
    Format = yyyy-MM-dd

  • support_contact_phone (string) --

    The support contact phone of the asset.
    Max characters = 20

  • support_contact_email (string) --

    The support contact email of the asset.
    Max characters = 254

  • support_notes (string) --

    The support notes of the asset.
    Max characters = 1000

  • asset_usage_status (integer) --

    The usage status of the asset.
    To lookup a specific usage status ID, see the List Usage Status API.

  • asset_tag (string) --

    The asset tag of the asset.
    Max characters = 50

  • asset_notes (string) --

    The notes of the asset.
    Max characters = 1000

  • original_cost (decimal) --

    The original cost of the asset.
    Min value = 0.00
    Max value = 999999999999999.00

  • service_start_date (string) --

    The service start date of the asset.
    Format = yyyy-MM-dd

  • depreciation_schedule (string) --

    The depreciation schedule of the asset.
    Options: other | 3_year_33_percent | 5_year_20_percent | 10_year_10_percent

  • estimated_salvage_value (decimal) --

    The estimated salvage value of the asset.
    Min value = 0.00
    Max value = 999999999999999.00

  • financial_notes (string) --

    The financial notes of the asset.
    Max characters = 1000

  • customer_part_number (string) --

    The customer part number of the asset.
    Max characters = 50

  • parent_manufacturer_part_number (string) --

    The parent manufacturer part number of the asset.
    Max characters = 50

  • parent_serial_number (string) --

    The parent serial number of the asset.
    Max characters = 50

  • manufacturer_part_number (string) --

    The manufacturer part number of the asset.
    Max characters = 50

  • hardware_model (dict) --
    • id (integer) --

      The ID of the hardware model.
      To lookup a specific category ID, see the List Hardware Model API.

  • sales_manager_name (string) --

    The sales manager name of the asset.
    Max characters = 50

  • sales_manager_email (string) --

    The sales manager email of the asset.
    Max characters = 50

  • additional_sales_email (string) --

    The additional sales email of the asset.
    Max characters = 50

  • contract_service_per_item (decimal) --

    The contract service per item of the asset.
    Min value = 0.00
    Max value = 999999999999999.00

  • asset_location_address (string) --

    The other location address of the asset.
    Max characters = 50

  • currency (dict) --

    The currency of the asset.
    Max characters = 50

    • value (string) --

      The value of the currency (country code).
      Max characters = 50

    • symbol (string) --

      The symbol of the currency.
      Max characters = 50

  • template (dict) --
    • id (integer) --

      The ID of the custom field template.
      To lookup a specific custom field template ID, see the List Custom Field Template API.

    • fields (dict) --
      • id (integer) --

        The ID of the custom field.
        To lookup a specific field ID, see the List Custom Field Template API.

      • value (decimal | integer | string) --

        The value of the custom field.

        • If the value data-type is money (decimal) --

          Min value = 0.00
          Max value = 999999999999999.00

        • If the value data-type is number (integer) --

          Min value = -999999999999999
          Max value = 999999999999999

        • If the value data-type is date (string) --

          Format = yyyy-MM-dd

        • If the value data-type is text (string) --

          Max characters = 150

  • custom_form (dict) --
    • id (integer) --

      The ID of the custom form.
      To lookup a specific field ID, see the List Custom Form Template API.

    • custom_form_data (dict) --
      • value (decimal | integer | string) --

        Note: Replace the parameter name "value"  with the actual name of custom form field.

        • If the value data-type is money (decimal) --

          Min value = 0.00
          Max value = 999999999999999.00

        • If the value data-type is number (integer) --

          Min value = -999999999999999
          Max value = 999999999999999

        • If the value data-type is date (string) --

          Format = yyyy-MM-dd

        • If the value data-type is text (string) --

          Max characters = 150

Response Syntax

{
    "id": integer,
    "name": "string",
    "contract": {
        "id": integer,
        "number": "string"
    },
    "category": {
        "id": integer,
        "name": "string",
        "subcategory": "string"
    },
    "manufacturer": "string",
    "serial_number": "string",
    "address": "string",
    "city": "string",
    "country": "string",
    "region": "string",
    "location_description": "string",
    "asset_owner": {
        "id": integer,
        "name": "string",
        "email": "string",
        "phone_number": "string"
    },
    "business_unit": {
        "id": integer,
        "name": "string"
    },
    "warranty_status": "none" | "out_of_warranty" | "within_warranty",
    "warranty_type": "none" | "oem" | "oem_extended" | "third_party",
    "warranty_provider": {
        "id": integer,
        "name": "string"
    },
    "end_of_life_date": "string",
    "warranty_start_date": "string",
    "warranty_end_date": "string",
    "warranty_contact_phone": "string",
    "warranty_contact_email": "string",
    "warranty_notes": "string",
    "support_status": "none" | "out_of_support" | "within_support",
    "support_type": "none" | "oem" | "oem_extended" | "third_party",
    "support_provider": {
        "id": integer,
        "name": "string"
    },
    "end_of_support_date": "string",
    "support_start_date": "string",
    "support_end_date": "string",
    "support_contact_phone": "string",
    "support_contact_email": "string",
    "support_notes": "string",
    "asset_usage_status": {
        "id": integer,
        "name": "string"
    },
    "asset_tag": "string",
    "asset_notes": "string",
    "original_cost": decimal,
    "service_start_date": "string",
    "depreciation_schedule": "other" | "3_year_33_percent" | "5_year_20_percent" | "10_year_10_percent",
    "estimated_salvage_value": decimal,
    "financial_notes": "string",
    "template": {
        "id": integer,
        "fields": {
         key: value,...
        }
    },
    "custom_form":[
        {
            "id": integer,
            "custom_form_data":{
                "value1": decimal| integer|"string",
                "value2": decimal| integer|"string"
            } 
        }
    ]
}