UsageRule

Version: 1.33

usageRule is optional in Gotransverse and exists for Products with usage of Product Type Service.

Through the Gotransverse API, UsageRules are queried through the BillingAccount. If the Product does NOT have usage, the Product will not have Usage Rules and the Billing Account will have no usage or Usage Rules.

Create your Usage Rules through Gotransverse's graphical user interface (GUI), and view and use them in either the GUI or the API. You cannot create Usage Rules through the API, only view and use them.

Use the following links to the GUI documentation for information to create and use the User-defined Customer fields.

  • Creating a Usage Rule

  • Creating a Usage Rule Using a Spreadsheet

Through the API, query UsageRules directly, as well as query and use through ServicePeriod.

Perform Through the GUI

  • CREATE the Usage Rule

  • View the list of Usage Rules available

  • Add a Usage Rule

Perform Through the API

  • Query for a list of Usage Rules

  • View the list of Usage Rules available

  • Add a Usage Rule

Further Gotransverse API information for this entity of Usage Rule:

  • Query a Usage Rule

    • Query Key Information

    • Query Key Parameters

    • Query to Use

    • REST Mount Point and Parameters

    • Parameters

Information for the related entity of UsageRules:

  • Entity UsageRules

Query a Usage Rule

Query Key Information

Querying to see Usage Rules needs to include one of the following parameters. If you do not know the value for the parameter, query separately to learn the value.

Usage Rule Parameters

UsageRule
Query Key Value Definition

eid

Long

The unique eid number of the Usage Rule.

servicePeriodEid

Long

The unique eid number of the ServicePeriod.

Query to Use

Query to Use
Query to Use Query for Parameter Name and Value Returns

SimpleDataQuery

UsageRule

<parameter name><parameter value>

List of your Usage Rules for that parameter and value.

REST Mount Point and Parameters

Query

  • GET https://my.tractbilling.com/t/s/r/1.33/usageRules/<eid>

  • GET https://my.tractbilling.com/t/s/r/1.33/usageRules?eid=<eid>

  • GET https://my.tractbilling.com/t/s/r/1.33/usageRules?servicePeriodEid=<servicePeriodEid>

Parameters Through the Billing Account

Each Product shown from the query shows information for a number of elements in the entity. The following table shows the elements, details of the elements, and brief descriptions.

Elements
Element Name Query
Key		 Element
Type		 Field
Length		 Description

queryScope

QueryScope

 - -

The depth of the query results, whether
they are SHALLOW or DEEP.
See QueryScope for details.

eid

Y

Long

System
Generated

System generated unique identity number assigned to all entities in Gotransverse.

limit

Decimal

As needed

The limit in the usage rule defines the maximum available allowance.
Example: if an add-on product includes 200 SMSs, then the limit is 200.

remaining

Decimal

As needed

The number of units remaining for this usage rule.
Example: If the original limit was 200 units and 27 units have been consumed,
the remaining is 175.

used

Decimal

As needed

The number of units consumed for this usage rule.
Example: If the original limit was 200 units and 27 units have been consumed,
the used is 27.

rollover

Decimal

As needed

The number of units that remain to be used for rollover.
This shows only a value if the product is defined so that the unused portions
of the limit can be used in the following service periods.
Example: If the original limit was 200 units and 150 units have been consumed
in the current month, the rollover is 50.

currentAllowance

Decimal

As needed

The current amount of available usage units.

serviceName

String

40

The name of the service (product) for which this usage rule is defined.
serviceName builds the relationship between the product and the service.

usageRuleName

String

40

The name of the Usage Rule.

Entity UsageRules

The entity UsageRules enables you to see multiple pages of the entity UsageRule.

UsageRule
Element Name Element Type Field Length Description

pageNumber

Integer

as needed

Shows the current page number.

pageSize

Integer

as needed

Shows the page size.

totalElements

Long

as needed

Shows the total number of items found.

elementCount

 

Integer

as needed

Shows the current count of the item
in the number of items that were found.

totalPages

Integer

as needed

Shows the total number of pages.

usageRule

UsageRule

 

Shows the list of UsageRules.