Chapter 4.3.2 - Multi-line Request

An invoice can contain many line items.

Note

Multiple invoices (with multiple line items) can be added to a transaction. This page demonstrates multiple line items only.

Note

Limits per request:

Simple Multi-line Invoice Example

This invoice contains 3 simple line items.

{
"cmpn": {
"bscl": 0,
"svcl": 0,
"fclt": false,
"frch": false,
"reg": false
},
"inv": [
{
"doc": "TEST-VOIP INVOICE 2017.12.26:12.02 AVA",
"cmmt": false,
"bill": {
"cnty": "San Francisco",
"ctry": "USA",
"int": true,
"geo": false,
"city": "San Francisco",
"st": "CA",
"zip": "94102"
},
"cust": 0,
"lfln": false,
"date": "2017-05-01T12:00:00Z",
"itms": [
{
"ref": "Line Item 001 - VoIP/Access Charge",
"chg": 100,
"line": 0,
"sale": 1,
"incl": false,
"tran": 19,
"serv": 6,
"dbt": false,
"adj": false
},
{
"ref": "Line Item 002 - VoIP/Lines",
"chg": 0,
"line": 10,
"sale": 1,
"incl": false,
"tran": 19,
"serv": 21,
"dbt": false,
"adj": false
},
{
"ref": "Line Item 003 - VoIP/Equip Rental",
"chg": 25,
"line": 0,
"sale": 1,
"incl": false,
"tran": 19,
"serv": 37,
"dbt": false,
"adj": false
}
],
"invm": true,
"dtl": true,
"summ": true,
"opt": [
{
"key": "1",
"val": "VoIP Sample Line Items Invoice ABC-ZZZ"
}
]
}
]
}

Response

A few things are going on in this response:

  • Detailed taxes (txs) for the three line items are displayed
    • Line Item 001 returns 7 taxes totalling 14.096528
    • Line Item 002 returns 1 tax totalling 32.7
    • Line Item 003 returns 3 taxes totalling 2.125
  • Summarized taxes (summ) for the entire invoice are displayed - 11 taxes returned totalling 48.921528
