On the Prepayments tab in the Data Explorer, you can use the Query Builder to configure and perform queries against the Prepayments/Commitments data for your Organization in m3ter. The Query Builder is designed to let you quickly set up and submit a query that returns precisely the right data set to serve your current analytical purposes. You can then review the data in either a Summaries or a Data Table format.
This topic explains how to work successfully in the Data Explorer to configure and perform queries against your Prepayments data and review returned data.
Tip: Prepayments on Accounts? For more details on Prepayments and creating them for an Account, see Creating Prepayments for Accounts.
To submit queries for Prepayments data and review returned data:
1. Select Analytics>Data Explorer. The Data Explorer opens with the Usage tab selected.
2. Select the Prepayments tab. You can build the specific query you want to perform against Prepayments data collected for your Organization.
3. In the Select period section, define a period for returning Prepayments data:
Time period. Use the drop-down list to select a period. If a Prepayment has a start date that falls in the period, then its data will be returned for the query.
Today is the default.
You can select from a range of other predefined periods, such as Last whole week or Last 30 days.
If you want to define a specific period, you can use Custom:
Start date and End date. If you select Custom for the query Time period, these date/time fields will be enabled. You can use calendar popups to define the start and end dates/times for a custom period.
4. In the Apply an account filter section, select the Accounts you want to the query to return Prepayments data for:
All Accounts. Data will be returned for all Accounts for which Prepayments have been created.
Selected Accounts. Use the drop-down to select the Account Codes you want to return Prepayments data for.
In this example we have:
Selected a single Account to return Prepayments data for.
Defined a Custom time period of two months. The Organization Timezone is set to UTC.
5. Select Perform Query. The query executes and the resultant data is loaded into the Summaries panel and Data Table.
Important: Response too Large Error! If the response payload for your query is >10MB, this exceeds our limit and you'll receive an error message to inform you. You can either use the available filters to further limit the query result set and re-run your query or use the Export button to download the current results in a
.csv formatted file - see Exporting Query Results.
You can review the Prepayments data returned for your query in a Summaries table:
You can review the Prepayments data returned for your query in a data Table:
In Prepayments - Table:
Tip: End Date Different in Results Data? In this example, the End date shown for the returned data, both in the Prepayments - Summaries panel and in the Prepayments - Table, is not the same as the End date set for the query. This is because a Prepayment spans an entire contract period, and is not simply a minimum spend amount to be charged on a bill-by-bill basis. In this example, the End date shows as the end date of the Prepayment contract period, which in this case is April 1st 2022. Similarly, if we had set the query end date after April 1st 2022, then the End date shown for the loaded results data would have defaulted to April 1st 2022.
Tip: Exporting Prepayments Data? You can use the Export button to create a
.csv file of your returned Prepayments data. See Exporting Query Results for more details.
You can scroll down in the Prepayments tab to review a Billing panel with details of the Bills raised against the selected Account for the Prepayment.
Tip: Saving Prepayments Queries? You can save, update already saved, and re-use saved Prepayments queries. You can also load pre-configured Standard Queries directly into the Query Builder. See Saving, Updating, and Re-Using Queries.