Fact Pattern 4.3 - Single line sold to a residential customer in Annapolis

This transaction describes a single voice line being sold to a residential customer in Annapolis.

Request parameters:

Customer type is0 (Residential)
Bill-to PCode is1607900
Item 1
- Number of lines is0
- Sale type is1 (Retail)
- T/S pair is19/6, (VoIP/Access Charge)
Item 2
- Number of lines is1
- Sale type is1 (Retail)
- T/S pair is19/21 (VoIP/Lines)
Item 3
- Number of lines is0
- Sale type is1 (Retail)
- T/S pair is19/43 (VoIP/Invoice)

Example request

curl --location --request POST 'https://communicationsua.avalara.net/api/v2/afc/CalcTaxes' \
--header 'Content-Type: application/json' \
--header 'client_id: 787' \
--header 'Authorization: Basic YW5nZWxhLmJhcnR6QGF2YWxhcmEuY29tOkp2SjI0NjAxQXZhbGFyYSE2' \
--data-raw '{
    "cfg": {
        "incrf": true //--Return Reporting Information.
    },
    "cmpn": {
        "bscl": 0, //--Business Class: Typical value is "1". Is the provider and an Incumbant Local Exchange Carrier ("ILEC",  basically those companies that own the wire, antennas and switches of a network) or not?   0=ILEC, 1=NOT an ILEC (or Competitive Local Exchange Carrier "CLEC")
        "svcl": 0, //--Service Class:  Is the provider Primarily a local service provider, or long distance?   0=Primary Local; 1=Primary Long Distance. 
        "fclt": true, //--Facilities:  Does the company providing the service have facilities to provide the service?   
        "frch": false, //--Franchise:  Indicates if the company provides services sold pursuant to a franchise agreement between the carrier and jurisdiction.
        "reg": true, //--Regulated:  Is the Seller is regulated?
        "idnt": "CertCompany"
    },
    "inv": [
        {
            "doc": "CertTest4_3_PCD_VoIP62bb5348-3370-4813-bc30-a3a8b2d6b0d4", //--Document Code:  Required.  A unique value that is used to Commit transactions through the Commit API. Do NOT use InvoiceNumber.  GUID preferable. Every unique call must have a unique "doc".
            "cmmt": false, //--Commit:  Required.  The status of transaction for end of period compliance reporting.  Previously CalcTaxes uncommitted transactions can be committed through the Commit API.
            "bill": { //--Bill To Object:  Required.  Field usually originating from a customer account profile. The SoldTo address of the transaction.  AFC will return the level of granularity in taxation based on the granularity of the address provided.  This object can be JUST PCode value if you utilize the GEO or PCODE APIs for assigning a PCODE to a location.
                "pcd": 1607900 //--PCode:  You can pass only this value in the BillTo object.  Preassigned values are handled via the GEO and PCODE APIs.
            },
            "cust": 0, //--Customer Type: Required.  Field usually originating from a customer account profile. 0=Residential; 1=Business; 2=Senior Citizen; 3=Industrial.  Different customer types could have different tax rules.
            "lfln": false, //--Lifeline:  Field usually originating from a customer account profile.  Is the customer a lifeline participants?
            "date": "2021-11-01T12:00:00Z", //--Date:  Effective Tax Rate Date to be applied to the invoice.  Most often Invoice Date generated through SysDate on the bill run.
            "itms": [
                {
                    "ref": "1_CertTest4_3_PCD_BaseMRC", //--Reference Code.  Reference Id for a line item.  
                    "chg": 15, //--Charge:  Required.  Billed pre-tax amount if "incl"=false.  Billed after tax amount if "incl"=true.  
                    "line": 0, //--Lines:  Number of phone lines to be taxed.  Required for certain T/S Pairs.
                    "sale": 1, //--Sale:  Sale Type:  0=Wholesale, 1=Retail, 2=Consumed (Sales and Use Only), 3=Vendor Use. REQUIRED
                    "tran": 19, //--Transaction Type: Industry vertical...see mapping guidelines for this. REQUIRED
                    "serv": 6, //--Service Type:  Billable services for an industry vertical....see mapping guidelines for this. REQUIRED
                    "adj": false //--Adjustment:  True, will negate taxes. False, will return positive taxes.  Default is False.
                },
                {
                    "ref": "1_CertTest4_3_PCD_LineCount", //--Reference Code.  Reference Id for a line item.    
                    "chg": 0, //--Charge:  Required.  Billed pre-tax amount if "incl"=false.  Billed after tax amount if "incl"=true.  
                    "line": 1, //--Lines:  Number of phone lines to be taxed.  Required for certain T/S Pairs.
                    "sale": 1, //--Sale:  Sale Type:  0=Wholesale, 1=Retail, 2=Consumed (Sales and Use Only), 3=Vendor Use. REQUIRED
                    "tran": 19, //--Transaction Type: Industry vertical...see mapping guidelines for this. REQUIRED
                    "serv": 21, //--Service Type:  Billable services for an industry vertical....see mapping guidelines for this. REQUIRED
                    "adj": false //--Adjustment:  True, will negate taxes. False, will return positive taxes.  Default is False.
                },
                {
                    "ref": "1_CertTest4_3_PCD_InvoiceCharge", //--Reference Code.  Reference Id for a line item.    
                    "chg": 1, //--Charge:  Required.  Billed pre-tax amount if "incl"=false.  Billed after tax amount if "incl"=true.  
                    "line": 0, //--Lines:  Number of phone lines to be taxed.  Required for certain T/S Pairs.
                    "sale": 1, //--Sale:  Sale Type:  0=Wholesale, 1=Retail, 2=Consumed (Sales and Use Only), 3=Vendor Use. REQUIRED
                    "tran": 19, //--Transaction Type: Industry vertical...see mapping guidelines for this. REQUIRED
                    "serv": 43, //--Service Type:  Billable services for an industry vertical....see mapping guidelines for this. REQUIRED
                    "adj": false //--Adjustment:  True, will negate taxes. False, will return positive taxes.  Default is False.
                }
            ],
            "invm": true,
            "dtl": true,
            "summ": true,
            "acct": "CertCompany",
            "custref": "CertTest4_3",
            "invn": "CertTest4_3",
            "bcyc": "202204",
            "bpd": {
                "month": 04,
                "year": 2022
            }
        }
    ]
}'

