Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved usage detail record

number

String

The number of the retrieved usage detail record

life_cycle_stateString

The state of the retrieved usage detail record which can be one of the following:

POSTED, CANCELLED

billing_directiveString

The usage detail record billing directive which can be one of the following:

TO_BE_BILLED, TO_BE_CREDITED, NOT_TO_BE_BILLED

billing_effective_dateDateThe usage detail record billing effective date
from_dateDateThe date that the usage of the service started
to_dateNumberThe date that the usage of the service stopped
source_idStringThe ID of the source that initiated the service, for example the phone number that initiated a phone call
destination_idStringThe category of the source that initiated the service. The source categories are filtered based on the selected UDR Type
usage_amountNumberThe usage detail record total usage amount
rating_stateString

The rating state of the usage detail record, which can be one of the following:

PENDING, COMPLETED

Tip

Available from CRM.COM R9.0.0

rating_typeStringThe rating type of the usage detail record, which can be one of the following:
  • POSTRATED: The UDR will be rated by CRM.COM rating engine
  • PRERATED: The UDR is already pre rated and CRM.COM will not apply any additional rating

Tip

Available from CRM.COM R12.0.0

total_amountNumber

The total amount that the UDR was rated for. If the UDR is Post-Rated then this information is set by the the CRM.COM rating engine while rating the UDR. If the UDR is Pre-Rated then this information should be set while submitting the UDR

 

Tip

Available from CRM.COM R12.0.0

vat_amountNumberThe VAT amount that was applied on the UDR. If the UDR is Post-Rated then this information is set by the the CRM.COM rating engine while rating the UDR. If the UDR is Pre-Rated then this information should be set while submitting the UDR

 

Tip

Available from CRM.COM R12.0.0

tax_amountNumber

The total Tax amount that was applied on the UDR. If the UDR is Post-Rated then this information is set by the the CRM.COM rating engine while rating the UDR. If the UDR is Pre-Rated then this information should be set while submitting the UDR

Tip

Available from CRM.COM R12.0.0

discount_amountNumberThe discount amount that was applied on the UDR. If the UDR is Post-Rated then this information is set by the the CRM.COM rating engine while rating the UDR. If the UDR is Pre-Rated then this information should be set while submitting the UDR

 

Tip

Available from CRM.COM R12.0.0

rating_dateDateThe date that the UDR was rated. If the UDR is Post-Rated then this information is set by the the CRM.COM rating engine while rating the UDR. If the UDR is Pre-Rated then this information should be set while submitting the UDR

 

Tip

Available from CRM.COM R12.0.0

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

accounts_receivableAccounts receivable objectThe related accounts receivable
subscriptionSubscription objectThe related subscription object
subscription_serviceSubscription Service objectThe related subscription service object, which is classified as a usage service
productProduct objectThe actual product that was used, which is classified as a usage service
subscription_actionSubscription Action objectThe subscription action that generated the usage detail record
source_systemUsage Detail Record Source System objectThe source system that generated the usage detail record
typeUsage Detail Record Type objectThe type of the usage detail record
usage_service_catalogUsage Service Catalog ObjectThe usage service catalog that the service that was used belongs to.
deviceUsage Detail Record Device ObjectThe device that used the service.
usage_methodUsage Detail Record Usage Method ObjectThe method that was applied on using the service (for example rental, download etc.)
source_categoryUsage Detail Record Source Category ObjectThe category of the source that initiated the service. 
destination_categoryUsage Detail Record Destination Category ObjectThe category of the destination that received the service.

log_information

Log Information Object

The log information related with the retrieved usage detail record

...