UsagePriceCategory

Version: 1.33

The usagePriceCategory is the Charge Category you use through OrderItemUsageRule, ProductUsageRule, ServiceUsageRule.

Create your Usage Price Categories through Gotransverse's graphical user interface (GUI), and view and use them in either the GUI or through the API.

Query usagePriceCategory directly and also query and use through OrderItemUsageRule, ProductUsageRule, ServiceUsageRule.

You cannot create Usage Price Categories through the API, only view and use them.

Perform Through the GUI

  • CREATE the Usage Price Category

  • View the list of Usage Price Categories and other Charge Categories available

  • Use a Usage Price Category

Perform Through the API

  • Query for a list of Usage Price Categories

  • View the list of Usage Price Categories available

  • Use a Usage Price Category when using OrderItemUsageRule, ProductUsageRule, or ServiceUsageRule

This page provides the following Gotransverse API information for this entity of UsagePriceCategory:

Parameters

Each UsagePriceCategory 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.

name

Y

 

String

255

The name of the Usage Price Category.

description

String

255

A description of the Usage Price Category.

priority

Long

as
needed

The priority of the Usage Price Category,
and which other Charges are done
before or after this one.

status

PriceCategoryStatus

255

The PriceCategoryStatus is ACTIVE,
SUSPENDED, or CANCELED.

Entity UsagePriceCategories

The entity UsagePriceCategories enables you to see multiple pages of the entity usagePriceCategory.

Elements
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.

usagePriceCategory

UsagePriceCategory

 - -

Shows the list of usagePriceCategories.

Information for the related entity of UsagePriceCategories:

  • Usage Price Categories

Query for a Usage Price Category

Query Key Information for SOAP and REST

To query for all Usage Price Categories, use the SimpleDataQuery with no parameters.

Query For All Usage Price Categories
Query to Use Query for Returns

SimpleDataQuery

UsagePriceCategory

List of all of your Usage Price Categories.

To query for more specific information, use the SimpleDataQuery with the parameter of one of the following Query Keys:

UsagePriceCategory
Query Key Value Definition

eid

Long

The eid number of the Usage Price Category.

name

String

The name of the Usage Price Category.

Do Not Know Query Key Information

If you do not know the Usage Price Category's eid or name:

Query to Use Query for Returns

SimpleDataQuery

Usage Price Category

List of all of your Usage Price Categories.

SOAP Example Query and Response

The following SOAP example is a query of UsagePriceCategory:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain"xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>UsagePriceCategory</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <usagePriceCategories elementCount="1" pageNumber="1" pageSize="50"totalElements="1" totalPages="1" xmlns="http://www.tractbilling.com/billing/1_31/domain">
                    <usagePriceCategory description="Usage Price Category for item"eid="375" name="item Usage Price Category" priority="4" status="ACTIVE"/>
                </usagePriceCategories>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Endpoint

Query
GET https://my.tractbilling.com/t/s/r/1.33/usagePriceCategories
GET https://my.tractbilling.com/t/s/r/1.33/usagePriceCategories/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/usagePriceCategories?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/usagePriceCategories?name=<name>