Is an adjustment

Element type: Required

Enpoints/models used: LineItem

Your integration must allow users to you can specify that a line item in a transaction is an adjustment to the original. Adjustments can include such as refunds, changing a customer’s bill, or writing off un-collectable accounts. This is done by specifying the adj field on a line item for an existing transaction (existing doc code).

There are two methods for specifying adjustments in transactions. Whether you set the adj flag to true or false depends on the method you use.

Method 1: Set the Adjustment flag (adj) to true on the appropriate LineItem(s)
- Send positive values for charge (chg), lines (line), minutes (min), and/or number of locations (loc).
- Set the adjustment method (adjm) to 0.
- Specify a discount type (disc).
Method 2: Set the Adjustment flag (adj) to false
- Send negative values for charge (chg), lines (line), minutes (min), and/or number of locations (loc).
- Set the adjustment method (adjm) to 0.
- Specify a discount type (disc).

View example:

 "itms": [
  {
    "ref": "Line Item 001 - Adjustment with Discount Type 0",
    "chg": 100,
    "line": 0,
    "sale": 1,
    "incl": false,
    "tran": 19,
    "serv": 6,
    "dbt": false,
    "adj": true,
    "adjm": 0,
    "disc": 0
  },
  {
    "ref": "Line Item 002 - Adjustment with Discount Type 1",
    "chg": 0,
    "line": 10,
    "sale": 1,
    "incl": false,
    "tran": 19,
    "serv": 21,
    "dbt": false,
    "adj": true,
    "disc": 1
  },
  {
    "ref": "Line Item 003 - Adjustment with Discount Type 5",
    "chg": 25,
    "line": 0,
    "sale": 1,
    "incl": false,
    "tran": 19,
    "serv": 37,
    "dbt": false,
    "adj": true,
    "adjm": 0,
    "disc": 5
  }
]