billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Chapter 10. Memorized Reports

Table of Contents

Creating Memorized Customized Reports
Tables and Fields of the BillMax Reports Database
Accessing a Memorized Report
Managing the BillMax Reports Database

In addition to the "Custom SQL" reporting described previously, BillMax offers a mechanism for creating memorized customized reports. These are reports that may be run many times and may prompt for variable data.

In addition to the data that comes from the BillMax tables, memorized reports may also access data stored in the BillMax Reports database. See "BillMax for Accountants" for more detail on the BillMax Reports database.

Creating Memorized Customized Reports

In order to create a memorized report, click on "Setting" on the Navigation Bar and then then "Create Memorized Reports" button. This displays the following:

Figure 10.1. Create Memorized Report

Create Memorized Report
(1)

Click on "SAVE" to save the current query. The query must be saved in order for "TEST" to be effective.

(2)

Click on "SAVE AS NEW" to store the current query as a new one.

(3)

Click on "DELETE" to delete the current query.

(4)

Click on "TEST" to test the current query that is stored in the database. If an existing query is retrieved and the query is modified without saving it, then when testing the query, the modified query is ignored and the stored query is tested.

(5)

The description of the query.

(6)

The actual query.

(7)

The Permissions set that a Authorized BillMax User's Permissions set must intersect in order to view and run the query generating the report.


Clicking the "TEST" displays the following:

Figure 10.2. Testing a Memorized Report

Testing a Memorized Report
(1)

A drop down allowing the selection of any report to test.

(2)

A link back to the page for defining the report.

(3)

If checked, the report may be downloaded in a CSV format.

(4)

Click on "CREATE REPORT" to generate the report.


Figure 10.3. Test Results

Test Results

A memorized report may prompt the Authorized BillMax User for data. This is done by using the "$" character.

Figure 10.4. Create Memorized Report with Variable Input

Create Memorized Report with Variable Input
(1)

Note the use of the "$" character.


Figure 10.5. Testing a Memorized Report with Variable Input

Testing a Memorized Report with Variable Input
(1)

The input field for the data supplied by the Customer Service Representative. Note that the data supplied must match the type expected. For example, if a date is requested, the Customer Service Representative must supply a date in the form YYYY-MM-DD or the report will be incorrect.


Figure 10.6. Variable Data Test Results

Variable Data Test Results

A memorized report may also be used to access detail data generated by certain financial reports. When these reports are run, the detail data may be optionally stored in the BillMax Reports database. The reports that store data in the BillMax Reports database and their variable reference are:

Report Type Memorized Report Variable
Sales Report $accrualsales
Deferred Revenue $accrualsales
Invoice Aging $invoiceaging
Aging $aging

When one of these financial reports is run with the option selected to create a detail table in the BillMax Reports database, the name of the table is printed at the bottom of the report.

(1)

The name of the table. The format of the name is reportname_datetime_systemid.

The data from one of the tables may be used in a memorized report. The table is accessed using the "Memorized Report Variable" listed in the table above.

Figure 10.7. Define Report of Non-Taxable Recurring Sales by Zip Code

Define Report of Non-Taxable Recurring Sales by Zip Code
(1)

Example using a stored financial report table.


Figure 10.8. Testing a Memorized Report with a Financial Table

Testing a Memorized Report with a Financial Table
(1)

The table name from the BillMax Reports database.

(2)

Click on the link to select a table from the BillMax Reports database to use.

(3)

Lists the options that were selected when running the report.


Figure 10.9. Results of Memorized Report with a Financial Table

Results of Memorized Report with a Financial Table

Tables and Fields of the BillMax Reports Database

This section lists the type of tables and the associated fields in the BillMax Reports database. These may be used in generating custom reports. Note that these tables contain processed results from the BillMax database and the same values may not exist in the BillMax database.

Sales/Deferred Revenue Report

Tables that are created by running either the Sales report or the Deferred Revenue report begin with the string accrualsales. The following fields are available for each record in the table.

number

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

recurring_revenue_taxable

The taxable amount of a subscription Sale.

recurring_revenue_ntaxable

A non-taxable amount of a subscription Sale.

void_recurring_revenue_taxable

The Void of a taxable amount of a subscription Sale.

void_recurring_revenue_ntaxable

The Void of a non-taxable amount of a subscription Sale.

onetime_revenue_taxable

The taxable amount of a onetime Sale.

onetime_revenue_ntaxable

The non-taxable amount of a onetime Sale.

void_onetime_revenue_taxable

The Void of a taxable amount of a onetime Sale.

void_onetime_revenue_ntaxable

The Void of a non-taxable amount of a onetime Sale.

credit_recurring_revenue_taxable

The taxable amount of a subscription Store Credit.

credit_recurring_revenue_ntaxable

The non-taxable amount of a subscription Store Credit.

void_credit_recurring_revenue_taxable

The Void of the taxable amount of a subscription Store Credit.

void_credit_recurring_revenue_ntaxable

The Void of the non-taxable amount of a subscription Store Credit.

credit_onetime_revenue_taxable

The taxable amount of a onetime Store Credit.

credit_onetime_revenue_ntaxable

The non-taxable amount of a onetime Store Credit.

void_credit_onetime_revenue_taxable

The Void of the taxable amount of a onetime Store Credit.

void_credit_onetime_revenue_ntaxable

The Void of the non-taxable amount of a onetime Store Credit.

tax

The amount of tax assessed on Sales and Voids of Sales. This is only valid if the Sales report does not exclude deferred revenue. In other words, tax is not split up amongst months like a Sale may be.

credittax

The amount of tax assessed on Store Credits and Voids of Sales. This is only valid if the Sales report does not exclude deferred revenue. In other words, tax is not split up amongst months like a Sale may be.

account

The Account number (account.number) of the transaction.

payhist

The transaction number (payhist.number).

servdef

The Service Definition number (servdef.number) if the transaction is for a subscription.

wash

Whether or not the transaction is considered a Wash Transaction.

charge_type

The charge type (payhist.chargetype, chargetypes list) of the transaction.

Aging Revenue Report

Tables that are created by running either the Aging (Accounts Receivable) report string aging. The following fields are available for each record in the table.

number

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

account

The Account number (account.number).

state

The State of the Account.

cfname

account.cfname

clname

account.clname

company

account.company

balance

The overall balance of the Account.

current

The part of the balance that is not overdue.

overdue_1to30

The part of the balance that is overdue 1 to 30 days.

overdue_31to60

The part of the balance that is overdue 31 to 60 days.

overdue_61to90

The part of the balance that is overdue 61 to 90 days.

overdue_90plus

The part of the balance that is overdue 91+ days.

Invoice Aging Report

Tables that are created by running either the Aging (Accounts Receivable) report string aging. The following fields are available for each record in the table.

number

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

account

The Account number (account.number).

total

The total amount owed on a Sale, a Deposit Charge, or an underfunded Refund.

daysoverdue

The number of days the amount owed is overdue.

paidamt

The amount of the total that has been paid.

paidcash

The amount of the total that has been paid in cash.

paidcredit

The amount of the total that has been paid in Store Credit.

paidpurchase

If a Sale, the amount of the Sale paid.

paiddeposit

If a Deposit Charge, the amount of the Deposit Charge paid.

paidrefund

If a Refund, the amount of the Refund that is funded.


Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com