REST v2 allows you to specify the level of detail returned as part of the CalcTaxes response.
Setting the Flags
There are two available levels of detail set on the Invoice:
Detailed tax details (dtl): displays the tax details per line item
Summary tax details (summ): displays a summary of all taxes returned. InvoiceMode (invm) must be enabled
ReturnDetail and/or ReturnSummary must be set to true.
ReturnDetail
Setting the ReturnDetail flag (dtl) displays or hides the detailed taxes object (txs) for each LineItem in the CalcTaxes response. InvoiceMode (invm) has no impact on the ReturnDetail flag.
InvoiceMode Value
ReturnDetail Value
CalcTaxes Response Result
true or false
true (default)
Enables return of tax details txs object
false
Disables return of tax details txs object
Note about Bundle Files
Bundled tax calculations return summarized detailed results when more than one bundle item returns the same tax type.
ReturnSummary
Setting the ReturnSummary flag (summ) displays or hides the summary taxes object (summ) for the entire Invoice in the CalcTaxes response.
InvoiceMode Value
ReturnSummary Value
CalcTaxes Response Result
true
false (default)
Disables return of tax summary summ object
true
Enables return of tax summary summ object
false
true or false
Tax summary summ object not returned
Taxable Measure
Taxable measure is returned as part the detailed taxes. It is the basis for calculation of rate-based taxes. Simple transactions result in a taxable measure equal to the sale price. However, tax-on-tax, caps, thresholds, tiers, and taxable amount modifiers can all result in taxable measures that are greater than or less than the sale price. For rate-based taxes, Tax Amount = Taxable Measure * Rate.
Taxable measure is adjusted by any factor that changes the tax calculation. Examples:
Taxable measure exceeds the sale amount: Tax-on-tax occurs - the tax amount calculated includes tax amount from other taxes. The additional taxes to be included are added to the taxable measure
Taxable measure is less than the sale price: A discount is applied - safe harbor exemptions or internet tax in Texas where the first $25 is exempt from taxation
Example 1 - Summary and Detailed taxes Returned
This example demonstrates both the Detail taxes (txs) and Summary taxes (summ) returned in the CalcTaxes response.
In this sample request:
InvoiceMode, ReturnDetail, and ReturnSummary fields are all set to true
This is the only combination of fields to return both the Detail and Summary taxes together.
{"inv":[{"doc":"DISPLAYING TAX RESULTS","itms":[{"ref":"Line Item 001","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","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","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}]}]}
Example 2 - Only Detail taxes Returned
This example demonstrates the Detail taxes (txs) returned in the CalcTaxes response, but the Summary taxes (summ) suppressed.
In this sample request:
ReturnDetail and ReturnSummary fields are both set to true
InvoiceMode is set to false
The following additional scenarios return the same results:
InvoiceMode and ReturnDetail both set to true but ReturnSummary set to false
InvoiceMode and ReturnSummary both set to false but ReturnDetail set to true