Versions Compared

Key

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

Back to Usage Detail Records Main Page

Excerpt
hiddentrue

Learn to work with UDRs

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to UDRs

Info

BILLING > BILLING > MANAGE USAGE DETAIL RECORDS

Using UDRs

Usage Details Records are used to hold information about orders made for Usage Services. They are created by the System when the user executes the Add Service Usage Subscription Action. Through the UDR Data Entry page the user can make updates to UDRs, whether already billed or not, to correct data registered by mistake in the System.

  • Navigate to UDRs and explore existing entries via the Summary page
  • Click on the link (name or number) of the record of your interest to enter the Data Entry page and see more detail. 
  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to theUDRs. 
  • Click on ACTIONS to discover other possibilities available for UDRs.

 

View the Attributes Table below for a comprehensive description of UDRs fields.  Check the Validations & Restrictions Table for a list of available Actions when working with UDRs including each Action's related restrictions, validations, additional information and a description of its system process.

USAGE DETAIL RECORDS

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional InformationSystem Processing
Edit
  • Not applicable
  • You cannot edit a UDR using the Edit Action

 

  • Not applicable
  • Not applicable
Delete
  • Not applicable
  • UDRs cannot be deleted
  • Check Cancel Action
  • Not applicable
Adjust
  • Not applicable
  • The UDR's Life Cycle State should be set to 'Posted'

All information can be modified in Usage Detail Records except the following:

  • Life Cycle State
  • Billing Directive
  • Related Accounts Receivable
  • Related Subscription
  • Related Subscription Service
  • Related Subscription Action
  • If the UDR was already rated then an identical opposite Rated Billing Item is created, with the same attributes but opposite sign.
Cancel
  • Not applicable
  • The UDR's Life Cycle State should be set to 'Posted'
  • Not applicable
  • If the UDR was already rated then an identical opposite Rated Billing Item is created, having the same attributes but opposite sign.
Setting UDR to 'Not To Be Billed'
  • Not applicable
  • The UDR's Life Cycle State should be set to 'Posted'
  • The UDR's Billing Directive should not be equal to 'Not To Be Billed'
  • Not applicable
  • If the UDR was already rated then an identical opposite Rated Billing Item is created, having the same attributes but opposite sign.
Setting UDR to 'To Be Billed'
  • Not applicable
  • The UDR's Life Cycle State should be set to 'Posted'
  • The UDR's Billing Directive should not be equal to 'To Be Billed'
  • Not applicable
  • If the UDR was already rated then an identical opposite Rated Billing Item is created, having the same attributes but opposite sign.
Setting UDR to 'To Be Credited'
  • Not applicable
  • The UDR's Billing Directive should not be equal to 'To Be Credited'
  • Not applicable
  • If the UDR was already rated then an identical opposite Rated Billing Item is created, having the same attributes but opposite sign.

 

Anchor
attributes
attributes
Attributes

Name

Description

Main Information
NumberAn auto-generated number which uniquely identifies each UDR.
Type

The type of the UDR.

Life Cycle State

The Life Cycle State of the UDR which can be either:

  • 'Scheduled.'
  • 'Posted.'
  • 'Cancelled.'
Accounts ReceivableThe Accounts Receivable associated with the Subscription that placed the order.
Subscription No.The Subscription on which the 'Add Usage Service' Action was executed and for which the Usage Service was ordered.
Subscription Service

 The necessary Termed Subscription Service, used as a base Service, to order a Usage Service.

Usage Service Catalog

The Catalog the Usage Service belongs to.

Usage Service*

The Usage Service that was ordered via the 'Add Service Usage' Action.

Usage Amount*The total usage amount if the UDR.
From Date

The date and time that the Service Usage began.

To Date

The date and time that the Service usage ended.

Source System

The system that generated the UDR.

Device

The device that used the Service.

Usage Method

The method that was applied to use the Service (e.g. rental or download).

Source ID

The ID of the source that initiated the Service (e.g. the phone number that initiated a call).

Source Category

The category of the source that initiated the Service. 

Destination ID

The ID of the destination that received the Service (e.g. the phone number that received a call).

Destination Category

The category of the destination that received the Service.