View the Response JSON
{
"inv": [
{
"doc": "TEST-VOIP INVOICE 2017.12.26:12.02 AVA",
"itms": [
{
"ref": "Line Item 001 - VoIP/Access Charge",
"txs": [
{
"bill": true,
"cmpl": true,
"tm": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "Universal Lifeline Telephone Service Charge (VoIP)",
"exm": 64.9,
"lns": 0,
"min": 0,
"pcd": 253500,
"rate": 0.0475,
"sur": true,
"tax": 1.6672499999999997,
"lvl": 1,
"tid": 454
},
{
"bill": true,
"cmpl": true,
"tm": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "CA Teleconnect Fund (VoIP)",
"exm": 64.9,
"lns": 0,
"min": 0,
"pcd": 253500,
"rate": 0.0108,
"sur": true,
"tax": 0.37908,
"lvl": 1,
"tid": 452
},
{
"bill": true,
"cmpl": true,
"tm": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "CA High Cost Fund A (VoIP)",
"exm": 64.9,
"lns": 0,
"min": 0,
"pcd": 253500,
"rate": 0.0035,
"sur": true,
"tax": 0.12284999999999999,
"lvl": 1,
"tid": 450
},
{
"bill": true,
"cmpl": true,
"tm": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "TRS (VoIP)",
"exm": 64.9,
"lns": 0,
"min": 0,
"pcd": 253500,
"rate": 0.005,
"sur": true,
"tax": 0.17549999999999996,
"lvl": 1,
"tid": 217
},
{
"bill": true,
"cmpl": true,
"tm": 35.099999999999994,
"calc": 1,
"cat": "E-911 CHARGES",
"cid": 7,
"name": "E911 (VoIP)",
"exm": 64.9,
"lns": 0,
"min": 0,
"pcd": 253500,
"rate": 0.0075,
"sur": false,
"tax": 0.26324999999999993,
"lvl": 1,
"tid": 161
},
{
"bill": true,
"cmpl": true,
"tm": 64.9,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "FUSF (VoIP)",
"exm": 35.099999999999994,
"lns": 0,
"min": 0,
"pcd": 0,
"rate": 0.174,
"sur": false,
"tax": 11.2926,
"lvl": 0,
"tid": 162
},
{
"bill": true,
"cmpl": true,
"tm": 64.9,
"calc": 1,
"cat": "REGULATORY CHARGES",
"cid": 6,
"name": "FCC Regulatory Fee (VoIP)",
"exm": 35.099999999999994,
"lns": 0,
"min": 0,
"pcd": 0,
"rate": 0.00302,
"sur": false,
"tax": 0.19599800000000003,
"lvl": 0,
"tid": 226
}
]
},
{
"ref": "Line Item 002 - VoIP/Lines",
"txs": [
{
"bill": true,
"cmpl": true,
"tm": 0,
"calc": 4,
"cat": "E-911 CHARGES",
"cid": 7,
"name": "San Francisco Access line Tax (VoIP)",
"exm": 0,
"lns": 10,
"min": 0,
"pcd": 377300,
"rate": 3.27,
"sur": false,
"tax": 32.7,
"lvl": 3,
"tid": 250
}
]
},
{
"ref": "Line Item 003 - VoIP/Equip Rental",
"txs": [
{
"bill": true,
"cmpl": true,
"tm": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "District Tax",
"exm": 0,
"lns": 0,
"min": 0,
"pcd": 377200,
"rate": 0.0125,
"sur": false,
"tax": 0.3125,
"lvl": 2,
"tid": 4
},
{
"bill": true,
"cmpl": true,
"tm": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 0,
"lns": 0,
"min": 0,
"pcd": 377300,
"rate": 0.0125,
"sur": false,
"tax": 0.3125,
"lvl": 2,
"tid": 1
},
{
"bill": true,
"cmpl": true,
"tm": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 0,
"lns": 0,
"min": 0,
"pcd": 377300,
"rate": 0.06,
"sur": false,
"tax": 1.5,
"lvl": 1,
"tid": 1
}
]
}
],
"summ": [
{
"max": 2147483647,
"min": 0,
"tchg": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "Universal Lifeline Telephone Service Charge (VoIP)",
"exm": 64.9,
"lns": 0,
"pcd": 253500,
"rate": 0.0475,
"sur": true,
"tax": 1.6672499999999997,
"lvl": 1,
"tid": 454
},
{
"max": 2147483647,
"min": 0,
"tchg": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "CA Teleconnect Fund (VoIP)",
"exm": 64.9,
"lns": 0,
"pcd": 253500,
"rate": 0.0108,
"sur": true,
"tax": 0.37908,
"lvl": 1,
"tid": 452
},
{
"max": 2147483647,
"min": 0,
"tchg": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "CA High Cost Fund A (VoIP)",
"exm": 64.9,
"lns": 0,
"pcd": 253500,
"rate": 0.0035,
"sur": true,
"tax": 0.12284999999999999,
"lvl": 1,
"tid": 450
},
{
"max": 2147483647,
"min": 0,
"tchg": 35.099999999999994,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "TRS (VoIP)",
"exm": 64.9,
"lns": 0,
"pcd": 253500,
"rate": 0.005,
"sur": true,
"tax": 0.17549999999999996,
"lvl": 1,
"tid": 217
},
{
"max": 2147483647,
"min": 0,
"tchg": 35.099999999999994,
"calc": 1,
"cat": "E-911 CHARGES",
"cid": 7,
"name": "E911 (VoIP)",
"exm": 64.9,
"lns": 0,
"pcd": 253500,
"rate": 0.0075,
"sur": false,
"tax": 0.26324999999999993,
"lvl": 1,
"tid": 161
},
{
"max": 2147483647,
"min": 0,
"tchg": 64.9,
"calc": 1,
"cat": "CONNECTIVITY CHARGES",
"cid": 5,
"name": "FUSF (VoIP)",
"exm": 35.099999999999994,
"lns": 0,
"pcd": 0,
"rate": 0.174,
"sur": false,
"tax": 11.2926,
"lvl": 0,
"tid": 162
},
{
"max": 2147483647,
"min": 0,
"tchg": 64.9,
"calc": 1,
"cat": "REGULATORY CHARGES",
"cid": 6,
"name": "FCC Regulatory Fee (VoIP)",
"exm": 35.099999999999994,
"lns": 0,
"pcd": 0,
"rate": 0.00302,
"sur": false,
"tax": 0.19599800000000003,
"lvl": 0,
"tid": 226
},
{
"max": 2147483647,
"min": 0,
"tchg": 0,
"calc": 4,
"cat": "E-911 CHARGES",
"cid": 7,
"name": "San Francisco Access line Tax (VoIP)",
"exm": 0,
"lns": 10,
"pcd": 377300,
"rate": 3.27,
"sur": false,
"tax": 32.7,
"lvl": 3,
"tid": 250
},
{
"max": 2147483647,
"min": 0,
"tchg": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "District Tax",
"exm": 0,
"lns": 0,
"pcd": 377200,
"rate": 0.0125,
"sur": false,
"tax": 0.3125,
"lvl": 2,
"tid": 4
},
{
"max": 2147483647,
"min": 0,
"tchg": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 0,
"lns": 0,
"pcd": 377300,
"rate": 0.0125,
"sur": false,
"tax": 0.3125,
"lvl": 2,
"tid": 1
},
{
"max": 2147483647,
"min": 0,
"tchg": 25,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 0,
"lns": 0,
"pcd": 377300,
"rate": 0.06,
"sur": false,
"tax": 1.5,
"lvl": 1,
"tid": 1
}
]
}
]
}

