xDRs

Link copied to clipboard

Recent xDRs

Link copied to clipboard

The xDRs are billing data records that store information about various billing events, including calls, SMS messages, and payment transactions.

The Recent xDRs tab allows you to filter xDRs created in the current billing period and that have not been archived yet.

Recent xDRs

Search xDRs

Link copied to clipboard

Specify one or more search criteria and click Search. To obtain more precise results, click More Open the list of search criteria to open advanced search criteria.

Click Default filters default filters to reset the search criteria.

Service

Link copied to clipboard

Filter xDRs per service, e.g., for voice calls. The list includes the default services and the services you have created. You can also filter xDRs separately for subscriptions, payments, taxes, DID usage, etc.

From (CLI)

Link copied to clipboard

Filter the xDRs by the phone number of the session originator (a caller or the message sender). This field is available for Voice calls, Conferencing, and Messaging service types only. By default, PortaBilling filters phone numbers that start with your input.

To change the search mode for this field, click Matching mode Matching mode and select another option to filter xDRs by the originating phone number that:

  • Exactly matches – exactly matches your input.
  • Starts with – starts with your input.
  • Contains – contains your input (anywhere in the number).
  • Ends with – ends with your input.

PortaBilling automatically saves the matching mode from the previous search.

To (CLD)

Link copied to clipboard

Filter the xDRs by the destination phone number or the message recipient. This field is available for Voice calls, Conferencing, and Messaging service types only. By default, PortaBilling filters phone numbers that start with your input.

To change the search mode for this field, click Matching mode Matching mode and select another option to filter xDRs by the destination phone number that:

  • Exactly matches – exactly matches your input.
  • Starts with – starts with your input.
  • Contains – contains your input (anywhere in the number).
  • Ends with – ends with your input.

PortaBilling automatically saves the matching mode from the previous search.

Period

Link copied to clipboard

Specify the time period for which xDRs should be displayed. Click Calendar calendar-1 to select a period (for example, the last 24 hours) or a specific date and time.

To clear the selected date, click Cancel cancel.

Show xDRs for

Link copied to clipboard

Filter the xDRs per account type. By default, PortaBilling searches for xDRs produced for the customer and all their credit accounts. Select Debit accounts to see the xDRs produced for the customer’s debit accounts.

Domestic or roaming usage

Link copied to clipboard

Filter the xDRs produced for roaming or domestic usage. This field is available when Voice calls, Messaging, or Internet services are selected in the Service field.

Call quality

Link copied to clipboard

Filter the xDRs by the quality status set for calls. The options are:

  • Any – PortaBilling searches xDRs regardless of their status.
  • Unknown – PortaBilling filters xDRs that don’t have a quality status defined.
  • Good – PortaBilling filters xDRs with the quality status set as good.
  • Fair – PortaBilling filters xDRs with the quality status set as fair.
  • Poor – PortaBilling filters xDRs with the quality status set as poor.

To see the call quality details for the filtered xDRs, you must additionally select “Voice calls” in the Service field before applying filters.

Show unsuccessful attempts

Link copied to clipboard

This option is available for Voice calls, Conferencing, and Messaging service types only. Turn on the toggle to include xDRs for unsuccessful session attempts in the results list.

xDR list

Link copied to clipboard

The columns differ depending on the selected service. These are the main columns:

Service

Link copied to clipboard

This column is displayed only when the Service filter is set to Any. It shows the service name (e.g., Voice calls) or the transaction type (e.g., Credits/Adjustments).

Status

Link copied to clipboard

This column is displayed only when a specific service is selected in the Service filter. It indicates that the xDR has been Reverted Reverted.png or reverted and Hidden hidden (both the original and correction xDRs are marked as “Hidden”). Refer to the Reverse an xDR chapter for more details.

Account/Alias

Link copied to clipboard

The ID of the account charged. The ID is the link to this account's page. It is empty if the charge is applied directly to the customer.

Transaction time

Link copied to clipboard

Shows the date and time of the transaction.

Charged amount

Link copied to clipboard

The sum of charges applied.

Call quality

Link copied to clipboard

If call quality monitoring is configured, this column shows the voice call quality grades, e.g., “Good,” “Poor,” etc. Click Call quality status to review the extended info on the call quality metrics.

To see the call quality details for the filtered xDRs, you must select “Voice calls” in the Service field before applying filters.

Call quality details

Additional info

Link copied to clipboard

Shows additional information about the transaction, e.g., subscription name.

Details

Link copied to clipboard

