Request
The Request method is used to create a transaction to calculate taxes.
Request Layout
All POST field names are required and are case-sensitive. Field values are required unless otherwise noted.
For development and testing with HTTPS POST, please use the following URL: https://testapi.taxrating.net/Services/V01/Energy/SureTax.asmx/PostRequest
Request Record
| FIELD NAME | POST FIELD | DESCRIPTION |
|---|---|---|
| Client Number | ClientNumber | Client ID Number – provided by CCH SureTax. Required. Max Len: 10 |
| Business Unit | BusinessUnit | Client’s Business Unit. Value for this field is not required. Max Len: 20 |
| Validation Key | ValidationKey | Validation Key provided by CCH SureTax. Required for client access to API function. Max Len: 36 |
| Data Year | DataYear | Required. YYYY – Year to use for tax calculation purposes |
| Data Month | DataMonth | Required. MM – Month to use for tax calculation purposes. Leading zero is preferred. |
| Compliance Year | CmplDataYear | Required. YYYY – Year to use for recording the tax calculations for tax remittance purposes |
| Compliance Month | CmplDataMonth | Required. MM – Month to use for recording the tax calculations for tax remittance purposes. Leading zero is preferred. |
| Total Revenue | TotalRevenue | Required. Format: $$$$$$$$$.CCCC For Negative charges, the first position should have a minus (-) indicator. |
| Return File Code | ReturnFileCode | Required. 0 – Default Q – Quote purposes - taxes are computed and returned in the response message for generating quotes. No detailed tax information is saved in the CCH SureTax tables for reporting. |
| Client Tracking Field | ClientTracking | Field for client transaction tracking. This value will be provided in the response data. Value for this field is not required, but preferred. Max Len: 100 |
| Response Group | ResponseGroup | Required. Determines how taxes are grouped for the response. Values: 00 – Tax grouped by Line Item |
| Response Type | ResponseType | Required. Determines the granularity of taxes and (optionally) the decimal precision for the tax calculations and amounts in the response. First Position Values: D – Detailed. Tax values are returned by tax type for all levels of tax (Federal, State, and Local). (optional) Second Position Values: An integer (1-9) determines the decimal places used for all tax responses. If no value is provided, all taxes are returned with a default number decimal places. This default precision value varies by “engine”. For example, to return tax amounts to four decimals places, the Response Type would be: D4 |
| System Trace Audit Number | STAN | Optional value. A unique value provided by client for transaction audit purposes. Max Len: 40 |
| Master Transaction Id | MasterTransId | Transaction Id for reuse |
| Client Items | ItemList | List of Item records |
Item Layout
| FIELD NAME | POST FIELD | DESCRIPTION |
|---|---|---|
| Line Number | LineNumber | Used to identify an item within the request. If no value is provided, requests are numbered sequentially. Max Len: 40 |
| Invoice Number | InvoiceNumber | Used for tax aggregation by Invoice. Must be alphanumeric. Max Len: 40 |
| Customer Number | CustomerNumber | Used for tax aggregation by Customer. Must be alphanumeric. Max Len: 40 |
| Location Code | LocationCode | Used to provide the location / outlet ID. Must be alphanumeric. Max Len: 40 |
| Date of Transaction | TransDate | Required. Date of transaction. Valid date formats include: MM/DD/YYYY MM-DD-YYYY YYYY-MM-DDTHH:MM:SS |
| Billing Period Start Date | BillingPeriodStartDate | Optional. Billing Period Start Date |
| Billing Period End Date | BillingPeriodEndDate | Optional. Billing Period End Date |
| Revenue | Revenue | Required. Format: $$$$$$$$$.CCCC For Negative charges, the first position should have a minus (-) indicator. |
| Units | Units | Required. Units representing number of "lines" or unique charges contained within the revenue. This value is essentially a multiplier on unit-based fees (e.g. E911 fees). Format: 99999. Default should be 1 (one unit). |
| Unit Type | UnitType | Required. 00 – Default / Number of unique access lines. See Appendix F for additional values. |
| Tax Included Code | TaxIncludedCode | Required. Values: 0 – Default (No Tax Included) 1 – Tax Included in Revenue |
| Tax Situs Rule | TaxSitusRule | Required. Values: 04 – Zip code 05 – Zip code + 4 27 – Use only Billing Address / Zip+4 |
| Transaction Type Code | TransTypeCode | Required. Transaction Type Indicator. See Appendix B for values. Or Product Group Product Item (PGPI). |
| Sales Type Code | SalesTypeCode | Required. Values: R – Residential customer (default) B – Business customer I – Industrial customer L – Lifeline customer S – Senior Citizen A – Agriculture M – Manufacturing H – Mobile home – residential D – Commercial – high peak demand T – Retail P – Customer with prescription F – Food – to stay |
| Regulatory Code | RegulatoryCode | Required. Provider Type. See Appendix C for values. |
| Tax Exemption Codes | TaxExemptionCodeList | Required. Tax Exemption to be applied to this item only. See Appendix D for values. |
| Tax Exempt Reason Code | ExemptReasonCode | Required. Tax Exemption reason value. See Appendix E for values. |
| Cost Center | CostCenter | Optional. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| GL Account | GLAccount | Optional. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Material Group | MaterialGroup | Optional. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Currency Code | CurrencyCode | Optional. Currency code based on ISO standard. As reference - http://www.xe.com/iso4217.php |
| Origin Country Code | OriginCountryCode | Optional. Origin Country Code |
| Destination Country Code | DestCountryCode | Optional. Destination Country Code |
| Billing Days in Period | BillingDaysInPeriod | Optional. Billing Days in Period. |
| Parameter 1 | Parameter1 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 2 | Parameter2 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 3 | Parameter3 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 4 | Parameter4 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 5 | Parameter5 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 6 | Parameter6 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 7 | Parameter7 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 8 | Parameter8 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 9 | Parameter9 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| Parameter 10 | Parameter10 | Optional, user defined field. Available for use in the rules engine. Max Len: 25 Alphanumeric |
| User defined field | UDF | Optional. Field for client use at the item level. This value is not returned in the response, but is available for use in reports and extracts. Max Len: 100 |
| User defined field 2 | UDF2 | Optional. Field for client use at the item level. This value is not returned in the response, but is available for use in reports and extracts. Max Len: 100 |
| Billing Address | Address | Billing address for transaction - see Address Layout definition below |
Address Layout
| FIELD NAME | POST FIELD | DESCRIPTION |
|---|---|---|
| Primary Address Line | PrimaryAddressLine | Address Line 1 |
| Secondary Address Line | SecondaryAddressLine | Address Line 2 |
| County | County | County |
| City | City | City |
| State | State | State – full state name or two-character abbreviation accepted |
| PostalCode | PostalCode | Zip code or Canadian postal code |
| Plus4 | Plus4 | Zip+4 |
| Country | Country | International country ISO code value in format: XX |
| CCH Geocode | Geocode | Optional value. If provided, the CCH Geocode will take precedence and will be used instead of the address / zip+4 information. |
| Verify Address | VerifyAddress | Required. If selected, SureAddress will validate address and update the zip+4. 0 – No (default) 1 – Yes |
Examples
JSON request format with sample data
For information on the JSON format - http://en.wikipedia.org/wiki/JSON
Note
When supplying the JSON string as a POST variable, the request value would be supplied as “request={…JSON…}”. The Headers ContentType value would be provided as: “Content-Type: application/x-www-form-urlencoded”.
When supplying JSON serialized, the request value would be supplied as: {“request”:…JSON…”}. The Headers Content-Type value would be provided as: “Content-Type: application/json”. This response will be returned wrapped in a “d” object. For more information on this approach, please see the following article: http://encosia.com/a-breaking-change-between-versions-of-aspnet-ajax/#comment-34045
{
"ClientNumber": "000000000",
"BusinessUnit": "",
"ValidationKey": "13290031-F004-4F00-BMN3-E979D6749B88",
"DataYear": "2016",
"DataMonth": "06",
"CmplDataYear": "2016",
"CmplDataMonth": "06",
"TotalRevenue": "0",
"ClientTracking": "",
"ResponseType": "D2",
"ResponseGroup": "00",
"ReturnFileCode": "0",
"STAN": "",
"MasterTransId": "0",
"ItemList": [
"Item": {
"LineNumber": "001",
"InvoiceNumber": "",
"CustomerNumber": "001",
"LocationCode": "",
"TransDate": "06/10/2016",
"BillingPeriodStartDate": "",
"BillingPeriodEndDate": "",
"Revenue": "100",
"TaxIncludedCode": "0",
"Units": "0",
"UnitType": "03",
"TaxSitusRule": "04",
"TransTypeCode": "040101",
"SalesTypeCode": "R",
"RegulatoryCode": "50",
"BillingDaysInPeriod": "0",
"OriginCountryCode": "",
"DestCountryCode": "",
"TaxExemptionCodeList": {
"string": ""
},
"UDF": "",
"UDF2": "",
"CostCenter": "",
"GLAccount": "",
"MaterialGroup": "",
"Parameter1": "",
"Parameter2": "",
"Parameter3": "",
"Parameter4": "",
"Parameter5": "",
"Parameter6": "",
"Parameter7": "",
"Parameter8": "",
"Parameter9": "",
"Parameter10": "",
"CurrencyCode": "",
"ExemptReasonCode": "",
"Address": {
"PrimaryAddressLine": "",
"SecondaryAddressLine": "",
"County": "",
"City": "",
"State": "",
"PostalCode": "80112",
"Plus4": "",
"Country": "",
"Geocode": "",
"VerifyAddress": "false"
}
}
]
}
XML request format with sample data
<?xml version="1.0" encoding="UTF-8" ?>
<ClientNumber>000000000</ClientNumber>
<BusinessUnit></BusinessUnit>
<ValidationKey>13290031-F004-4F00-BMN3-E979D6749B88</ValidationKey>
<DataYear>2016</DataYear>
<DataMonth>06</DataMonth>
<CmplDataYear>2016</CmplDataYear>
<CmplDataMonth>06</CmplDataMonth>
<TotalRevenue>0</TotalRevenue>
<ClientTracking></ClientTracking>
<ResponseType>D2</ResponseType>
<ResponseGroup>00</ResponseGroup>
<ReturnFileCode>0</ReturnFileCode>
<STAN></STAN>
<MasterTransId>0</MasterTransId>
<ItemList>
<Item>
<LineNumber>001</LineNumber>
<InvoiceNumber></InvoiceNumber>
<CustomerNumber>001</CustomerNumber>
<LocationCode></LocationCode>
<TransDate>06/10/2016</TransDate>
<BillingPeriodStartDate></BillingPeriodStartDate>
<BillingPeriodEndDate></BillingPeriodEndDate>
<Revenue>100</Revenue>
<TaxIncludedCode>0</TaxIncludedCode>
<Units>0</Units>
<UnitType>03</UnitType>
<TaxSitusRule>04</TaxSitusRule>
<TransTypeCode>040101</TransTypeCode>
<SalesTypeCode>R</SalesTypeCode>
<RegulatoryCode>50</RegulatoryCode>
<BillingDaysInPeriod>0</BillingDaysInPeriod>
<OriginCountryCode></OriginCountryCode>
<DestCountryCode></DestCountryCode>
<TaxExemptionCodeList>
<string></string>
</TaxExemptionCodeList>
<UDF></UDF>
<UDF2></UDF2>
<CostCenter></CostCenter>
<GLAccount></GLAccount>
<MaterialGroup></MaterialGroup>
<Parameter1></Parameter1>
<Parameter2></Parameter2>
<Parameter3></Parameter3>
<Parameter4></Parameter4>
<Parameter5></Parameter5>
<Parameter6></Parameter6>
<Parameter7></Parameter7>
<Parameter8></Parameter8>
<Parameter9></Parameter9>
<Parameter10></Parameter10>
<CurrencyCode></CurrencyCode>
<ExemptReasonCode></ExemptReasonCode>
<Address>
<PrimaryAddressLine></PrimaryAddressLine>
<SecondaryAddressLine></SecondaryAddressLine>
<County></County>
<City></City>
<State></State>
<PostalCode>80112</PostalCode>
<Plus4></Plus4>
<Country></Country>
<Geocode></Geocode>
<VerifyAddress>false</VerifyAddress>
</Address>
</Item>
</ItemList>
SOAP 1.1 request format with sample data
POST Services/V07/SureTax.asmx HTTP/1.1
Host: testapi.taxrating.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/SoapRequest"
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:SoapRequest>
<tem:request>
<tem:ClientNumber>000000000</tem:ClientNumber>
<tem:BusinessUnit>biz unit</tem:BusinessUnit>
<tem:ValidationKey>13290031-F004-4F00-BMN3-E979D6749B88</tem:ValidationKey>
<tem:DataYear>2013</tem:DataYear>
<tem:DataMonth>06</tem:DataMonth>
<tem:CmplDataYear>2013</tem:CmplDataYear>
<tem:CmplDataMonth>06</tem:CmplDataMonth>
<tem:TotalRevenue>100.0</tem:TotalRevenue>
<tem:ClientTracking>test</tem:ClientTracking>
<tem:ResponseType>D2</tem:ResponseType>
<tem:ResponseGroup>00</tem:ResponseGroup>
<tem:ReturnFileCode>0</tem:ReturnFileCode>
<tem:STAN></tem:STAN>
<tem:MasterTransId>0</tem:MasterTransId>
<tem:ItemList>
<tem:Item>
<tem:LineNumber>1</tem:LineNumber>
<tem:InvoiceNumber>1</tem:InvoiceNumber>
<tem:CustomerNumber>000000001</tem:CustomerNumber>
<tem:LocationCode></tem:LocationCode>
<tem:TransDate>2013-04-01</tem:TransDate>
<tem:BillingPeriodStartDate></tem:BillingPeriodStartDate>
<tem:BillingPeriodEndDate></tem:BillingPeriodEndDate>
<tem:Revenue>100.0</tem:Revenue>
<tem:TaxIncludedCode>0</tem:TaxIncludedCode>
<tem:Units>1</tem:Units>
<tem:UnitType>00</tem:UnitType>
<tem:TaxSitusRule>04</tem:TaxSitusRule>
<tem:TransTypeCode>990101</tem:TransTypeCode>
<tem:SalesTypeCode>D</tem:SalesTypeCode>
<tem:RegulatoryCode>01</tem:RegulatoryCode>
<tem:TaxExemptionCodeList>
<tem:string></tem:string>
</tem:TaxExemptionCodeList>
<tem:UDF></tem:UDF>
<tem:UDF2></tem:UDF2>
<tem:OriginCountryCode></tem:OriginCountryCode>
<tem:DestCountryCode></tem:DestCountryCode>
<tem:BillingDaysInPeriod>0</tem:BillingDaysInPeriod>
<tem:CostCenter></tem:CostCenter>
<tem:GLAccount></tem:GLAccount>
<tem:MaterialGroup></tem:MaterialGroup>
<tem:Parameter1></tem:Parameter1>
<tem:Parameter2></tem:Parameter2>
<tem:Parameter3></tem:Parameter3>
<tem:Parameter4></tem:Parameter4>
<tem:Parameter5></tem:Parameter5>
<tem:Parameter6></tem:Parameter6>
<tem:Parameter7></tem:Parameter7>
<tem:Parameter8></tem:Parameter8>
<tem:Parameter9></tem:Parameter9>
<tem:Parameter10></tem:Parameter10>
<tem:CurrencyCode></tem:CurrencyCode>
<tem:ExemptReasonCode></tem:ExemptReasonCode>
<tem:Address>
<tem:PrimaryAddressLine></tem:PrimaryAddressLine>
<tem:SecondaryAddressLine></tem:SecondaryAddressLine>
<tem:County></tem:County>
<tem:City></tem:City>
<tem:State></tem:State>
<tem:PostalCode>80112</tem:PostalCode>
<tem:Plus4>0000</tem:Plus4>
<tem:Country></tem:Country>
<tem:Geocode></tem:Geocode>
<tem:VerifyAddress>true</tem:VerifyAddress>
</tem:Address>
</tem:Item>
</tem:ItemList>
</tem:request>
</tem:SoapRequest>
</soapenv:Body>
</soapenv:Envelope>
SOAP 1.2 request format with sample data
POST Services/V07/SureTax.asmx HTTP/1.1
Host: testapi.taxrating.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-16"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SoapRequest xmlns="http://tempuri.org/">
<request>
<ClientNumber>000000000</ClientNumber>
<BusinessUnit />
<ValidationKey>13290031-F004-4F00-BMN3-E979D6749B88</ValidationKey>
<DataYear>2016</DataYear>
<DataMonth>06</DataMonth>
<CmplDataYear>2016</CmplDataYear>
<CmplDataMonth>06</CmplDataMonth>
<TotalRevenue>0</TotalRevenue>
<ClientTracking />
<ResponseType>D2</ResponseType>
<ResponseGroup>00</ResponseGroup>
<ReturnFileCode>0</ReturnFileCode>
<STAN />
<MasterTransId>0</MasterTransId>
<ItemList>
<Item>
<LineNumber>001</LineNumber>
<InvoiceNumber />
<CustomerNumber>001</CustomerNumber>
<LocationCode />
<TransDate>06/10/2016</TransDate>
<BillingPeriodStartDate />
<BillingPeriodEndDate />
<Revenue>100</Revenue>
<TaxIncludedCode>0</TaxIncludedCode>
<Units>0</Units>
<UnitType>03</UnitType>
<TaxSitusRule>04</TaxSitusRule>
<TransTypeCode>040101</TransTypeCode>
<SalesTypeCode>R</SalesTypeCode>
<RegulatoryCode>50</RegulatoryCode>
<BillingDaysInPeriod>0</BillingDaysInPeriod>
<OriginCountryCode />
<DestCountryCode />
<TaxExemptionCodeList>
<string />
</TaxExemptionCodeList>
<UDF />
<UDF2 />
<CostCenter />
<GLAccount />
<MaterialGroup />
<Parameter1 />
<Parameter2 />
<Parameter3 />
<Parameter4 />
<Parameter5 />
<Parameter6 />
<Parameter7 />
<Parameter8 />
<Parameter9 />
<Parameter10 />
<CurrencyCode />
<ExemptReasonCode />
<Address>
<PrimaryAddressLine />
<SecondaryAddressLine />
<County />
<City />
<State />
<PostalCode>80112</PostalCode>
<Plus4 />
<Country />
<Geocode />
<VerifyAddress>false</VerifyAddress>
</Address>
</Item>
</ItemList>
</request>
</SoapRequest>
</soap:Body>
</soap:Envelope>
Response Messages
This response message includes detail values for each of the taxes applied to the line items.
To test, please use the following URL: https://testapi.taxrating.net/Services/V07/SureTax.asmx
For additional information on the layouts and configurations for development and testing purposes, see https://testapi.taxrating.net/Documentation/V07/SureTax.asmx (requires valid login credentials).
Response Header
| FIELD NAME | DESCRIPTION |
|---|---|
| Successful | Response will be either ‘Y' or ‘N' : Y = Success / Success with Item error N = Failure |
| ResponseCode | ResponseCode: 9999 – Request was successful. 1101-1400 – Range of values for a failed request (no processing occurred) 9001 – Request was successful, but items within the request have errors. The specific items with errors are provided in the ItemMessages field. |
| HeaderMessage | Response message: For ResponseCode 9999 – "Success" For ResponseCode 9001 – "Success with Item errors". See the ItemMessages field for a list of items / errors. For ResponseCode 1100-1400 – Unsuccessful / declined web request. See Appendix I for a list of the response code and messages. |
| ItemMessages | This field contains a list of items that were not able to be processed due to bad or invalid data (see Response Code of “9001”). These invalid items will be listed by line number with the corresponding response code and message. When an item error occurs, no tax processing will occur for that item record. When an error for an item occurs, this field contains the following fields:
If no item errors exist, the field will have a value of empty. |
| ClientTracking | Client transaction tracking provided in web request. |
| TotalTax | Total Tax – a total of all taxes included in the TaxList |
| TransId | Transaction ID (integer) – provided by CCH SureTax |
| GroupList | See Group ( contains one-to-many Groups) |
Group
| FIELD NAME | DESCRIPTION |
|---|---|
| LineNumber | Line Number from Request |
| StateCode | Tax State |
| InvoiceNumber | Invoice Number |
| CustomerNumber | Customer number |
| TaxList | See Tax Item(s) – contains one-to-many Tax Items |
Note
The tax output will be grouped (line number, state, invoice number, customer number.) The ResponseGroup selection in the request is ignored when using the V02 engine.
Tax Item(s)
| FIELD NAME | DESCRIPTION |
|---|---|
| TaxTypeCode | Tax Type Code |
| TaxTypeDesc | Jurisdiction-specific Tax Type Description |
| TaxAmount | Tax Amount (taxes returned with five decimal places) |
| Revenue | Source Revenue for Line Item |
| CountyName | County Name of taxing jurisdiction |
| CityName | City Name of taxing jurisdiction |
| TaxRate | Tax rate for tax type applied in decimal format (if zero, please see FeeRate) |
| PercentTaxable | Percentage of the tax that is taxable for the tax type in decimal format. This can be less than 100% in certain circumstances such as application of a Safe Harbor rate or a Private Line that is allocated to two or more points. |
| FeeRate | The unit based fee for the tax type in format $.CCCC (if zero, please see TaxRate) |
| RevenueBase | The effective revenue for the tax provided in the TaxAmount field. This amount can be different than the amount in the Revenue field when taxes are impacted by specific exemptions and/or tax on tax. |
| TaxOnTax | The amount of tax on tax attributed to the final amount of tax. Please note this amount is included in the TaxAmount field total and is provided here separately only for reference purposes. |
Examples
JSON format with sample data
{
"Successful": "Y",
"ResponseCode": "9999",
"HeaderMessage": "Success",
"ItemMessages": [],
"ClientTracking": "Test Energy",
"TotalTax": "25.864212",
"TransId": 2477023,
"GroupList": [
{
"LineNumber": "1",
"StateCode": "TX",
"InvoiceNumber": "101",
"CustomerNumber": "90120302",
"TaxList": [
{
"TaxTypeCode": "101",
"TaxTypeDesc": "STATE SALES TAX",
"TaxAmount": "7.220209",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0.0625,
"PercentTaxable": 1,
"FeeRate": 0,
"RevenueBase": "115.523344",
"TaxOnTax": "0.970209"
},
{
"TaxTypeCode": "403",
"TaxTypeDesc": "DALLAS MTA",
"TaxAmount": "1.155233",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0.01,
"PercentTaxable": 1,
"FeeRate": 0,
"RevenueBase": "115.523300",
"TaxOnTax": "0.155233"
},
{
"TaxTypeCode": "304",
"TaxTypeDesc": "CITY SALES TAX",
"TaxAmount": "1.155233",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0.01,
"PercentTaxable": 1,
"FeeRate": 0,
"RevenueBase": "115.523300",
"TaxOnTax": "0.155233"
},
{
"TaxTypeCode": "106",
"TaxTypeDesc": "9-1-1 EQUALIZATION FEE",
"TaxAmount": "0.060000",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0,
"PercentTaxable": 1,
"FeeRate": 0.06,
"RevenueBase": "100",
"TaxOnTax": "0"
},
{
"TaxTypeCode": "324",
"TaxTypeDesc": "MUNICIPAL RIGHT-OF-WAY FEE",
"TaxAmount": "4.230000",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0,
"PercentTaxable": 1,
"FeeRate": 4.23,
"RevenueBase": "100",
"TaxOnTax": "0"
},
{
"TaxTypeCode": "333",
"TaxTypeDesc": "PLANO 9-1-1 FEE",
"TaxAmount": "0.750000",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0,
"PercentTaxable": 1,
"FeeRate": 0.75,
"RevenueBase": "100",
"TaxOnTax": "0"
},
{
"TaxTypeCode": "035",
"TaxTypeDesc": "FEDERAL UNIVERSAL SERVICE FEE",
"TaxAmount": "10.231877",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0.156,
"PercentTaxable": 0.649,
"FeeRate": 0,
"RevenueBase": "65.588955",
"TaxOnTax": "0.107477"
},
{
"TaxTypeCode": "060",
"TaxTypeDesc": "Federal Regulatory Assessment Fee",
"TaxAmount": "1.061660",
"Revenue": "100",
"CountyName": "COLLIN",
"CityName": "PLANO",
"TaxRate": 0.01484,
"PercentTaxable": 0.649,
"FeeRate": 0,
"RevenueBase": "71.540431",
"TaxOnTax": "0.098544"
}
]
}
]
}
XML format with sample data
Note
The XML that is returned from CCH SureTax is processed through the Microsoft.NET XMLSerializer. As such, the returning XML data is html encoded ( http://www.w3.org/TR/2004/REC-xml-20040204/#syntax ) and converted to a well-formed XML that is readily transported. On the client receiving end, the data should be deserialized / decoded to reconstruct the XML object from the stream.
For example, the actual XML data submitted from CCH SureTax will resemble:
<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/"><?xml version="1.0"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ExtensionData />
<Successful>Y</Successful>
<ResponseCode>9999</ResponseCode>
<HeaderMessage>Success</HeaderMessage>
<ItemMessages />
Users of low-level languages should be aware of this methodology as it might require a parsing routine to convert the serialized codes. For example the code "<" should be converted to "<".
<?xml version="1.0"?>
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ExtensionData />
<Successful>Y</Successful>
<ResponseCode>9999</ResponseCode>
<HeaderMessage>Success</HeaderMessage>
<ItemMessages />
<ClientTracking>Test Energy</ClientTracking>
<TotalTax>25.864212</TotalTax>
<TransId>2477622</TransId>
<GroupList>
<Group>
<ExtensionData />
<LineNumber>1</LineNumber>
<StateCode>TX|US48085A0003</StateCode>
<InvoiceNumber>101</InvoiceNumber>
<CustomerNumber>80473921</CustomerNumber>
<TaxList>
<Tax>
<ExtensionData />
<TaxTypeCode>101</TaxTypeCode>
<TaxTypeDesc>STATE SALES TAX</TaxTypeDesc>
<TaxAmount>7.220209</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0.062500000000</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>0</FeeRate>
<RevenueBase>115.523344</RevenueBase>
<TaxOnTax>0.970209</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>403</TaxTypeCode>
<TaxTypeDesc>DALLAS MTA</TaxTypeDesc>
<TaxAmount>1.155233</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0.010000000000</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>0</FeeRate>
<RevenueBase>115.523300</RevenueBase>
<TaxOnTax>0.155233</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>304</TaxTypeCode>
<TaxTypeDesc>CITY SALES TAX</TaxTypeDesc>
<TaxAmount>1.155233</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0.010000000000</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>0</FeeRate>
<RevenueBase>115.523300</RevenueBase>
<TaxOnTax>0.155233</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>106</TaxTypeCode>
<TaxTypeDesc>9-1-1 EQUALIZATION FEE</TaxTypeDesc>
<TaxAmount>0.060000</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>0.06000000</FeeRate>
<RevenueBase>100</RevenueBase>
<TaxOnTax>0</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>324</TaxTypeCode>
<TaxTypeDesc>MUNICIPAL RIGHT-OF-WAY FEE</TaxTypeDesc>
<TaxAmount>4.230000</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>4.23000000</FeeRate>
<RevenueBase>100</RevenueBase>
<TaxOnTax>0</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>333</TaxTypeCode>
<TaxTypeDesc>PLANO 9-1-1 FEE</TaxTypeDesc>
<TaxAmount>0.750000</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0</TaxRate>
<PercentTaxable>1.000000</PercentTaxable>
<FeeRate>0.75000000</FeeRate>
<RevenueBase>100</RevenueBase>
<TaxOnTax>0</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>035</TaxTypeCode>
<TaxTypeDesc>FEDERAL UNIVERSAL SERVICE FEE</TaxTypeDesc>
<TaxAmount>10.231877</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0.156000000000</TaxRate>
<PercentTaxable>0.649000</PercentTaxable>
<FeeRate>0</FeeRate>
<RevenueBase>65.588955</RevenueBase>
<TaxOnTax>0.107477</TaxOnTax>
</Tax>
<Tax>
<ExtensionData />
<TaxTypeCode>060</TaxTypeCode>
<TaxTypeDesc>Federal Regulatory Assessment Fee</TaxTypeDesc>
<TaxAmount>1.061660</TaxAmount>
<Revenue>100</Revenue>
<CountyName>COLLIN</CountyName>
<CityName>PLANO</CityName>
<TaxRate>0.014840000000</TaxRate>
<PercentTaxable>0.649000</PercentTaxable>
<FeeRate>0</FeeRate>
<RevenueBase>71.540431</RevenueBase>
<TaxOnTax>0.098544</TaxOnTax>
</Tax>
</TaxList>
</Group>
</GroupList>
</Response>