AdjustmentReason

Version: 1.33

The adjustmentReason is required when using the Entity Adjustment and can be queried to have it to use when creating the Adjustment.

Create your Adjustment Reasons through Gotransverse and view and use them in either the GUI or through the API.

You cannot create Adjustment Reasons through the API; you can only view and use them.

Perform Through the GUI

• CREATE the Adjustment Reason.

• View the list of Adjustment Reasons available.

Perform Through the API

• Query for a list of Adjustment Reasons.

• View the list of Adjustment Reasons available.

• Use an Adjustment Reason when creating the Adjustment.

Parameters

Each Adjustment Reason 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	- -	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 Reason.
description		String	255	A description of the Adjustment Reason.
status		AdjustmentReasonStatus	- -	The status of the Adjustment Reason; whether or not you can use it. Refer to AdjustmentReasonStatus for choices.
creditOnly	Y	Boolean	Select either: "true" (Yes) or "false" (No)	Is the adjustmentReason for Credit only? Yes, the adjustmentReason IS for credit only. No, the adjustmentReason is NOT for credit only (it can be for a debit).

Entity AdjustmentReasons

The entity AdjustmentReasons enables you to see multiple pages of the entity AdjustmentReason.

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.
adjustmentReason	AdjustmentReason	- -	Shows the list ofadjustmentReasons.

Information for the related Entity of Reasons:

• Adjustment Reasons

Query for an Adjustment Reason

Query Key Information for SOAP and REST

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

Query

Query to Use	Query for	Returns
SimpleDataQuery	AdjustmentReason	List of all of your Adjustment Reasons

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

Query Keys for Adjustment Reason

Query Key	Value	Definition
eid	Long	The eid number of the Adjustment Reason.
name	String	The name of the Adjustment Reason.
creditOnly	Boolean	Is the adjustment a credit (yes, true)?

Unknown Query Key Information

If you do not know the Adjustment Reason's eid or name:

Query to Use	Query for	Returns
SimpleDataQuery	AdjustmentReason	List of all of your Adjustment Reasons.

SOAP Example Query and Response

The following SOAP example is a query of AdjustmentReason:

<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>AdjustmentReason</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope> 

This was the response:

<?xml version="1.0" ?>
<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">
                <adjustmentReasons elementCount="2" pageNumber="1" pageSize="50" totalElements="2" totalPages="1">
                    <adjustmentReason creditOnly="true" description="Default Credit Adjustment Reason" eid="19" name="Default Credit Adjustment Reason" status="Active"/>
                    <adjustmentReason creditOnly="false" description="Default Debit Adjustment Reason" eid="1041" name="Default Debit Adjustment Reason" status="Active"/>
                </adjustmentReasons>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Endpoint

Query

• GET https://my.tractbilling.com/t/s/r/1.33/adjustmentReasons

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

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

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

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

REST Example Endpoint and Response

The following example is a REST query:

• GET https://my.tractbilling.com/t/s/r/1.33/adjustmentReasons

This was the response (line breaks and formatting added for ease of reading):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<adjustmentReasons xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
    <ns2:adjustmentReason name="Default Credit Adjustment Reason" 
description="Default Credit Adjustment Reason" status="Active" creditOnly="true" eid="98"/>
    <ns2:adjustmentReason name="Default Debit Adjustment Reason" 
description="Default Debit Adjustment Reason" status="Active" creditOnly="false" eid="227"/>
</adjustmentReasons>