Texas Internet Tax Multi-line Invoice Example

This example shows an invoice with 2 line items processed in Invoice Mode (invm is true).

{
"cmpn": {
"bscl": 0,
"svcl": 0,
"fclt": false,
"frch": false,
"reg": false
},
"inv": [
{
"doc": "TEST-VOIP INVOICE 2018.06.05:12.02 AVA",
"cmmt": false,
"bill": {
"cnty": "Harris",
"ctry": "USA",
"int": true,
"geo": false,
"city": "Houston",
"st": "TX",
"zip": "77003"
},
"cust": 0,
"lfln": false,
"date": "2018-05-01T12:00:00Z",
"itms": [
{
"ref": "Line Item 001 - Internet/Access Charge",
"chg": 15,
"line": 0,
"sale": 1,
"incl": false,
"tran": 5,
"serv": 6,
"dbt": false,
"adj": false
},
{
"ref": "Line Item 002 - Internet/Access Line",
"chg": 15,
"line": 0,
"sale": 1,
"incl": false,
"tran": 5,
"serv": 58,
"dbt": false,
"adj": false
}
],
"invm": true,
"dtl": true,
"summ": true,
"opt": [
{
"key": "1",
"val": "Internet $25 exemption invoice example"
}
]
}
]
}

Response

Both the line item detailed taxes (txs) and the summarized taxes (summ) are returned.

View the Response JSON

Response

{
"inv": [
{
"doc": "TEST-VOIP INVOICE 2018.06.05:12.02 AVA",
"itms": [
{
"ref": "Line Item 001 - Internet/Access Charge",
"txs": [
{
"bill": true,
"cmpl": true,
"tm": 0,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Transit Tax",
"exm": 15,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0,
"lvl": 3,
"tid": 33
},
{
"bill": true,
"cmpl": true,
"tm": 0,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 15,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0,
"lvl": 3,
"tid": 1
},
{
"bill": true,
"cmpl": true,
"tm": 0,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 15,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.0625,
"sur": false,
"tax": 0,
"lvl": 1,
"tid": 1
}
]
},
{
"ref": "Line Item 002 - Internet/Access Line",
"txs": [
{
"bill": true,
"cmpl": true,
"tm": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Transit Tax",
"exm": 10,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0.05,
"lvl": 3,
"tid": 33
},
{
"bill": true,
"cmpl": true,
"tm": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 10,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0.05,
"lvl": 3,
"tid": 1
},
{
"bill": true,
"cmpl": true,
"tm": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 10,
"lns": 0,
"min": 0,
"pcd": 3775200,
"rate": 0.0625,
"sur": false,
"tax": 0.3125,
"lvl": 1,
"tid": 1
}
]
}
],
"summ": [
{
"max": 2147483647,
"min": 0,
"tchg": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Transit Tax",
"exm": 25,
"lns": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0.05,
"lvl": 3,
"tid": 33
},
{
"max": 2147483647,
"min": 0,
"tchg": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 25,
"lns": 0,
"pcd": 3775200,
"rate": 0.01,
"sur": false,
"tax": 0.05,
"lvl": 3,
"tid": 1
},
{
"max": 2147483647,
"min": 0,
"tchg": 5,
"calc": 1,
"cat": "SALES AND USE TAXES",
"cid": 1,
"name": "Sales Tax",
"exm": 25,
"lns": 0,
"pcd": 3775200,
"rate": 0.0625,
"sur": false,
"tax": 0.3125,
"lvl": 1,
"tid": 1
}
]
}
]
}

See Also

Input Objects

Output Objects