WriteOffAdjustmentApplication

Version: 1.33

writeOffAdjustmentApplication is an optional Entity and is used to "write off" (reduce through accounting process) all or part of a debt or amount owed on a BillingAccount or Invoice.

Query writeOffAdjustmentApplication directly, or as an AdjustmentApplication.

Links to related Entities:

  • See Adjustment to create any adjustment.

  • See AddInvoiceApplicationToAdjustment to put a manual credit adjustment on an invoice.

  • See NegativeInvoiceAdjustmentApplication, which is an adjustment created for negative Invoices.

  • See ReverseInvoiceApplicationFromAdjustment to perform the command call of the reversing the credit adjustment (which results in reversedInvoiceAdjustmentApplication).

  • See WriteOffAdjustmentApplication, which is a write off adjustment.

Parameters

When you query AdjustmentApplications, the following table provides information about the values returned from the query for all the StandardInvoiceAdjustmentApplications (the ReversedInvoiceAdjustmentApplication show slightly different information):

Parameters
Element Name Query Key Element Type Field Length Description

queryScope

 

QueryScope

- -

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

eid

Y

Long

System Generated

System generated unique identity number assigned to the AdjustmentApplication.

accountAdjustment

 

Adjustment

- -

The original adjustment.

appliedOn

 

dateTime

Refer to Data Types for dateTime formats.

The date and time at which the Adjustment was applied to the Invoice.

amount

 

Decimal

As needed

The amount of the Adjustment.

type

 

AdjustmentApplicationType

- -

Refer to AdjustmentApplicationType for choices.

Entity AdjustmentApplications

The entity AdjustmentApplications enables you to see multiple pages of the entity WriteOffAdjustmentApplication (as well as the other types).

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.

Select one:

standardInvoiceAdjustmentApplication

reversedInvoiceAdjustmentApplication

negativeInvoiceAdjustmentApplication

writeOffAdjustmentApplicatio

Either:

StandardInvoiceAdjustmentApplication OR

ReversedInvoiceAdjustmentApplication OR

NegativeInvoiceAdjustmentApplication OR

WriteOffAdjustmentApplication

- -

Shows the list of

standardInvoiceAdjustmentApplication OR

reversedInvoiceAdjustmentApplication OR

negativeInvoiceAdjustmentApplication OR

writeOffAdjustmentApplication

Information for the related Entity of AdjustmentApplications:

  • Entity AdjustmentApplications

Query for a Write Off Adjustment Application

Write Off Adjustment Applications can be queried as a group as well as in Adjustment Applications, which include Write Off Adjustment Applications.

Query Key Information for SOAP and REST

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

Query Key Parameters

Query Key Parameters - AdjustmentApplication
Query Key Value Definition

eid

Long

The unique eid number for the AdjustmentApplication.

adjustmentEid

Long

The unique eid number for the Adjustment.

Or use the following table:

Query Key Parameters - WriteOffAdjustmentApplication
Query Key Value Definition

eid

Long

The unique eid number for the WriteOffAdjustmentApplication.

adjustmentEid

Long

The unique eid number for the Adjustment.

invoiceEid

Long

The unique eid number for the Invoice.

invoiceNum

String

The unique number that is the Invoice Number.

Query to Use

Query
Query Query For Parameter Name and Value Returns

SimpleDataQuery

ReversedInvoiceAdjustmentApplication

<parameter name><parameter value>

List of your Reversed Invoice Adjustment Applications for that parameter name and value.

SimpleDataQuery

AdjustmentApplication

<parameter name><parameter value>

List of your Adjustment Applications for that parameter name and value.

SOAP Example Query and Response

In the following example SOAP query, the parameter of the AccountNum (in this example "2") was used.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"   
xmlns:ser="http://www.tractbilling.com/billing/1_31/service"   
">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:query>
         <ser:queryRequest>
	         <dom:simpleDataQuery>
	             <dom:type>AdjustmentApplication</dom:type>
	             <dom:whereClause clause="accountNum eq '2'"/>
	         </dom:simpleDataQuery>
         </ser:queryRequest>
      </ser:query>
   </soapenv:Body>
</soapenv: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">
                <adjustmentApplications pageNumber="1" pageSize="50" totalElements="6" elementCount="6" totalPages="1">
                    <standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:37:22.000-06:00" amount="29.99" type="INVOICE" eid="6" queryScope="SHALLOW">
                        <accountAdjustment eid="9" queryScope="EID"/>
                        <invoice eid="5" queryScope="EID"/>
                    </standardInvoiceAdjustmentApplication>
                    <standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:38:02.000-06:00" amount="20.00" type="INVOICE" eid="7" queryScope="SHALLOW">
                        <accountAdjustment eid="8" queryScope="EID"/>
                        <invoice eid="6" queryScope="EID"/>
                    </standardInvoiceAdjustmentApplication>
                    <standardInvoiceAdjustmentApplication reversed="true" appliedOn="2015-01-19T15:39:16.000-06:00" amount="9.98" type="INVOICE" eid="8" queryScope="SHALLOW">
                        <accountAdjustment eid="8" queryScope="EID"/>
                        <invoice eid="5" queryScope="EID"/>
                    </standardInvoiceAdjustmentApplication>
                    <reversedInvoiceAdjustmentApplication appliedOn="2015-01-19T15:39:27.000-06:00" amount="-9.98" type="REVERSED" eid="9" queryScope="SHALLOW">
                        <accountAdjustment eid="8" queryScope="EID"/>
                        <invoice eid="5" queryScope="EID"/>
                        <reversedApplication reversed="true" appliedOn="2015-01-19T15:39:16.000-06:00" amount="9.98" type="INVOICE" eid="8" queryScope="SHALLOW">
                            <accountAdjustment eid="8" queryScope="EID"/>
                            <invoice eid="5" queryScope="EID"/>
                        </reversedApplication>
                    </reversedInvoiceAdjustmentApplication>
                    <standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:57:46.000-06:00" amount="29.99" type="INVOICE" eid="10" queryScope="SHALLOW">
                        <accountAdjustment eid="11" queryScope="EID"/>
                        <invoice eid="8" queryScope="EID"/>
                    </standardInvoiceAdjustmentApplication>
                    <standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T16:02:34.000-06:00" amount="29.99" type="INVOICE" eid="11" queryScope="SHALLOW">
                        <accountAdjustment eid="11" queryScope="EID"/>
                        <invoice eid="9" queryScope="EID"/>
                    </standardInvoiceAdjustmentApplication>
                </adjustmentApplications>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query

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

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

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

REST Example Query and Response

In the following example REST query, the parameter of the AccountNum (in this example "2") was used.

Query

  • GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?accountNum=2

This was the response:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns2:adjustmentApplications xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain/rest" xmlns:ns3="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="6" elementCount="6" totalPages="1">
    <ns3:standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:37:22.000-06:00" amount="29.99" type="INVOICE" eid="6" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="9" queryScope="EID"/>
        <ns3:invoice eid="5" queryScope="EID"/>
    </ns3:standardInvoiceAdjustmentApplication>
    <ns3:standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:38:02.000-06:00" amount="20.00" type="INVOICE" eid="7" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="8" queryScope="EID"/>
        <ns3:invoice eid="6" queryScope="EID"/>
    </ns3:standardInvoiceAdjustmentApplication>
    <ns3:standardInvoiceAdjustmentApplication reversed="true" appliedOn="2015-01-19T15:39:16.000-06:00" amount="9.98" type="INVOICE" eid="8" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="8" queryScope="EID"/>
        <ns3:invoice eid="5" queryScope="EID"/>
    </ns3:standardInvoiceAdjustmentApplication>
    <ns3:reversedInvoiceAdjustmentApplication appliedOn="2015-01-19T15:39:27.000-06:00" amount="-9.98" type="REVERSED" eid="9" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="8" queryScope="EID"/>
        <ns3:invoice eid="5" queryScope="EID"/>
        <ns3:reversedApplication reversed="true" appliedOn="2015-01-19T15:39:16.000-06:00" amount="9.98" type="INVOICE" eid="8" queryScope="SHALLOW">
            <ns3:accountAdjustment eid="8" queryScope="EID"/>
            <ns3:invoice eid="5" queryScope="EID"/>
        </ns3:reversedApplication>
    </ns3:reversedInvoiceAdjustmentApplication>
    <ns3:standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T15:57:46.000-06:00" amount="29.99" type="INVOICE" eid="10" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="11" queryScope="EID"/>
        <ns3:invoice eid="8" queryScope="EID"/>
    </ns3:standardInvoiceAdjustmentApplication>
    <ns3:standardInvoiceAdjustmentApplication reversed="false" appliedOn="2015-01-19T16:02:34.000-06:00" amount="29.99" type="INVOICE" eid="11" queryScope="SHALLOW">
        <ns3:accountAdjustment eid="11" queryScope="EID"/>
        <ns3:invoice eid="9" queryScope="EID"/>
    </ns3:standardInvoiceAdjustmentApplication>
</ns2:adjustmentApplications>