AdjustmentCategory

Version: 1.33

The AdjustmentCategory is the Charge Category used in Agreement for agreement termination fees.

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

You cannot create Adjustment Categories through the API. You can only view and use them. Basic use case:

• Query for a list of Adjustment Categories.

• View the list of Adjustment Categories available.

• Use an Adjustment Category when creating an Adjustment.

Parameters

Parameters

Element Name	Query Key	Element Type	Field Length	Description
queryScope		QueryScope	- -	Whether default query results are overridden by QueryScope resulting in SHALLOW or DEEP query results.
eid	Y	Long	System Generated	System generated unique identity number assigned to all entities in Gotransverse.
name	Y	String	255	The name of the Adjustment Category.
description		String	255	A description of the Adjustment Category.
priority		Long	as needed	The priority of the Adjustment Category and which other Adjustments are done before or after this one.
status		PriceCategoryStatus	255	The PriceCategoryStatus is ACTIVE, SUSPENDED, or CANCELED.

Querying Adjustment Category

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

Query

Query to Use	Query for	Returns
SimpleDataQuery	AdjustmentCategory	List of all of your Adjustment Categories.

To retrieve paged results, use AdjustmentCategories.

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

Adjustment Category

Query Key	Value	Definition
eid	Long	The eid number of the Adjustment Category.
name	String	The name of the Adjustment Category.
status		The status of the Adjustment Category.

Unknown Query Key Information

If you do not know the Adjustment Category's eid or name.

Query

Query to Use	Query for	Returns
SimpleDataQuery	AdjustmentCategory	List of all of your Adjustment Categories.

REST Endpoints

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

SOAP

SOAP Example Query and Response

The following SOAP example is a query of AdjustmentCategory:

<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>AdjustmentCategory</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="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <adjustmentCategories pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
                    <adjustmentCategories name="Default" 
    description="Default Price Category" priority="5" status="ACTIVE" eid="5384"/>
                    <adjustmentCategories name="Subscription Charges" 
    priority="6" status="ACTIVE" eid="5385"/>
                </adjustmentCategories>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>