Skip to end of banner
Go to start of banner

usage_service_catalog_usage_services_complete

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

NameType Description
idStringThe ID of the retrieved usage service catalog usage service
base_rateFloatThe base rate of the retrieved usage service catalog usage service
start_dateStringThe date and time during which the provisioning of the usage service catalog usage service will start
end_dateStringThe date and time during which the provisioning of the usage service catalog usage service will end

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

log_informationLog Information ObjectThe log information of the retrieved usage service catalog usage service
tiered_rates_setSet of Usage Service Tiered Rates ObjectsThe tiered rates related with the retrieved usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions

Referred Objects Response Data

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 usage_service_tier_rates object data response
NameType Description
idStringThe id of the retrieved usage service tiered rate
rateFloatThe rate of the retrieved usage service tiered rate
minimum_usageFloatThe minimum usage of the service that should be applied in order for the specified rate to be applicable
maximum_usageFloatThe maximum usage of the service that should be applied in order for the specified rate to be applicable
usage_start_timeHour / Minute ObjectThe usage start time during which the specified rate is applicable
usage_end_timeHour / Minute ObjectThe usage end time during which the specified rate is applicable
usage_methodUsage Detail Record Usage Method ObjectThe usage method that should be used in order for the specified rate to be applicable
deviceUsage Detail Record Device ObjectThe device that should be used in order for the specified rate to be applicable
source_categoryUsage Detail Record Source Category ObjectThe source category that should be used in order for the specified rate to be applicable
destination_categoryUsage Detail Record Destination Category ObjectThe destination category that should be used in order for the specified rate to be applicable

Referred Objects Response Data

 usage_detail_record_usage_method object data response
NameType Description
IdStringThe ID of the retrieved usage detail record usage method
nameStringThe Name of the retrieved usage detail record usage method
alternative_codeStringThe Alternative Code of the retrieved usage detail record usage method
descriptionStringThe Description of the retrieved usage detail record usage method

 usage_detail_record_device object data response
NameType Description
IdStringThe ID of the retrieved usage detail record device
nameStringThe Name of the retrieved usage detail record device
alternative_codeStringThe Alternative Code of the retrieved usage detail record device
descriptionStringThe Description of the retrieved usage detail record device

 usage_detail_record_source_category response data object
NameType Description
IdStringThe ID of the retrieved usage detail record source category
nameStringThe Name of the retrieved usage detail record source category
codeStringThe code of the retrieved usage detail record source category
descriptionStringThe description of the retrieved usage detail record source category

 usage_detail_record_destination_category response data object
NameType Description
IdStringThe ID of the retrieved usage detail record destination category
nameStringThe Name of the retrieved usage detail record destination category
codeStringThe code of the retrieved usage detail record destination category
descriptionStringThe description of the retrieved usage detail record destination category

 hour / minute object response data

Name

Type

Description

hourNumber

The hour value

minuteNumberThe minute value

  • No labels