Added onThe date on which the Usage Service was added to the Subscription.
Added By Subscription ActionsThe Subscription Action that triggered the UDR.
Scheduled to Be Executed onThe date on which the Add Service Usage Action is scheduled to be executed.
Executed onThe date on which the Add Service Usage Action is executed.
Billing Information
Billing Directive*

The UDR Billing Directive provides guidelines to the Billing Engine regarding the handling of the UDR and can have one of the following values:

  • 'To Be Billed'
  • 'To Be Credited'
  • 'Not To Be Billed'
Billing Effective Date*The UDR Billing Effective Date which indicates the date on which UDR will be considered by the Billing Run.
Rating State
Status
colourRed
titleAvailable from CRM.COM R9.0.0
 

It indicates whether or not the Usage Detail Record was rated by the Billing Engine. The available rating states are:

  • 'Pending': The UDR was not rated yet or was rated, but the Rated Billing Item was cancelled.
  • 'Completed': The UDR was already rated.

Rating Type

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

The Rating Type of the UDR which is set automatically while submitting a UDR, based on how the UDR Product was defined in the related Usage Service Catalog. The following options can be applied:

  • Post-Rated: This is the default option. The UDR will be rated by CRM.COM rating engine based on the related Price Plan's rate.
  • Pre-Rated: The UDR is already pre-rated based on the Amounts that are defined in the related Usage Service Catalog provided while submitting the UDR and CRM.COM will not apply any additional rating.

Total Amount

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

The Total Amount that the UDR was rated for. If the UDR is Post-Rated then this information is set by the CRM.COM rating engine while rating the UDR otherwise, it is set while submitting the UDR.

VAT Amount

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

The VAT Amount that was applied on the UDR. If the UDR is Post-Rated then this information is set by the CRM.COM rating engine while rating the UDR otherwise, it is set while submitting the UDR.

Discount Amount

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

The Discount Amount that was applied on the UDR. If the UDR is Post-Rated then this information is set by the CRM.COM rating engine while rating the UDR otherwise, it is set while submitting the UDR.

Rating Date

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

The date that the UDR was rated. If the UDR is Post-Rated then this information is set by the CRM.COM rating engine while rating the UDR otherwise, it is set while submitting the UDR.
Log Information
Log DetailsThe standard set of Log Details information available in all entities.

Anchor
add_actions
add_actions
Additional Actions for UDRs

Adjusting UDRs

This process is used to modify specific attributes and correct UDRs, whether already billed or not. 

  1. Navigate to Usage Detail Records
  2. Search for the UDR to adjust and click on its Number to go to the Data Entry page.
  3. From the Actions Menu click on ACTIONS > ADJUST.
  4. Modify the information in the modal window:
    • Product: Indicate the actual Usage Service that was used. 
    • Usage Amount: Indicate the UDR total usage amount.
    • Source: Indicate the system that generated the UDR. The source systems are filtered based on the selected UDR Type.
    • Type: Indicate the type of the UDR.
    • Billing Effective Date: Indicate the UDR Billing Effective Date.
    • From Date: Indicate the date and time that the Service Usage began.
    • To Date: Indicate the date and time that the Service Usage ended.
  5. Click on SAVE on the Modal.

Cancelling UDRs

This process is used to cancel a UDR, whether already billed or not, by setting its state to 'Cancelled'.

  1. Navigate to Usage Detail Records.
  2. Search for the UDR to cancel and click on its Number to go to the Data Entry page.
  3. From the Actions Menu click on ACTIONS > CANCEL.

Changing the Billing Directive of a UDR

It is possible to modify the Billing Directive of a UDR, whether already billed or not, to reverse an Action, such as crediting an already billed UDR or excluding the UDR from billing. 

  • An existing UDR's Billing Directive can be set to 'Not To Be Billed', 'To Be Billed' or 'To Be Credited'.

There are three Actions available, one for each Billing Directive. Follow the steps below to update to the required Billing Directive.

  1. Navigate to Usage Detail Records.
  2. Search for the UDR whose Billing Directive should be updated, and click on its Number to go to the Data Entry page.
  3. From the Actions Menu click on ACTIONS and select between:
    1. SET AS BILLABLE
    2. SET AS CREDITABLE
    3. SET AS NOT TO BE BILLED

Note

View Understanding Usage Service Catalogs for business examples related to creating UDRs.

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsudrs-basics-r7,udrs-advanced-r7,udrs-admin-r7

Panel
namegrey

Helpful Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsglobal