NegativeInvoiceAdjustmentApplication

Version: 1.33

negativeInvoiceAdjustmentApplication is an adjustment created by Gotransverse for negative invoices (Invoice amount is negative, invoice amount is less than zero, invoice amount < 0). When a negative invoice is created, the following conditions apply:

A Credit Adjustment of 0 amount in the currency of the BillingAccount is created
- The AdjustmentReason used is the "Negative Invoice Offset" reason as selected on the AdjustmentReason page.
- The Adjustment should NOT be marked for "manual apply" and so that the Credit Adjustment can be applied automatically.
An application of this Credit Adjustment for the amount of the invoice needs to be created against the invoice - so if the invoice was for $-50 the application would be for $-50. The application of the Credit Adjustment results in the following conditions:
- The balance owing on the invoice is now zero (0)
- An amount remains to apply on the credit adjustment of $50 which would be applied to any amount currently owing on the BillingAccount or to the next invoice created
- The negative application has a different chargeInfo type associated with it (CREDITNEGATIVE)
- The application to the negative invoice can not be reversed

This adjustment should be created as part of the bill cycle, right after the negative invoice has been created such as during the approve bill cycle process. It is only at the point where the invoice would be considered finalized and available for payments to be made, posting to GL and so forth.

negativeInvoiceAdjustmentApplication can be queried directly or as part of AdjustmentApplications.

Links to related Entities:

Refer to Adjustment to create any adjustment.
Refer to AddInvoiceApplicationToAdjustment to put a manual credit adjustment on an invoice.
Refer to ReverseInvoiceApplicationFromAdjustment to perform the command call of the reversing the credit adjustment (which results in ReversedInvoiceAdjustmentApplication).
Refer to StandardInvoiceAdjustmentApplication, which is a credit adjustment on an Invoice.
Refer to WriteOffAdjustmentApplication, which is a write off adjustment.

Further Gotransverse API information for this Entity of negativeInvoiceAdjustmentApplication:

Parameters

When you query AdjustmentApplications, the following table provides information about the values returned from the query for all the NegativeInvoiceAdjustmentApplications:

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 credit adjustment.
appliedOn	Y	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	Y	AdjustmentApplicationType	- -	Refer to AdjustmentApplicationType for choices.
invoice		Invoice	- -	The invoice affected by the credit adjustment.

Entity AdjustmentApplications

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

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 writeOffAdjustmentApplication	Either: StandardInvoiceAdjustmentApplication OR ReversedInvoiceAdjustmentApplication OR NegativeInvoiceAdjustmentApplication OR WriteOffAdjustmentApplication	- -	Shows the list of standardInvoiceAdjustmentApplication OR reversedInvoiceAdjustmentApplication OR negativeInvoiceAdjustmentApplication OR writeOffAdjustmentApplication

Entity NegativeInvoiceAdjustmentApplications

The entity NegativeInvoiceAdjustmentApplications enables you to see multiple pages of the entity NegativeInvoiceAdjustmentApplication.

Elements
Element Name	Element Type	FieldLength	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.
negativeInvoiceAdjustmentApplication	NegativeInvoiceAdjustmentApplication	- -	Shows the list of negativeInvoiceAdjustmentApplication.

Information for the related Entities of AdjustmentApplications and NegativeInvoiceAdjustmentApplications:

Entity AdjustmentApplications
Entity NegativeInvoiceAdjustmentApplications

Query for a Negative Invoice Adjustment Application

Query Negative Invoice Adjustment Applications as a group, or query for Adjustment Applications which includes all types of Adjustment Applications.

Query Key Information for SOAP and REST

Querying to see negativeInvoiceAdjustmentApplications or AdjustmentApplications needs to include one of the following parameters from the relevant table. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters - NegativeInvoiceAdjustmentApplication
Query Key	Value	Definition
eid	Long	The unique eid number for the NegativeInvoiceAdjustmentApplication.
adjustmentEid	Long	The unique eid number for the Adjustment.
billingAccountEid	Long	The unique eid number of the BillingAccount.
accountNum	String	The assigned BillingAccount number.
invoiceEid	Long	The unique eid number of the Invoice.
invoiceNum	String	The assigned Invoice number.
occurredOn	DateTime	The date and time of the Negative Invoice Adjustment.
unappliedAmount	BigDec	The amount (if any) of funds on the Billing Account, which is unapplied.

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.
billingAccountEid	Long	The unique eid number of the BillingAccount.
accountNum	String	The assigned BillingAccount number.
occurredOn	DateTime	The date and time of the Adjustment
unappliedAmount	BigDec	The amount (if any) of funds on the Billing Account, which is unapplied.
type	- -	The type of AdjustmentApplication. Refer to AdjustmentApplicationType for choices.

Query to Use

Query
Query	Query For	Parameter Name & Value	Returns
SimpleDataQuery	NegativeInvoiceAdjustmentApplication	<parameter name><parameter value>	List of your Negative 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 Points and Parameters

Use either the mount point for negativeInvoiceAdjustmentApplications or AdjustmentApplications.

Query

GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?adjustmentEid=<adjustmentEid>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?billingAccountEid=<billingAccountEid>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?accountNum=<accountNum>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?invoiceEid=<invoiceEid>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?invoiceNum=<invoiceNum>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?occurredOn=<occurredOn>
GET https://my.tractbilling.com/t/s/r/1.33/negativeInvoiceAdjustmentApplications?unappliedAmount=<unappliedAmount>

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>
GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?billingAccountEid=<billingAccountEid>
GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?accountNum=<accountNum>
GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?occurredOn=<occurredOn>
GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?unappliedAmount=<unappliedAmount>
GET https://my.tractbilling.com/t/s/r/1.33/adjustmentApplications?type=<type>

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>