Search

Gotransverse features simple and complex search querying to help you quickly filter and find your desired Customers, billing accounts, orders, services, invoices, and payments. You can search by object like Customer name or number, email address, account record. Likewise, Gotransverse contains a mini search bar at the top of the page for quick access to different billing accounts from anywhere within the Customer Billing application.

Using Search

Customers, accounts, orders, services, invoices, and payments pages contain a search bar for searching within their respective section. Data field names and advanced searches can be leveraged for more accurate results.

To search for desired items, enter a search word or phrase in the Search bar, then click the magnifying glass icon or press Enter.

Once you click the Search bar, the drop-down menu with several search results displays:

  • Suggested results: start typing a search word or phrase and the most suitable results display in the menu.
  • Recent Queries: view and select from your recent search queries.
  • Recently Viewed: view and select from the entries that you have recently viewed.
  • Quick Search: view and select the search options that you may want to apply. The Quick Search menu differs depending on the page where you perform your search.

Searching for Recent Items

In the Search drop-down menu, you find a set of options available for searching by Recent.

What follows is an example where we retrieve recently created orders. The search for other sections or types of Recent queries works in the same way.

  1. From the Quick Search menu, select Recently Created Orders.
  2. In the Search bar, the following query displays: created_date:>now-10d. It means that the search will display orders created for the last 10 days, which is the default value.
  3. Replace 10 with the desired number of days and click the magnifying glass icon or press Enter.

Basic and Advanced Search

There are two types of searches:

  • Basic Search looks for your search string in billing account and Customer fields. If your search string is found anywhere in those fields, then that account record is returned in the results. This type of search can return many records.
  • Advanced Search looks for your search string in only one specified billing account field and can therefore return more specific results.

If a search returns only one billing account record, the billing account opens to its Account page. No search criteria entered will pull up all records.

Performing a Basic Search

A Basic Search looks for your search string in the following billing account fields at once:

  • Customer Name
  • Account Number
  • Email (searches primary and secondary email addresses)
  • External Account ID

If your search string is found anywhere in those account fields, that billing account is returned in the results.

A basic search using the Customers tab looks for your search string in the following Customer fields at once:

  • Customer Name
  • Customer Number
  • Email (searches primary and secondary email addresses)
  • External Customer Number

If your search string is found anywhere in those Customer fields, that Customer is returned in the results.

Performing an Advanced Search

An advanced search consists of terms and operators. There are two types of terms:

  • Single terms such as a single word—Jones
  • Phrases such as a group of words surrounded by quotation marks—"David Jones"
Using Operators

Multiple terms can be combined together with Boolean operators to form a more complex query. Examples of operators are: AND, OR, and NOT.

Note: Operators must be ALL CAPITAL.

Operator Description
AND The AND operator matches records where both terms exist anywhere in the searchable fields: Customer Name, Customer Number, Billing Account Number, Primary Email, and External Account ID. For example, "David" AND "Jones" would find records in which both names David and Jones exist in the searchable fields.
OR The OR operator is the default conjunction operator. This means that if there is no operator between two terms, the OR operator is used. The OR operator links two terms and finds a matching document if either of the terms exist in a record's searchable fields. For example, "David" OR "Jones" would find all records in which David or Jones exists in the searchable fields. It would also find Don Jones and David Johnson.
NOT The NOT operator excludes records that contain the term after NOT. For example, "Jones" NOT "David" would find records that include Jones but not David.

Searching by Dates

Gotransverse provides a way to retrieve available Customers, accounts, orders, services, invoices, and payments by their associated dates. For example, the date when the entity was created. The search engine supports the following date formats:

  • mm/dd/yyyy – For example, 07/31/2019
  • yyyy-mm-dd – For example, 2019-07-31
  • yyyy-mm-dd hh:mm:ss – For example, 2019-07-31 04:35:05

Note: For more information about available search queries, refer to the sections below.

Searching for Customers and Accounts

You can perform an advanced search on Customers or accounts, depending on whether you are on the Customers search tab or the Accounts search tab, by entering key-value pairs that stand for the Customer or account details and desired values.

Several parameters can be combined in a single search query, for example:

Under the Accounts search tab:

  • customer_name: "Sample User" AND status: Active AND dunning_enabled: true
  • bill_cycle_name: “monthy_BC” OR “yearly_BC“
  • account_start_time: 01/01/2019 OR email: “customer@company.com”
  • auto_pay_enabled: true AND tax_exempt: true AND account_category: "All Accounts"

Under the Customers search tab:

  • customer_name: "Acme Brick" AND status: Active
  • customer_number: “7” AND “Suspended“

You can perform searches for the following columns below in the Accounts table through the Accounts tab on the Customers Search page. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

You can perform searches for the following columns below in the Customers table through the Customers tab on the Customers Search page. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

Searching for Orders

You can perform an advanced search on orders by entering key-value pairs which stand for the order details and desired values.

Several parameters can be combined in a single search query, for example:

  • order_type: "Sales Order" AND status: Completed
  • amount: 100 OR 50 AND order_date: "01/01/2019"
  • account_num: "Customer05" OR currency_type: USD

You can perform search using all available columns in the Orders table. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

Searching for Services

You can perform an advanced search on services by entering key-value pairs which stand for the service details and desired values.

Several parameters can be combined in a single search query, for example:

  • account_num: 133 AND status: Active
  • name: "product 1" AND currency_type: USD OR JPY
  • amount: 100 AND quantity: 1
  • name: “product 1” OR “product 2” AND type: subscription AND account_name: "Sample User"

You can perform search using all available columns in the Services table. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

Searching for Invoices

You can perform an advanced search on invoices by entering key-value pairs which stand for the invoice details and desired values.

Several parameters can be combined in a single search query, for example:

  • account_name: "Customer #1" AND amount: 100
  • balance: 100 AND invoice_status: Open AND invoice_type: Standard
  • invoice_date: "01/01/2019" AND currency_type: USD AND status: Processing
  • due_date: "01/01/2020" AND distribution_status: "DISTRIBUTION_NONE"

You can perform search using all available columns in the Invoices table. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

Searching for Payments

You can perform an advanced search on payments by entering key-value pairs which stand for the payment details and desired values.

Several parameters can be combined in a single search query, for example:

  • account_name: "Account_03” AND payment_method_type: "Wire Transfer"
  • payment_date: "01/01/2010" AND currency_type: "USD" AND status: "CANCELLED"
  • account_num: "B2" OR "B3" AND cancel_amount: 100

You can perform search using all available columns in the Payments. A list of available queries and how they are exposed in the GTV UI 2.0 can be found below.

Searching for a Usage Event

You can perform a search for a specific usage event using the Usage Event ID or by combining the Reference ID and Sequence ID. You must use exact values in the search fields and will receive one search result when the search matches a usage event. Once you have successfully searched for the event, you can view the details by selecting the down arrow to the left of the search result or copy the usage event by selecting the copy icon under the Actions column.

Note: You cannot perform a wildcard search or search for a range of usage events. The search values must be an exact match to an existing usage event to get a successful result.

To search for a usage event, follow one of the two search methods below:

  • Usage Event ID—Enter the exact Usage Event ID of the usage event you want to find. Every usage event has an ID that is generated by GTV once the event is successfully rated. The Usage Event ID may also be called the Usage Activity Event or Activity Event.
  • Reference ID and Sequence ID—Enter both the exact Reference ID and Sequence ID of the usage event you want to find. You cannot search using only one of these fields. The Reference ID and Sequence ID are created by the client when importing or creating usage events for rating. If the Reference ID and Sequence ID fields are typically empty, you will want to search by the Usage Event ID.