Example response

{
    "inv": [
        {
            "doc": "CertTest4_3_PCD_VoIP6ff0d55f-3234-4ca5-b915-1241d44c4f1d",
            "itms": [
                {
                    "ref": "1_CertTest4_3_PCD_BaseMRC",
                    "txs": [
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 17.871825,
                            "calc": 1,
                            "cat": "UTILITY USER TAXES",
                            "cid": 8,
                            "name": "Utility Users Tax",
                            "exm": 0.0,
                            "lns": 0,
                            "min": 0.0,
                            "pcd": 1607300,
                            "rate": 0.08,
                            "sur": false,
                            "tax": 1.429746,
                            "lvl": 2,
                            "tid": 16
                        },
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 9.735,
                            "calc": 1,
                            "cat": "CONNECTIVITY CHARGES",
                            "cid": 5,
                            "name": "FUSF (VoIP)",
                            "exm": 5.265,
                            "lns": 0,
                            "min": 0.0,
                            "pcd": 0,
                            "rate": 0.291,
                            "sur": false,
                            "tax": 2.832885,
                            "lvl": 0,
                            "tid": 162
                        },
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 9.735,
                            "calc": 1,
                            "cat": "REGULATORY CHARGES",
                            "cid": 6,
                            "name": "FCC Regulatory Fee (VoIP)",
                            "exm": 5.265,
                            "lns": 0,
                            "min": 0.0,
                            "pcd": 0,
                            "rate": 0.004,
                            "sur": false,
                            "tax": 0.03894,
                            "lvl": 0,
                            "tid": 226
                        }
                    ]
                },
                {
                    "ref": "1_CertTest4_3_PCD_LineCount",
                    "txs": [
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 0.0,
                            "calc": 4,
                            "cat": "E-911 CHARGES",
                            "cid": 7,
                            "name": "E911 (VoIP)",
                            "exm": 0.0,
                            "lns": 1,
                            "min": 0.0,
                            "pcd": 1607300,
                            "rate": 0.75,
                            "sur": false,
                            "tax": 0.75,
                            "lvl": 2,
                            "tid": 161
                        },
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 0.0,
                            "calc": 4,
                            "cat": "E-911 CHARGES",
                            "cid": 7,
                            "name": "E911 (VoIP)",
                            "exm": 0.0,
                            "lns": 1,
                            "min": 0.0,
                            "pcd": 1607300,
                            "rate": 0.5,
                            "sur": false,
                            "tax": 0.5,
                            "lvl": 1,
                            "tid": 161
                        }
                    ]
                },
                {
                    "ref": "1_CertTest4_3_PCD_InvoiceCharge",
                    "txs": [
                        {
                            "bill": true,
                            "cmpl": true,
                            "tm": 0.0,
                            "calc": 2,
                            "cat": "CONNECTIVITY CHARGES",
                            "cid": 5,
                            "name": "Universal Service Fee",
                            "exm": 0.0,
                            "lns": 0,
                            "min": 0.0,
                            "pcd": 1604700,
                            "rate": 0.05,
                            "sur": true,
                            "tax": 0.05,
                            "lvl": 1,
                            "tid": 298
                        }
                    ]
                }
            ],
            "summ": [
                {
                    "max": 2147483647.0,
                    "min": 0.0,
                    "tchg": 17.871825,
                    "calc": 1,
                    "cat": "UTILITY USER TAXES",
                    "cid": 8,
                    "name": "Utility Users Tax",
                    "exm": 0.0,
                    "lns": 0,
                    "pcd": 1607300,
                    "rate": 0.08,
                    "sur": false,
                    "tax": 1.429746,
                    "lvl": 2,
                    "tid": 16
                },
                {
                    "max": 2147483647.0,
                    "min": 0.0,
                    "tchg": 9.735,
                    "calc": 1,
                    "cat": "CONNECTIVITY CHARGES",
                    "cid": 5,
                    "name": "FUSF (VoIP)",
                    "exm": 5.265,
                    "lns": 0,
                    "pcd": 0,
                    "rate": 0.291,
                    "sur": false,
                    "tax": 2.832885,
                    "lvl": 0,
                    "tid": 162
                },
                {
                    "max": 2147483647.0,
                    "min": 0.0,
                    "tchg": 9.735,
                    "calc": 1,
                    "cat": "REGULATORY CHARGES",
                    "cid": 6,
                    "name": "FCC Regulatory Fee (VoIP)",
                    "exm": 5.265,
                    "lns": 0,
                    "pcd": 0,
                    "rate": 0.004,
                    "sur": false,
                    "tax": 0.03894,
                    "lvl": 0,
                    "tid": 226
                },
                {
                    "max": 2147483647.0,
                    "min": 0.0,
                    "tchg": 0.0,
                    "calc": 4,
                    "cat": "E-911 CHARGES",
                    "cid": 7,
                    "name": "E911 (VoIP)",
                    "exm": 0.0,
                    "lns": 1,
                    "pcd": 1607300,
                    "rate": 0.75,
                    "sur": false,
                    "tax": 0.75,
                    "lvl": 2,
                    "tid": 161
                },
                {
                    "max": 2147483647.0,
                    "min": 0.0,
                    "tchg": 0.0,
                    "calc": 4,
                    "cat": "E-911 CHARGES",
                    "cid": 7,
                    "name": "E911 (VoIP)",
                    "exm": 0.0,
                    "lns": 1,
                    "pcd": 1607300,
                    "rate": 0.5,
                    "sur": false,
                    "tax": 0.5,
                    "lvl": 1,
                    "tid": 161
                },
                {
                    "max": 1.0,
                    "min": 0.0,
                    "tchg": 0.0,
                    "calc": 2,
                    "cat": "CONNECTIVITY CHARGES",
                    "cid": 5,
                    "name": "Universal Service Fee",
                    "exm": 0.0,
                    "lns": 0,
                    "pcd": 1604700,
                    "rate": 0.05,
                    "sur": false,
                    "tax": 0.05,
                    "lvl": 1,
                    "tid": 298
                }
            ],
            "incrf": {
                "acct": "CertCompany",
                "custref": "CertTest4_3",
                "invn": "CertTest4_3",
                "bcyc": "202204"
            }
        }
    ]
}