Creates an asset.
Endpoint URL
https://dashboard-api.revnue.com/api/v2/asset
Authentication and rate limits
Item | Details |
---|---|
Authentication method | OAuth 2.0 Bearer token |
Rate limit | Rate Limit |
Requests Example
curl --request POST \
--url 'https://dashboard-api.revnue.com/api/v2/asset \
--header 'Authorization: Bearer $BEARER_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '$JSON'
Request Syntax
{
"company": integer,
"name": "string",
"contract": integer,
"category":
{
"id": integer,
"subcategory": "string"
},
"manufacturer": "string",
"serial_number": "string",
"address": "string",
"city": "string",
"country": integer,
"location_description": "string",
"asset_owner": integer,
"business_unit": integer,
"warranty_status": "none" | "out_of_warranty" | "within_warranty",
"warranty_type": "none" | "oem" | "oem_extended" | "third_party",
"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_status": "none" | "out_of_support" | "within_support",
"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",
"usage_status": "non_production" | "none" | "other" | "production",
"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": [
{
"id": integer,
"value": decimal | integer | "string"
},
]
}
}
Query Parameters
- company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is1
.
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) --
[REQUIRED]
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.
- id (integer) --
- 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
- 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
- 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
- usage_status (string) --
The usage status of the asset.
Options:non_production
|none
|other
|production
- 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
- 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 =
50
- If the value data-type is
- id (integer) --
- id (integer) --
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",
"usage_status": "non_production" | "none" | "other" | "production",
"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,...
}
}
}
Response Fields
- id (integer) --
The ID of the asset.
- name (string) --
The name of the asset.
- contract (dict) --
The contract associated to the asset.
- id (integer) --
The ID of the contract.
- number (string) --
The number of the contract.
- id (integer) --
- category (dict) --
The description of the category properties.
- id (integer) --
The ID of the category.
- name (string) --
The name of the category.
- subcategory (string) --
The name of the subcategory.
- id (integer) --
- manufacturer (string) --
The manufacturer of the asset.
- serial_number (string) --
The serial number of the asset.
- address (string) --
The address of the asset.
- city (string) --
The city associated to the asset.
- country (string) --
The country associated to the asset.
- region (string) --
The region associated to the asset.
- location_description (string) --
The location description of the asset.
- asset_owner (dict) --
The description of the asset owner properties.
- id (integer) --
The ID of the asset owner.
- name (string) --
The name of the asset owner.
- email (string) --
The email of the asset owner.
- phone_number (string) --
The phone number of the asset owner.
- id (integer) --
- business_unit (dict) --
The description of the business unit properties.
- id (integer) --
The ID of the business unit.
- name (string) --
The name of the business unit.
- id (integer) --
- warranty_status (string) --
The warranty status of the asset.
- warranty_type (string) --
The warranty type of the asset.
- warranty_provider (dict) --
The description of the warranty provider properties.
- id (integer) --
The ID of the warranty provider.
- name (string) --
The name of the warranty provider.
- id (integer) --
- end_of_life_date (string) --
The end of life date of the asset.
- warranty_start_date (string) --
The warranty start date of the asset.
- warranty_end_date (string) --
The warranty end date of the asset.
- warranty_contact_phone (string) --
The warranty contact phone of the asset.
- warranty_contact_email (string) --
The warranty contact email of the asset.
- warranty_notes (string) --
The warranty notes of the asset.
- support_status (string) --
The support status of the asset.
- support_type (string) --
The support type of the asset.
- support_provider (dict) --
The description of the support provider properties.
- id (integer) --
The ID of the support provider.
- name (string) --
The name of the support provider.
- id (integer) --
- end_of_support_date (string) --
The end of support date of the asset.
- support_start_date (string) --
The support start date of the asset.
- support_end_date (string) --
The support end date of the asset.
- support_contact_phone (string) --
The support contact phone of the asset.
- support_contact_email (string) --
The support contact email of the asset.
- support_notes (string) --
The support notes of the asset.
- usage_status (string) --
The usage status of the asset.
- asset_tag (string) --
The asset tag of the asset.
- asset_notes (string) --
The notes of the asset.
- original_cost (decimal) --
The original cost of the asset.
- service_start_date (string) --
The service start date of the asset.
- depreciation_schedule (string) --
The depreciation schedule of the asset.
- estimated_salvage_value (decimal) --
The estimated salvage value of the asset.
- financial_notes (string) --
The financial notes of the asset.
- template (dict) --
The description of the custom field properties.
- id (integer) --
The ID of the custom field template.
- fields (dict) --
The custom fields and their values as defined in the custom field template. The data type of each custom field value varies depending on its definition.
- id (integer) --