Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Name

Type

Description

id

String

The ID of the retrieved installed item

serial_number

String

The serial number of the retrieved installed item

alternative_codeStringThe alternative code of the retrieved installed item
stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationString

The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective

Applicable only if the Installed Item was set as Not Effective through automation process

Tip

Available from CRM.COM R14.0.0


notesStringNotes for the retrieved installed item
ownership_statusString

The ownership status of the retrieved installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE

Tip

Deprecated from CRM.COM R10.0.0 and available through ownership_information attribute


warehouse_issue_dateDate

The date of the stock out warehouse transaction which is related to the retrieved installed item. This information is available only when the retrieved installed item is covered by a Warranty Policy.

Tip

Available from CRM.COM R9.0.0


warranty_remaining_coverage_durationInteger

Defines the installed item's warranty remaining coverage duration, counted in days. This information is applicable only when the installed item's warranty policy was carried over from another installed item during replacement.

Tip

Available from CRM.COM R9.0.0


total_meter_readingInteger

Defines the total meter reading of the related Installed Item

If the Meter Reading Type of the Installed Item is ONETIME, then the value of this object will be the sum up of all meter readings

If the Meter Reading Type of the Installed Item is CUMULATIVE, then the value of this object will be the value of the last meter reading

Tip

Available from CRM.COM R14.0.0

From CRM.COM R17.0.0, ONE_TIME_READING is renamed to CONSUMPTION_READING


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

product

Product object

The product of the retrieved installed item

category

Installed item category object

The category of the retrieved installed item

Tip

Deprecated from R18.0.0


location

Installed item location object

The location of the retrieved installed item

Tip

Deprecated from CRM.COM R10.0.0 and available through ownership_information attribute


ownership_informationInstalled item ownership information object

The ownership information of the retrieved installed item

Tip

Available from CRM.COM R10.0.0


warranty_policyWarranty Policy Object

The Warranty Policy which covers the retrieved installed item

Tip

Available from CRM.COM R9.0.0


return_policyReturn Policy Object

The Return Policy which covers the retrieved installed item

Tip

Available from CRM.COM R14.2.0


item_locationItem Location Object

The installation and local location of the related installed item

Tip

Available from CRM.COM R15.1.0


components_setSet of Installed Item Components

The components of the retrieved installed item. This information is available only if the product type of the installed item is classified as fixed product bundle

 


provisioning_provider_parameters_setSet of Installed Item Provisioning Provider Parameters

The parameters which are defined for the specific installed item and are required by the provisioning providers which are provisioning the installed item

Tip

Available from CRM.COM R8.0.0


termed_services_distribution_setSet of Termed Service Distribution Objects

The distribution of termed subscription services

Tip

Available from CRM.COM R14.0.0


meter_reading_setSet of Meter Reading Objects

The meter readings of the related installed item

Tip

Available from CRM.COM R14.0.0


metadata_attribute_value_setSet of Metadata Attribute Values Objects

The metadata fields' values of the related installed item

Tip

Available from CRM.COM R15.0.0


log_information

Log Information Object

The log information related with the retrieved installed item

Anchor
installed item referred objects
installed item referred objects
Referred Objects Response Data

...

Include Page
warranty_short
warranty_short

Include Page
return_policy_short
return_policy_short

Include Page
installed_item_component_short
installed_item_component_short

...

Include Page
installed_item_meter_reading_short
installed_item_meter_reading_short

Include Page
item_location_short
item_location_short

Include Page
metadata_attribute_value_short
metadata_attribute_value_short

...