Sales and Use Tax Basic Version 5.0.0

Transcription

1 Sales and Use Tax Basic Version 5.. WSDL: Product Web Page: e+tax+basic Description: The Sales and Use Tax Basic Web Service provides access to live sales and use tax data using a U.S. ZIP or Canadian postal code. Receive the general sales and use tax and shipping rate levels for the state, county, and city for over 19, U.S. and Canadian tax jurisdictions. Required License Information: The LicenseInfo parameter in our Web services provides the authentication credentials that allow you to invoke the Web service. If you are registered with StrikeIron, use the UserID and Password associated with your StrikeIron account in the UserID and Password fields. Alternatively, you can also use your license key obtained from your StrikeIron Account (leave the password blank). LicenseInfo Field: RegisteredUser Input UserID: Password: License Subscription Information Output LicenseStatusCode: This field returns a numeric code indicating operation from the User ID and Password used for input. Valid license codes are, 1, and 2. For example, a valid User ID and Password returns the code with a corresponding LicenseStatus value of Valid license key. LicenseStatus: This field returns the status of the StrikeIron User ID and Password corresponding to the LicenseStatusCode. LicenseActionCode: This field returns a numeric code indicating operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits. johndoe@strikeiron.com Password1 1 Valid key 8 LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode. RemainingHits: This field returns the number of hits against the StrikeIron license key used when invoking this operation. Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation. Publisher account used, licensing not enforced Available Operations: GetTaxRateUS GetTaxRateCanada GetStatusCodesForMethod (no hits) GetStatusCodes (no hits) Sales and Use Tax Basic v. 5.. page 1

2 GetServiceInfo (no hits) GetRemainingHits (no hits) Operation: GetTaxRateUS Input *ZIPCode: Type the ZIP Code for the area for which you want to get tax data Operation: GetTaxRateUS Output ZIPCode: This field returns the numeric five-digit ZIP Code State: This field returns the state name. County: This field returns the county name. City: This field returns the city name. StateSalesTax: This field returns the state sales tax, numeric to 6 StateUseTax: This field returns the state use tax, numeric to 6 CountySalesTax: This field returns the county sales tax, numeric to 6 CountyUseTax: This field returns the county use tax, numeric to 6 CitySalesTax: This field returns the city sales tax, numeric to 6 decimal places, if applicable for the ZIP Code. CityUseTax: This field returns the city use tax, numeric to 6 decimal places, if applicable for the ZIP Code. TotalSalesTax: This field returns the total sales tax, numeric to 6 TotalUseTax: This field returns the total use tax, numeric to 6 TaxShippingAlone: This field indicates whether shipping is taxable or if shipping and handling is taxable for shipping alone. It assumes that title passes to the customer at the destination point, your invoice clearly lists delivery, shipping, freight, or postage as a separate charge, you ship directly to the purchaser by common carrier, contract carrier, or US mail, and the charge does not exceed your actual cost for delivery to the customer. Values are Y or N. TaxShippingHandling: This field indicates whether shipping is taxable or if shipping and handling is taxable for shipping and handling together. It assumes the item sold is a taxable item and shipping and handling charges are combined as a single line item on the invoice. Values are Y or N. NC DURHAM DURHAM Y Y Operation: GetTaxRateUS Output (ServiceStatus) Sales and Use Tax Basic v. 5.. page 2

3 StatusNbr: This field returns a number referring to the status of this 21 Tax data found for US ZIP Code Operation: GetTaxRateCanada Input *Province: Type the province for the area for which you want to get tax data. The input can be either in the format of the full province name or two-letter abbreviation. ON Operation: GetTaxRateCanada Output Abbreviation: This field returns the two-letter abbreviation for the province. Province: This field returns the province name. ON ONTARIO GST: This field returns the Goods and Services Tax for the province..5 PST: This field returns the Provincial Sales Tax amount for the province. Separate Provincial Sales Taxes are collected in the provinces of British Columbia, Saskatchewan, Manitoba, Ontario, Quebec, and Prince Edward Island. Total: This field returns the total tax for the province. This field is the total of the GST and PST amounts. TaxShippingHandling: This field indicates whether shipping is taxable or if shipping and handling is taxable for shipping and handling together. It assumes the item sold is a taxable item and shipping and handling charges are combined as a single line item on the invoice. Values are Y or N Y Operation: GetTaxRateCanada Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this 22 Tax data found for Canadian province Operation: GetStatusCodesForMethod Input *MethodName: Input a method name to obtain a list of the Status Codes for that method that display in the StatusNbr and StatusDescription fields. Input options are: GetTaxRateUS, GetTaxRateCanadam, GetStatusCodes, and GetServiceInfo. Required. GetTaxRateUS Operation: GetSatusCodesForMethod Output Sales and Use Tax Basic v. 5.. page 3

4 Operation: GetSatusCodesForMethod Output Tax data found for US 21 ZIP Code 31 ZIP Code not Found US ZIP code must be 41 five digits 5 Internal Error Operation: GetStatusCodesForMethod Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this 2 Found Operation: GetStatusCodes Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays a list of the Status Codes for the Web service that display in the StatusNbr and StatusDescription fields. (No input required) Operation: GetStatusCodes Output (MethodStatusRecord) MethodName: GetTaxRateUS 21 Tax data found for US ZIP Code 31 ZIP Code not Found 41 US ZIPcode must be five digits 5 Internal Error MethodName: GetTaxRateCanada 22 Tax data found for Canadian province 32 Canadian Province Not Found 5 Internal Error MethodName: GetStatusCodesForMethod 2 Found 3 Not Found 4 Invalid Method Name 5 Internal Error MethodName: GetStatusCodes 2 Found Sales and Use Tax Basic v. 5.. page 4

5 3 Not Found 5 Internal Error MethodName: GetServiceInfo 2 Found 3 Not Found 5 Internal Error Operation: GetStatusCodes Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this 2 Found Operation: GetServiceInfo Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays the last time the Web service source data was updated. (No input required) Operation: GetServiceInfo Output (ServiceInfoRecord) InfoKey: (For future development) InfoValue: (For future development) (none) (none) Operation: GetServiceInfo Output (ServiceStatus) StatusNbr: This field returns a status number related to the operation. StatusDescription: This field returns a description of the status number. 2 Found Operation: GetRemainingHits Input Note: The only input needed for this operation is the LicenseInfo data. (No input required) Operation: GetRemainingHits Output (SubscriptionInfo) LicenseStatusCode: This field returns a numeric code indicating operation from the User ID and Password used for input. Valid license codes are, 1, and 2. For example, a valid User ID and Password returns the code with a corresponding LicenseStatus value of Valid license key. LicenseStatus: This field returns the status of the StrikeIron User ID Valid license key Sales and Use Tax Basic v. 5.. page 5

6 and Password corresponding to the LicenseStatusCode. LicenseActionCode: This field returns a numeric code indicating operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits. LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode. RemainingHits: This field returns the number of hits against the StrikeIron User ID and Password used when invoking this operation. Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation. Decremented hit count 2 GetRemainingHitsResponse: This field only returns subscription information. Sales and Use Tax Basic v. 5.. page 6