Avalara Developer Network Developer communications

Chapter 4.3.9 - Private Line

The Private Line (plsp) key provides you with the ability to obtain taxes for a private line transaction. Simply provide a percentage in the form of a decimal to indicate the percentage which applies to the origination (from) point. Any remaining charges are then applied to the termination (to) point.

For example:

  • A transaction has two points: Point 'A' and Point 'Z'
  • A plsp of 0.25 means 25% of the taxes are attributed to Point 'A', the remaining 75% to Point 'Z'

Note

Private Line functionality is not supported on a Tax Inclusive (incl set to true) line item. The following exception is thrown in the event that a plsp is greater than 0 while incl is set to true. To resolve, set plsp to 0 or incl to false.

{
  "inv": [
    {
      "itms": [
        {
          "err": [
            {
              "code": -1000,
              "msg": "Exception: The IsPrivateLine parameter is not supported for CalculateTaxInclusiveTaxes."
            }
          ]
        }
      ]
    }
  ]
}

Private Line Example

Point ‘A’ is Louisville, KY while Point ‘Z’ is Irving, TX. A 50% Private Line split (plsp) is set, meaning that 50% of the transaction is applied to Point ‘A’ and the remaining 50% to Point ‘Z’.

{
  "cmpn": {
    "bscl": 0,
    "svcl": 0,
    "fclt": false,
    "frch": false,
    "reg": false
  },
  "inv": [
    {
      "doc": "INV1237A-56999",
      "cmmt": false,
      "bill": {
        "ctry": "USA",
        "int": true
      },
      "cust": 0,
      "lfln": false,
      "date": "2018-05-01T12:00:00Z",
      "itms": [
        {
          "ref": "PrivateLineTest",
          "from": {
            "ctry": "USA",
            "city": "Louisville",
            "st": "KY",
            "zip": "40201"
          },
          "to": {
            "ctry": "USA",
            "city": "Irving",
            "st": "TX",
            "zip": "75038"
          },
          "chg": 1000,
          "sale": 1,
          "plsp": 0.50,
          "tran": 1,
          "serv": 4
        }
      ],
      "invm": false,
      "dtl": true,
      "summ": false
    }
  ]
}

Response

Taxes for both Point ‘A’ and Point ‘B’ are returned.

View the Response JSON
{
  "inv": [
    {
      "doc": "INV1237A-56999",
      "itms": [
        {
          "ref": "PrivateLineTest",
          "txs": [
            {
              "bill": true,
              "cmpl": true,
              "tm": 593.51,
              "calc": 1,
              "cat": "SALES AND USE TAXES",
              "cid": 1,
              "name": "Sales Tax",
              "exm": 0,
              "lns": 0,
              "min": 0,
              "pcd": 3727200,
              "rate": 0.0625,
              "sur": false,
              "tax": 37.094375,
              "lvl": 1,
              "tid": 1
            },
            {
              "bill": true,
              "cmpl": true,
              "tm": 1000,
              "calc": 1,
              "cat": "CONNECTIVITY CHARGES",
              "cid": 5,
              "name": "Fed Universal Service Fund",
              "exm": 0,
              "lns": 0,
              "min": 0,
              "pcd": 0,
              "rate": 0.184,
              "sur": false,
              "tax": 184,
              "lvl": 0,
              "tid": 18
            },
            {
              "bill": true,
              "cmpl": true,
              "tm": 1000,
              "calc": 1,
              "cat": "REGULATORY CHARGES",
              "cid": 6,
              "name": "FCC Regulatory Fee (Wireline)",
              "exm": 0,
              "lns": 0,
              "min": 0,
              "pcd": 0,
              "rate": 0.00302,
              "sur": false,
              "tax": 3.02,
              "lvl": 0,
              "tid": 169
            },
            {
              "bill": true,
              "cmpl": true,
              "tm": 593.51,
              "calc": 1,
              "cat": "GROSS RECEIPTS TAXES",
              "cid": 3,
              "name": "Statutory Gross Receipts",
              "exm": 0,
              "lns": 0,
              "min": 0,
              "pcd": 1365200,
              "rate": 0.013,
              "sur": false,
              "tax": 7.71563,
              "lvl": 1,
              "tid": 14
            },
            {
              "bill": true,
              "cmpl": true,
              "tm": 593.51,
              "calc": 1,
              "cat": "SALES AND USE TAXES",
              "cid": 1,
              "name": "Sales Tax",
              "exm": 0,
              "lns": 0,
              "min": 0,
              "pcd": 1365400,
              "rate": 0.06,
              "sur": false,
              "tax": 35.6106,
              "lvl": 1,
              "tid": 1
            }
          ]
        }
      ]
    }
  ]
}