Differences

This shows you the differences between two versions of the page.

Link to this comparison view

call_detail_records [2014/03/03 22:32]
ybarajas [CDR API]
call_detail_records [2014/03/27 17:35] (current)
ybarajas [CDR API]
Line 1: Line 1:
 +====== Call Detail Records ======
  
 +{{::ompcdr.png?600|}}
 +
 +The Call Detail Record (or CDR) is a summary of your company's transactions for a given month.
 +
 +**To download a CDR**
 +  - After **Type**, select one of the following:
 +    * **CDRs**: Download a record of all transactions for the selected month.
 +    * **CDR Adjustments**: iPass strives to provide its customers with accurate billing. As a result, we occasionally discover erroneous records. The Adjustment Call Detail Records detail prior-month corrections, and it is identical in format to the CDR file. **Note:** If there were no errors, this file is empty.
 +    * **(Optional) Monthly Service CDR**: Providers can access information here about iPass traffic on their network. These transactions are automatically credited to your account on your monthly voucher.
 +    * **(Optional) Monthly Service CDR Adjustments**: iPass strives to provide its customers with accurate billing. As a result, we occasionally discover erroneous records. The Monthly Service CDR Adjustments detail prior-month corrections, and it is identical in format to the Monthly Service CDR file. **Note:** If there were no errors, this file is empty.
 +    * **(Optional) Daily CDR**: If available to your account, download a record of all transactions for a selected day.
 +  - Select the **Month and Year** or **Date** that you would like to view.
 +  - Click the **Download** button. A CSV file will download (that you can open with Excel or any preferred application). See the description of each field (or column) below. 
 +
 +<note important>The Monthly Service CDR should not be opened with Excel, since Excel formats the **Minutes** field incorrectly. Please use a text editor to view these reports.</note>
 +===== Monthly and Daily CDR Fields =====
 +
 +Monthly and Daily CDRs contain the following fields.
 +
 +^ Field ^ Definition ^
 +| **Transaction ID** | This field contains a unique identifier for each transaction. It is a character field of up to 32 ASCII characters. It may be used for matching transaction records with other reports, and for identifying transactions when investigating problems. |
 +| **Billing Code** | This field is used internally by iPass. It is a character field of up to 32 ASCII characters. |
 +| **User ID** | This is the user login ID. The length of this field can be up to 256 ASCII characters. |
 +| **Authentication Domain** | This is the authentication domain specified by the user when connecting. It is normally identical to the corporate authentication domain, but may be different if an over-qualified domain name is used (e.g., mail.sales.corp.com instead of corp.com). The length of this field can be up to 128 ASCII characters. |
 +| **Description** | This field typically contains a description of the location at which the service was provided. This is a character field of up to 80 ASCII characters. The format is the ISO country code, city and venue name, special usage, and state. This field allows you to include a location description on your own statements. Special usage refers to keywords which indicate other relevant usage parameters, such as the use of toll free numbers (appears as 'Tollfree-ZZ', where ZZ is the two letter ISO country code), or high speed broadband access (appears as BrdBnd). |
 +| **GMT Time** | This timestamp is in Greenwich Mean Time (GMT) and records when the transaction was completed (i.e., transaction stop time). It is the time used by iPass for internal processing purposes such as determining which month a transaction occurred in. This is a fixed length character string with format "DD-MON-YYYY hh24:mm:ss". Note that 4 digit year codes are used. |
 +| **Local Time** | This field contains the local time of the connection at the provider. It is a fixed length character string with format "DD-MON-YYYY hh24:mm:ss". The value is the result of iPass applying a stored offset for the location to the GMT Time. All billing occurs of the GMT Time, Local Time is for informational purposes only. |
 +| **Length of Session** | A numeric field indicating the number of seconds that the user was connected. |
 +| **Billing Rate** | This numeric field provides the contracted rate for use of the access point. |
 +| **Net Billing Amount** | This numeric field contains the total cost for the transaction (before any applicable discount is applied). |
 +| **Access Type** | This field describes the type of technology used to access the network, and is a character field of up to 32 characters. The current values for this field are DIAL, ENET and WIFI. New values may be added in the future. |
 +| **Service Type** | This field details how the call was rated, and is a character field of up to 32 ASCII characters. For details on the current values that may appear in this field, please click [[:service_type_items|here]].  |
 +
 +===== Monthly Service CDR Fields =====
 +
 +Monthly Sevice CDRs contain the following fields.
 +
 +^ Field ^ Definition ^
 +| **Transaction ID** | This field contains a unique identifier for each transaction. It is a character field of up to 32 ASCII characters. It may be used for matching transaction records with other reports, and for identifying transactions when investigating problems. |
 +| **User ID** | This is the user login ID. The length of this field can be up to 256 ASCII characters. |
 +| **Date/Time** | This field contains the time of the connection. It is a fixed length character string with format "DD-MON-YYYY hh24:mm". |
 +| **Minutes** | Minutes:Seconds that the user was connected. **Note:** You have to open the file using a text editor to view this field correctly (Excel will format this field incorrectly). |
 +| **Rate** | This field provides the contracted rate for use of the access point, if available. |
 +| **Cost** | This field contains the total cost for the transaction (before any applicable discount is applied). |
 +| **Call ID** | This field includes the account session ID associated with a specific connection. |
 +
 +===== CDR API =====
 +
 +A CDR API is available for creating billing scripts. This feature will replace the iPass Fetch script, and like that script, it is not officially supported. For more information, please see {{::cdr_api.pdf|Call Detail Record (CDR) API}}
 +
 +For information on downloading child account IDs, please click [[:api_dowloading_child_accounts|here.]]
 +
 +
 +
 +Go to: **[[:portal_guide|Portal Guide]] > [[:account_tab|Account Tab]] > [[invoices_and_payments|Invoices and Payments]]**
 +
 +{{tag>account call_detail_record cdr invoices payments open_mobile_portal}}
 

©2015 iPass Inc. All rights reserved. Terms of Use