Adjustment
Version: 1.33
Parameters
Extends: TractObject
The Adjustment object represents credit and debit adjustments in Gotransverse. In the API, the different types of adjustments are represented by the adjustment items within the adjustment.
| Element | Type | Required? | Description |
|
billedInvoice |
Invoice |
|
The invoice this adjustment was applied to. |
|
billingAccount |
billingAccount |
Y |
The billing account this adjustment applies to. |
|
reason |
AdjustmentReason |
Y |
The reason for this adjustment. |
|
secondaryReason |
AdjustmentReason |
An additional reason for this adjustment. |
|
|
adjustmentApplications |
adjustmentApplications |
The history of this adjustment's applications (date, amount, type). |
|
|
adjustmentItems |
adjustmentItems |
The contents of this adjustment. |
| Attribute | Required? | Datatype | Description |
|
occurredOn |
Y |
daytime |
Defaults to current datetime. |
|
amount |
Y |
decimal |
The adjustment amount. |
|
description |
string |
What is this adjustment for? |
|
|
invoiced |
boolean |
Has this adjustment been applied to an invoice yet? Default is False. |
|
|
credit |
boolean |
Is this a credit or debit adjustment? True = Credit, False = Debit. Default is |
|
|
status |
AdjustmentStatus |
PENDING POSTED REVERSED |
|
|
type |
AdjustmentType |
MANUAL LATE_FEE TERMINATION_CHARGE INVOICE_ADJUSTMENT SERVICE ORDER_ITEM TRUE_UP_CHARGE |
|
|
postedOn |
dateTime |
Posting date for the adjustment. |
|
|
postedBy |
string |
User who posted the adjustment. |
|
|
manualInvoiceApplication |
boolean |
Apply this adjustment to an invoice manually? If False, the adjustment will be applied to the oldest open invoice. |
|
|
unappliedAmount |
decimal |
The portion of this adjustment that has not been applied to an invoice. |
|
|
creditNumber |
string |
System settings-defined number for this adjustment (if applicable). Increments by one for each credit issued. |
Querying Adjustment
For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.
| Key | Type |
|
eid |
Long |
|
billingAccountEid |
Long |
|
accountNum |
String |
|
status |
accounting.adjustment.AccountAdjustmentStatus |
|
invoiceEid |
Long |
|
invoiceNum |
String |
|
occurredOn |
Timestamp |
|
unappliedAmount |
BigDecimal |
|
creditNumber |
String |
|
credit |
Boolean |
REST Endpoints
|
Query adjustment |
GET |
https://my.tractbilling.com/t/s/r/1.33/[eid] |
|
Create adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid] |
|
Post an adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/post |
|
Edit adjusment* |
GET |
https://my.tractbilling.com/t/s/r/1.33/[eid] |
|
Remove adjustment* |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/remove |
|
Reverse adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/reverse |
|
Add an invoice application to the adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/addInvoiceApplication |
|
Reverse an invoice application from the adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/reverseInvoiceApplication |
|
Reverse a debit adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/reverseDebit |
|
Post an adjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/[eid]/post |
You may only edit/delete adjustments that have not been posted.
|
Create adjustment |
command |
addAdjustmentToBillingAccount |
|
Post an adjustment |
command |
postAdjustment |
|
Edit adjustment* |
update |
|
|
Remove adjustment* |
command |
removeAdjustment |
|
Reverse adjustment |
command |
reverseAdjustment |
|
Add an invoice application to the adjustment |
command |
addInvoiceApplicationToAdjustment |
|
Reverse an invoice application from the adjustment |
command |
reverseInvoiceApplicationFromAdjustment |
|
Reverse a debit adjustment |
command |
reverseDebitAdjustment |
Refer to the following topics for more information: