Public
Documentation Settings
Revnue API v2
Double Column
cURL - cURL
Revnue API v2
Introduction
POST
Create Asset
POST
Create Asset Owner
POST
Create Business Entity
POST
Create Business Unit
POST
Create Category
POST
Create Contract
POST
Create Customer
POST
Create Custom Field Template
POST
Create Custom Form Template
POST
Create Hardware Model
POST
Create Usage Status
POST
Create Supplier
POST
Upload File
POST
Attach File in Asset
POST
Attach File in Contract
POST
Attach File in Customer
POST
Attach File in Supplier
POST
Alerts
DEL
Delete Asset
DEL
Delete Business Unit
DEL
Delete Business Entity
DEL
Delete Category
DEL
Delete Contract
DEL
Delete Customer
DEL
Delete Supplier
DEL
Delete Attach File
GET
List Asset
GET
List Asset Attachment
GET
List Contract Attachment
GET
List Customer Attachment
GET
List Supplier Attachment
GET
List Asset By Custom Form
GET
List Asset Owner
GET
List Business Unit
GET
List Business Entiy
GET
List Category
GET
List Hardware Model
GET
List Usage Status
GET
List Company
GET
List Contract
GET
List Country
GET
List Custom Field Template
GET
List Custom Form
GET
List Customer
GET
List Supplier
GET
List PO
GET
List Alerts
GET
List User
GET
List File
PUT
Update Asset
PUT
Update Asset Owner
PUT
Update Business Entity
PUT
Update Business Unit
PUT
Update Category
PUT
Update Contract
PUT
Update Custom Field
PUT
Update Custom Field Template
PUT
Update Custom Form Template
PUT
Update Customer
PUT
Update Supplier

Revnue API v2

This is a Postman Collection for the Revnue API v2 endpoints.

Refer to the main Revnue API documentation for full details.

If you have an API-related question, you can also ask a question in our discussion board!

AUTHORIZATIONBearer Token

POSTCreate Asset

https://{{baseURL}}/api/v2/asset?
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionRevnue API v2
PARAMS
Bodyraw (json)
json
{
    "company": integer,
    "name": "string",
    "contract": integer,
    "category":
    {
        "id": integer,
        "subcategory": "string"
    },
    "attached_supplier":integer,
    "manufacturer": "string",
    "serial_number": "string",
    "pseudo_number": "string",
    "unit": "string",
    "bldng_name":"string",
    "street":"string",
    "floor": "string",
    "room":"string",
    "area":"string",
    "address": "string",
    "state_province": "string",
    "city": "string",
    "country": integer,
    "location_description": "string",
    "general_info_notes":"string",
    "asset_owner": integer,
    "business_entity_type":"string",
    "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"
            }    
        }
    ]
}
Example Request
Create Asset
curl
curl --location -g --request PATCH 'https://{{baseURL}}/api/v2/asset?company=1' \
--data '{
    "company": integer,
    "name": "string",
    "contract": integer,
    "category":
    {
        "id": integer,
        "subcategory": "string"
    },
    "attached_supplier":integer,
    "manufacturer": "string",
    "serial_number": "string",
    "pseudo_number": "string",
    "unit": "string",
    "bldng_name":"string",
    "street":"string",
    "floor": "string",
    "room":"string",
    "area":"string",
    "address": "string",
    "state_province": "string",
    "city": "string",
    "country": integer,
    "zip_code": "string",
    "location_description": "string",
    "general_info_notes":"string",
    "asset_owner": integer,
    "business_entity_type":"string",
    "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"
            }    
        }
    ]
}'
201 Created
Example Response
json
{
    "id": integer,
    "name": "string",
    "contract": {
        "id": integer,
        "number": "string"
    },
    "category": {
        "id": integer,
        "name": "string",
        "subcategory": "string"
    },
    "manufacturer": "string",
    "serial_number": "string",
    "pseudo_number": "string",
    "unit": "string",
    "bldng_name":"string",
    "street":"string",
    "floor": "string",
    "room":"string",
    "address": "string",
    "state_province": "string",
    "city": "string",
    "country": "string",
    "zip_code": "string",
    "region": "string",
    "location_description": "string",
    "general_info_notes":"string",
    "asset_owner": {
        "id": integer,
        "name": "string",
        "email": "string",
        "phone_number": "string"
    },
    "business_entity_type":"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"
    }, 
    "attached_supplier": {
        "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"
            } 
        }
    ]
}
No response headers
This request doesn't return any response headers

POSTCreate Asset Owner

https://{{baseURL}}/api/v2/asset-owner
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionRevnue API v2
Bodyraw (json)
json
{
    "company": integer,
    "name": "string",
    "email": "string",
    "phone": "string"
}
Example Request
Create Asset Owner
curl
curl --location -g 'https://{{baseURL}}/api/v2/asset-owner' \
--data '{
    "company": integer,
    "name": "string",
    "email": "string",
    "phone": "string"
}'
201 Created
Example Response
json
{
    "id": integer,
    "name": "string",
    "email": "string",
    "phone": "string"
}
No response headers
This request doesn't return any response headers

POSTCreate Business Entity

https://{{base_url}}/api/v2/business_entity
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionRevnue API v2
Bodyraw (json)
json
{     
 	"name": "string",
	"region": "string",
  "country": integer,
  "business_entity_type":""brand"|"division"|"location"|"property"|"retail_outlet"|"store"|"subsidiary"|"warehouse"|
}
Example Request
Create Business Entity
curl
curl --location -g 'https://{{base_url}}/api/v2/business_entity' \
--header 'Content-Type: application/json' \
--data '{     
  "name": "string",
  "region": "string",
  "country": integer,
  "business_entity_type":""brand"|"division"|"location"|"property"|"retail_outlet"|"store"|"subsidiary"|"warehouse"|
}'
Example Response
json
{
    "id": integer,
    "name": "string",
    "business_entity_type": "string",
    "logo": "string",
    "region": "string",
    "country_id": integer
}
No response headers
This request doesn't return any response headers

POSTCreate Business Unit

https://{{baseURL}}/api/v2/business-unit
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionRevnue API v2
Bodyraw (json)
json
{
    "company": integer,
    "name": "string",
    "contact_name": "string",
    "contact_email": "string",
    "contact_phone_number": "string",
    "description": "string"
}
Example Request
Create Business Unit
curl
curl --location -g 'https://{{baseURL}}/api/v2/business-unit' \
--data '{
    "company": integer,
    "name": "string",
    "contact_name": "string",
    "contact_email": "string",
    "contact_phone_number": "string",
    "description": "string"
}'
201 Created
Example Response
json
{
    "id": integer,
    "name": "string",
    "contact_name": "string",
    "contact_email": "string",
    "contact_phone_number": "string",
    "description": "string"
}
No response headers
This request doesn't return any response headers