Click Info Details to view the detailed information about the session. You can see the general information about the session, such as time zone, transaction status, and/or error code, duration, etc. Click the tabs in the details window to see the session details for an account, reseller, and vendor separately. Find the available auxiliary information about the session:

  • information about the roaming country and carrier,
  • information about PBX calls such as hunt group or an extension number that made, accepted or redirected the call, as well as information about split sessions, if available.

If the Download call record button is unavailable for a successful call, hover over the Info Details next to it to see the reason. The possible explanations are:

  • call recording was off at the time of the call
  • recording is still being processed
  • codec used during the call is not supported by call recording

The Details column is available for xDRs for Voice calls, Messaging, Netaccess, and Conferencing service types.

Session details

View log

Link copied to clipboard

View  to view the log of this session in the Log viewer.

How to download xDRs

Link copied to clipboard

To download filtered xDRs in the .csv format, click Download on the toolbar, then click Notifications notification_icon on the toolbar, open the notification, and click Download.

xDR summary

Link copied to clipboard

Click Summary on the toolbar to see the xDR summary information for the selected period. The xDR summary includes the following information:

  • Total number of xDRs filtered
  • Total by services
  • Total sum of taxes
  • Total sum of payments and credits

xDR summary

Reverse an xDR

Link copied to clipboard

To reverse an xDR, select it from the list and click Revert. Make some comment about your actions (e.g., the reason for the revert).

A long internet session may include several authorization requests, and PortaBilling groups them into one aggregated xDR. When you reverse such a record, you can select all included xDRs or only specific ones.

Select xDRs to revert

If you select both aggregated and individual xDRs for reversal, all xDRs included in the aggregated record will be reverted.

Revert xDRs warning

To reverse an xDR as if it had never happened, turn on the Hide the original and reversal xDRs from the end user toggle switch. This marks the original and correction xDRs as Hidden hidden. End users will not see these xDRs in their invoices, or on self-care interfaces or in statistics. This option is only available when a reverse transaction amount is equal to the original transaction(s) amount and all of the transaction xDRs are included in the open billing period or in the invoice that is under review.

Note that you must be very careful with the Hide the original and reversal xDRs from the end user option. Once an xDR becomes hidden, it’s not possible to reverse it. So if you reverse a transaction by mistake and mark it as hidden, you can only correct that by manually charging for the transaction amount or by importing an analogous xDR.

Revert xDRs - hide

Customize the list

Link copied to clipboard

To customize the search result list, click Settings edit. Adjust which columns to display, the row style, or reset the settings to the default ones.

  • Re-order the columns – drag-and-drop the column headers right or left to place the columns in the order you want.
  • Re-order the rows – click Arrow up (or down) next to the column header to re-sort the rows. For example, this panel displays xDRs in chronological order, starting from the newest one. You can re-sort them in reverse order.
  • Change the default number of results globally – use the Number of rows per page dropdown list in the lower-right corner to adjust the maximum number of rows displayed on the page.

Archived xDRs

Link copied to clipboard

On this tab, you can choose the parameters of the archived xDRs report (the xDRs become archived once the customers’ billing period closes). To download a report with archived xDRs, set the search criteria and then click the relevant date on the calendar.

Archived xDRs

Billing period

Link copied to clipboard

Shows the customer’s billing period (defined in Finances > General info > Billing period).

Year

Link copied to clipboard

Select the year when the archived xDR report was generated.

Report type

Link copied to clipboard

Select the type of xDR report you want to download:

  • Standard xDRs report – generated for all customer’s accounts.
  • Site based report – generated for accounts that belong to a specific customer site. This option is disabled by default. To allow downloading reports of this type, specify the file format (Sites_Based_Report_CSV and/or Sites_Based_Report_PDF) in CustomXDRReport.EnabledPlugins option on the Configuration server web interface.

xDRs belong to

Link copied to clipboard

Choose what xDRs to include on the report by account type. By default, PortaBilling searches for the xDRs produced for the Customer and all their credit accounts. Select Debit accounts to download the archived xDRs produced for the customer’s debit accounts.

File format

Link copied to clipboard

Choose the file format to download xDR report.

  • .csv
  • .pdf – is available only for a site-based report (if the .pdf format is allowed).

Zip the file before download

Link copied to clipboard

By default, the archived xDRs are downloaded as compressed archived files (.zip). You can clear the checkbox, and then the archived xDRs are downloaded in the format defined in the

File format field.

Download archived xDRs

Link copied to clipboard

To download the archived xDRs, click the exact date in the calendar, and the file is automatically downloaded.

Download the archived xDRs

Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation