Report Parameters List
Report parameters help you to filter data and define the information that is returned in your report.
The following table lists the parameters available in the Standard Reports folder of the Reporting Tool (refer to Reporting for more information).
Parameter | Description | Default Value | Report |
---|---|---|---|
Account Category |
Define the account categories to include in the report. |
All |
Scheduled Charges Invoice — GL Information Deactivation |
Account Number |
The unique billing account number of the billing account. Select from a drop-down list or manually enter either a single account number or a comma-separated list of account numbers into the parameter field to report on specific accounts. |
All |
Invoice Outstanding Report Details Customer Balance Report Details Payment Method Validation Backdated Aged AR Report Taxes (Month) Email Notification Invoice — GL Information Invoice Outstanding Report Details Payment Method Validation GL Entry Unbilled Usage - Pending Charges |
Action |
The event that occurs when the rule is triggered.
|
|
Action Configuration |
Action Type |
The sort of action that has been configured. Actions can be of the following types:
|
|
Action Configuration |
Aging By |
Determines whether to age transactions by invoice due date or invoice date. |
|
|
Agreement End Action |
The event that occurs to the subscription when the Agreement ends.
|
|
Agreement Expiration by Product Report Details Billing Account Services by Agreement with End Action and Date Report Details Customer Count by Product |
Agreement End Date |
The date the agreement end action occurs. A range of agreement end dates can be selected. |
|
Agreement Count Report Details Billing Account Services by Agreement with End Action and Date Report Details |
Agreement Name |
The name of the agreement associated with the product/service. The product might have more than one agreement, and you need to specify which one by using its name. A service has only one agreement. |
|
Agreement Count Report Details Billing Account Services by Agreement with End Action and Date Report Details |
Agreement Processing Status |
Status of the agreement in relation to a service. Options include:
|
|
Billing Account Services by Agreement with End Action and Date Report Details |
Amount |
The dollar range of the payment amount on which to report. |
All |
Payments |
AR Ledger ID |
The unique ID of an AR Ledger |
All |
Journal Entry Review by Service |
As Of Date |
The end date for the report data. Data values shown in the report are as of this date. |
|
|
Authority Levels |
Authority levels to include in the report. |
|
Security Role Profile |
Balance (Account) |
The amount of the balance of each account to include in the report. |
All |
|
Bill Cycle |
The bill cycles to include in the report. |
All |
Customer Balance Report Details Bill Cycle Details |
Bill Cycle Name |
The bill cycle by name to include in the report. |
All |
|
Bill Cycle Run |
The bill cycle run to summarize. |
All |
|
Billing Account Category |
The defined billing account categories to include in the report. |
All |
Billing Account Services by Agreement with End Action and Date Report Details Customer Balance Report Details Invoice Outstanding Report Details Net Service Change Invoice Details Report Details GL Entry |
Billing Account Number |
The unique billing account number of the billing account. Select from a drop-down lists or manually enter either a single account number or a comma-separated list of account numbers into the parameter field to report on specific accounts. |
All |
Billing Account Services by Agreement with End Action and Date Report Details |
Billing Account Status |
The billing account statuses to include in the report:
|
All |
|
Consumption |
The customer's activities usage that counts towards an allowance as defined by the activity rule. |
|
Allowance Threshold Exceeded |
Created On From Date |
Report begins at this creation date for journal entries associated with a transaction. |
|
GL Entry |
Create On To Date |
Report ends at this creation date for journal entries associated with a transaction. |
|
GL Entry |
Currency |
Currency to be displayed in the report. |
|
|
Days Open |
The number of days in thirty day increments for which the invoice is open and unpaid. |
All |
|
Days Overdue |
The number of days an invoice is overdue to be included in the report. You can specify the number of days late. |
All |
Aging |
End (Date) |
The ending date for the report. The report includes all occurrences between the Start Date and the End Date. All payments made up to and including this date are included in the report. |
|
Agreement Expiration by Product Report Details Customer Balance Report Details Payments Upcoming Invoice Scheduled Charges |
Event Start Date From |
The start date for the report. The report includes all occurrences between the Event Start Date From and the Event Start Date To. |
|
Invoiced Usage |
Event Start Date To |
The end date for the report. The report includes all occurrences between the Event Start Date From and the Event Start Date To. |
|
Invoiced Usage |
Expiration Date From |
The starting date for the report. All invoices created between the Expiration Date From and the Expiration Date To are included in the report. All invoices created on and after this date are included in the report. |
|
|
Expiration Date To |
The end date for the report. All invoices created between the Expiration Date From and the Expiration Date To are included in the report. The default is today's date. |
|
|
From Date |
The start date for the report. |
|
Payment Method Validation |
Gateway |
The payment processor used to preauthorize automatic payments. |
|
Payment Method Validation |
GL Account |
The unique ID for a GL account. |
All |
Journal Entry Review by Service |
GL Account Category |
The defined GL account categories to include in the report. |
All |
GL Entry |
GL Account Designation |
The designation of a GL Account. Options are None, Cash, Unbilled AR, Billed AR, AR Reserve, Sales Reserve, Contract Asset, Customer Prepaid Liability, Sales Tax Liability, Deferred Revenue, Equity, Recognized Revenue, Sales Allowance, Bank Fee, and Sales Tax Expense. |
All |
Journal Entry Review by Service |
GL Account Number |
The account number designated for a GL account when setting up a Chart of Accounts. Select All or enter either a single account number or a comma-separated list of account numbers into the parameter field to report on specific accounts. |
All |
GL Entry |
How Many Month |
Indicates the span of months the report will cover. |
|
|
Include Debit Adjustments? |
Indicates whether to include debit adjustments in the report data. |
|
|
Invoice Date From |
The starting date for the report. All invoices created between the Invoice Date From and the Invoice Date To are included in the report. All invoices created on and after this date are included in the report. |
|
|
Invoice Date To |
The ending date for the report. All invoices created between the Invoice Date From and the Invoice Date To are included in the report. All invoices created up to and including this date are included in the report. |
|
|
Invoice Number |
An invoice number to include in the report. Select All or enter an invoice number to include in the report. |
All |
|
Invoiced |
Indicates whether the scheduled charges have been Invoiced yet. Select All to return invoiced and not yet invoiced scheduled charges. |
All |
Scheduled Charges |
Month |
The month for which you wish to run the report. |
|
Net Service Change Account Upgrade/Downgrade |
Month Duration Or Date Range? |
Indicates whether to use a span of months or a date range for the report. |
|
|
Need Time Frame For Approval Date? |
Indicates that you are using a time span on which to report. If you select Yes, then enter Start and End dates. |
|
Pending Order with Approvals Scheduled Charges |
Occurred On From Date |
Report begins at this effective date for financial transactions. |
|
GL Entry |
Occurred On To Date |
Report ends at this effective date for financial transactions. |
|
GL Entry |
Or Select Start Date |
The starting date for the report. The report will include all occurrences between the Start date and the End date. |
|
|
Order Item Status |
The status of the orders included in the report:
|
All Statuses |
|
Output Type |
The format (output-target) in which you want the report to appear. The browser window displays only reports created using the HTML (Paginated) format, the HTML (Single Page) format, and the Text format. All other formats require a separate application to display the report. Options:
|
HTML (Paginated) |
All reports |
Payment Card Type |
If a credit card was used to make the payment, the type of credit card that was used:
|
All Card Types |
Payments |
Payment Or Refund |
Indicates whether to report on transactions that are payments or refunds. |
|
Payments |
Payment Type |
The type of payment:
|
All Types |
Payments |
Percentage Of |
Indicates the amount of usage as a percentage of the configured threshold. |
|
Allowance Threshold Exceeded |
Product Category |
Product category of a service. |
All |
Billing Account Services by Agreement with End Action and Date Report Details |
Product (Name) |
The product that was sold and included in this report. All your company's active products are listed in the drop-down list. |
All Products |
Customer Count by Product Customer Detail by Agreement Expiration Report Details Product Configuration |
Product Type |
Specifies the kind of product defined by configuration, such as the following:
|
|
Product Configuration |
Reference ID |
The reference ID of a usage event. |
|
Unbilled Usage - Pending Charges |
Referral |
The person, company, or website name that referred the customer to your company. |
|
|
Results Presentation |
Indicates how to display results. Selections depend on the selected report. |
|
Aging Billing History By Customer or Product |
Revenue Range |
The ranges in dollars in which the customer lifetime values are reported. |
|
Customer Lifetime Value |
Scheduled Approval |
Shows those orders that are scheduled for approval during the specified time range. |
|
Pending Order with Approvals |
Service Status |
Indicates whether the service is in use or is no longer in use by the customer.
|
|
Customer Detail Report Details Product Detail |
Service ID |
The unique ID of a service. |
All |
Journal Entry Review by Service |
Service Period From |
The starting date for the service. The report lists all service that was consumed by the customer between the Service Period From date and the Service Period To date. For billing purposes, the service provided may encompass starting and ending dates that do not match the invoice dates. |
|
|
Service Period To |
The ending date for the service. The report lists all service that was consumed by the customer between the Service Period From date and the Service Period To date. For billing purposes, the service provided may encompass starting and ending dates that do not match the invoice dates. |
|
|
Service Resource Identifier (SRID) |
Include the SRID - an identifier assigned to usage so that it matches with the correct services. |
|
Invoiced Usage |
Sequence ID |
The sequence ID of a usage event. |
|
Unbilled Usage - Pending Charges |
Show Enabled Only |
Returns the actions that are on and executed when the rule parameters are met. |
|
Action Configuration |
Start |
The starting date for the report. The report will include all occurrences between the Start date and the End date. |
|
Customer Balance Report Details Payments |
Start Month |
Select the month to define the start of the date range of the report. |
|
Journal Entry by Service |
Status (Payment) |
The current processing state of the payment transaction:
|
All Statuses |
Payments |
Status (Pre-authorization) |
The status of the pre-authorization of credit cards used in automatic payments. |
|
Payment Method Validation |
Status (Product) |
Indicates whether the product is in one of the following states:
|
|
Product Configuration |
Status (System Configuration) |
The state of the system parameters to display on the report:
|
|
System Configuration |
Summary Only |
Select one of the following choices:
|
|
|
Thru Date |
The end date for this report. |
|
Payment Method Validation |
Transaction Trigger |
The event that triggers a GL entry. For example: on payment, on invoice, or on revenue recognition. The default is All. |
|
GL Entry |
Transaction Type |
Type of transaction to include. |
|
GL Entry |
Year |
The year for which you wish to run the report. |
|
Net Service Change Account Upgrade/Downgrade |