Avatax_TaxService 1.0.11 → 1.0.12

data/lib/template_gettax.erb

@@ -57,7 +57,7 @@
              <ser:RevAcct><%= lin[:revacct] %></ser:RevAcct>
              <ser:Ref1><%= lin[:ref1] %></ser:Ref1>                  
              <ser:Ref2><%= lin[:ref2] %></ser:Ref2>
-             <ser:ExemptionNo><%= lin[:exemptionnoline] %></ser:ExemptionNo>
+             <ser:ExemptionNo><%= lin[:exemptionno] %></ser:ExemptionNo>
              <ser:CustomerUsageType><%= lin[:customerusagetype] %></ser:CustomerUsageType>
              <ser:Description><%= lin[:description] %></ser:Description>
              <ser:TaxOverride>
@@ -67,7 +67,7 @@
                <ser:Reason><%= lin[:reasonline] %></ser:Reason>
              </ser:TaxOverride>
              <ser:TaxIncluded><%= lin[:taxincluded] %></ser:TaxIncluded>
-             <ser:BusinessIdentificationNo><%= lin[:businessidentificationnoline] %></ser:BusinessIdentificationNo>
+             <ser:BusinessIdentificationNo><%= lin[:businessidentificationno] %></ser:BusinessIdentificationNo>
            </ser:Line><% end %>  
           </ser:Lines>
           <ser:DetailLevel><%= @detaillevel %></ser:DetailLevel>

data/samples/CancelTax.rb

@@ -0,0 +1,27 @@
+require 'Avatax_TaxService'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::TaxService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  
+  #Create the request
+  request = {
+    :doccode=>"MyDocCode",   #Required
+    :companycode=>credentials['companycode'],      #Required
+    :doctype=>"SalesInvoice", #Required
+    :cancelcode=>"DocVoided" #Required
+    }
+  #Call the service
+result = svc.canceltax(request)
+#Display the result
+puts "CancelTax ResultCode: "+result[:result_code]
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #Print the first error message returned
+  puts result[:details]
+end

data/samples/GetTax.rb

@@ -0,0 +1,118 @@
+require 'Avatax_TaxService'
+require 'date'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::TaxService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  #Create the request
+  #Document Level Setup  
+  #             R: indicates Required Element
+  #             O: Indicates Optional Element
+  #
+  get_tax_request = {
+    # Set the tax document properties - values are Required unless noted as Optional, but all properties must be defined.
+    
+    :companycode=>credentials['companycode'], # R: Company Code from the accounts Admin Console
+    :doctype=>"SalesInvoice", # R: Typically SalesOrder,SalesInvoice, ReturnInvoice
+    :doccode=>"SampleDoc: " + DateTime.now.to_s, # R: Invoice or document tracking number - Must be unique
+    :docdate=>DateTime.now.strftime("%Y-%m-%d"), # R: Sets reporting date and default tax date
+    :salespersoncode=>"Bill Sales", # O: This is a reportable value that does not affect tax calculation.
+    :customercode=>"TaxSvcTestCust", # R: String - Customer Tracking number or Exemption Customer Code
+    :customerusagetype=>"", # O: Send for tax exempt transactions only.
+    :discount=>".0000", # O: Send for document-level discounts only.
+    :purchaseorderno=>"PO123456", # O: Specifies the purchase order number associated with the transaction. This value can be used to track single-use exemption certficates.
+    :exemptionno=>"",  # O: Send for tax exempt transactions only.
+    :origincode=>"123", # R: Value representing the Origin Address
+    :destinationcode=>"456", # R: Value representing the Destination Address
+    :detaillevel=>"Tax", # R: Chose Summary, Document, Line or Tax - varying levels of results detail 
+    :referencecode=>"", # O: This is a reportable value that does not affect tax calculation.
+    :locationcode=>"", # O: This is a reportable value that does not affect tax calculation.
+    :commit=>"false", # O: Default is "false" - Set to "true" to commit the Document
+      # TaxOverride    O: Allows the TaxDate (or other values) to be overridden for tax calculation. Situational only.  can be added at the document OR line level.
+      #:taxoverridetype=>"TaxDate", 
+      #:taxdate=>"1900-01-01", 
+     # :reason=>"", 
+    :currencycode=>"USD", # O: This is a reportable value that does not affect tax calculation.
+    :servicemode=>"Remote", # O: This is a reportable value that does not affect tax calculation.
+    :paymentdate=>"2013-09-26", # O: This is a reportable value that does not affect tax calculation.
+    :exchangerate=>".0000", # O: This is a reportable value that does not affect tax calculation.
+    :exchangerateeffdate=>"1900-01-01", # O: This is a reportable value that does not affect tax calculation.
+    :poslanecode=>"", # O: This is a reportable value that does not affect tax calculation.
+    :businessidentificationno=>"", # O: Specified VAT ID of customer for international/VAT calculations and reporting.
+    :debug=>true,  # O: If true, transaction logs will be written in the gem root directory.    
+    #   Address Section
+    #   Add the origin and destination addresses referred to by the
+    #   "OriginCode" and "DestinationCode" properties above.
+    :addresses=>[{
+      :addresscode=>"123", 
+      :line1=>"100 ravine lane", 
+      :line2=>"Suite 21", 
+      :city=>"Bainbridge Island", 
+      :region=>"WA", 
+      :postalcode=>"98110", 
+      :country=>"US", 
+      :latitude=>"", 
+      :longitude=>""
+      }, {
+      :addresscode=>"456", 
+      :line1=>"7070 West Arlington Drive", 
+      :city=>"Lakewood", 
+      :region=>"CO", 
+      :postalcode=>"80123", 
+      :country=>"US", 
+      }], 
+    
+    # Add invoice lines
+    :lines=>[{
+      :no=>"1", # R: string - line Number of invoice - must be unique within the document.
+      :itemcode=>"Canoe",  #R: string - SKU or short name of Item
+      :qty=>"1", # R: decimal - The number of items -- Qty of product sold.
+      :amount=>"300.43", # R: decimal - the "NET" amount -- Amount should be the 'extended' or 'net' amount
+      :discounted=>"false", # R: determines if the document-level discount should be applied to this line item.
+      :ref1=>"ref1", # O: This is a reportable value that does not affect tax calculation.
+      :ref2=>"ref2", # O: This is a reportable value that does not affect tax calculation.
+      :description=>"Blue canoe", # O: string - Description or category of item sold.
+            # TaxOverride    O: Allows the TaxDate (or other values) to be overridden for tax calculation. Situational only.
+        :taxoverridetypeline=>"TaxAmount", 
+        :taxamountline=>"10", 
+        :taxdateline=>"1900-01-01", 
+        :reasonline=>"Tax credit", 
+      :taxincluded=>"false" # O: Determines if the line amount on the request includes the tax amount
+      }, {
+      :no=>"2", 
+      :itemcode=>"Rowing boat", 
+      :qty=>"1", 
+      :amount=>"800.12", 
+      :discounted=>"false", 
+      :ref1=>"ref3", 
+      :ref2=>"ref4", 
+      :description=>"Red rowing boat", 
+      :taxincluded=>"false"
+      }]} 
+  
+  #Call the service
+result = svc.gettax(get_tax_request)
+#Display the result
+#puts result
+puts "CalcTax ResultCode: "+result[:result_code]
+#If we encountered an error
+if result[:result_code] != "Success"
+  result[:messages][:message].each do |message|
+    puts message[:summary]+ ": " + message[:details]
+  end
+else
+  puts "DocCode: " + result[:doc_code]+ " Total Tax Calculated: " + result[:total_tax]
+  puts "Jurisdiction Breakdown:"
+  #Show the tax amount calculated at each jurisdictional level
+  result[:tax_lines][:tax_line].each do |line|
+    puts "   "+  "Line Number " + line[:no] + ": Tax: " + line[:tax]
+    #This will display the jurisdiction name and tax at each jurisdiction for the line.
+    line[:tax_details][:tax_detail].each do |key,value| 
+      puts "       " + key.to_s+ ": " + value.to_s
+    end
+  end
+end

data/samples/GetTaxHistory.rb

@@ -0,0 +1,39 @@
+require 'Avatax_TaxService'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::TaxService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  
+  #Create the request
+  request = {
+    :doccode=>"MyDocCode",    #Required
+    :companycode=> credentials['companycode'],      #Required
+    :doctype=>"SalesInvoice", #Required
+    :docid=> "",              #Optional
+    :detaillevel=>"Tax",      #Optional
+    :debug => false           #Optional
+    }
+  #Call the service
+result = svc.gettaxhistory(request)
+#print result
+#Display the result
+puts "GetTaxHistory ResultCode: "+result[:result_code]
+#If we encountered an error
+if result[:result_code] != "Success"
+  puts result[:details]
+else
+  puts "DocCode: " + result[:get_tax_result][:doc_code]+ " Total Tax Calculated: " + result[:get_tax_result][:total_tax].to_s
+  puts "Jurisdiction Breakdown:"
+  #Show the tax amount calculated at each jurisdictional level
+  result[:get_tax_result][:tax_lines][:tax_line].each do |line|
+    puts "   "+ "Line Number " + line[:no] + ": Tax: " + line[:tax]
+    #This will display the jurisdiction name and tax at each jurisdiction for the line.
+    line[:tax_details][:tax_detail].each do |key,value| 
+      puts "       " + key.to_s+ ": " + value.to_s
+    end
+  end
+end

data/samples/Ping.rb

@@ -0,0 +1,24 @@
+require 'Avatax_TaxService'
+require 'Avatax_AddressService'
+require 'yaml'
+#Note that the ping function exists in both the AddressSvc and TaxSvc classes - it works the same way in both.
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::TaxService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+
+  #Call the service
+result = svc.ping
+#print result
+
+#Display the result
+puts "Ping ResultCode: "+result[:result_code]
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #Print the first error message returned
+  puts result[:details]
+end

data/samples/PostTax.rb

@@ -0,0 +1,34 @@
+require 'Avatax_TaxService'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::TaxService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  
+  #Create the request
+  request = {
+    :docid=>"",   #optional
+    :companycode=> credentials['companycode'],      #Required
+    :doctype=>"SalesInvoice", #Required
+    :doccode => "MyDocCode",
+    :docdate => DateTime.now.strftime("%Y-%m-%d"),
+    :totalamount => "1100.5500",
+    :totaltax => "7",
+    :hashcode => "0",
+    :commit => "false",
+    :newdoccode => "MyDocCode"    
+    }
+  #Call the service
+result = svc.posttax(request)
+
+#Display the result
+puts "PostTax ResultCode: "+result[:result_code]
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #Print the first error message returned
+  puts result[:messages][:message][0][:summary]
+end

data/samples/Validate.rb

@@ -0,0 +1,37 @@
+require 'Avatax_AddressService'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::AddressService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  
+  # Create the request
+input = {
+  :line1 => "General Delivery", #Required
+  :line2 => "Suite 100",        #Optional
+  :line3 => "Attn: Accounts Payable", #Optional
+  :city =>"Seattle",            #Required, if PostalCode is not specified
+  :region=>"WA",                #Required, if PostalCode is not specified
+  :postalcode =>"98101",        #Required, if City and Region are not specified
+  :country => "US"              #Optional
+}
+#Call the service
+result = svc.validate(input)
+#Display the result
+#print result
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #puts the first error message returned
+  puts "Address Validation ResultCode: "+result[:result_code]
+  puts result[:details]
+else
+  puts "Validated Address: "
+  result[:valid_addresses][:valid_address].each do |key, value|
+    puts key.to_s + ": " + value.to_s if not value.nil?
+  end
+  
+end

data/samples/credentials.yml

@@ -0,0 +1,5 @@
+username: username
+password: password
+clientname: AvaTaxCalcSOAP Ruby Sample
+production: false
+companycode: APITrialCompany

data/spec/adjusttax_spec.rb

@@ -0,0 +1,235 @@
+require "spec_helper"
+
+describe "AdjustTax" do
+  before :each do
+    credentials = YAML::load(File.open('credentials.yml'))
+    @creds = {:username => credentials['username'], 
+          :password => credentials['password'],  
+          :clientname => credentials['clientname'],
+          :use_production_url => credentials['production']}
+    @svc =  AvaTax::TaxService.new(@creds)
+    @get_tax_request = {
+      :doctype => "SalesInvoice",
+      :commit => false,
+      :detaillevel => "Tax",
+      :docdate=>DateTime.now.strftime("%Y-%m-%d"),
+      :customercode => "CUST123",
+      :origincode => "456",
+      :destinationcode => "456",
+      :addresses=>[{
+        :addresscode=>"456", 
+        :line1=>"7070 West Arlington Drive", 
+        :postalcode=>"80123", 
+        :country=>"US", 
+        }], 
+      :lines=>[{
+        :no=>"1", 
+        :itemcode=>"Canoe", 
+        :qty=>"1",
+        :amount=>"300.43", 
+        :description=>"Blue canoe",
+        }]}
+    @get_tax_result = @svc.gettax(@get_tax_request) 
+    @request_required = {
+      :adjustmentreason => "5",
+      :adjustmentdescription => "Testing Adjustments",
+      :doccode => @get_tax_result[:doc_code],
+      :doctype => "SalesInvoice",
+      :detaillevel => "Tax",
+      :docdate=>DateTime.now.strftime("%Y-%m-%d"),
+      :customercode => "CUST123",
+      :origincode => "456",
+      :destinationcode => "456",
+      :addresses=>[{
+        :addresscode=>"456", 
+        :line1=>"7070 West Arlington Drive", 
+        :postalcode=>"80123", 
+        :country=>"US", 
+        }], 
+      :lines=>[{
+        :no=>"1", 
+        :itemcode=>"Canoe", 
+        :qty=>"1",
+        :amount=>"300.43", 
+        :description=>"Blue canoe",
+        }]
+      
+    }
+    @request_optional = {
+      :companycode => @get_tax_result[:company_code],
+      :salespersoncode => "Bill Sales",
+      :customerusagetype => "L",
+      :discount => "10",
+      :purchaseorderno => "PO9823",
+      :exemptionno => "23423",
+      :referencecode => "ref1",
+      :locationcode => "001",
+      :commit => "false",
+      :batchcode => "",
+      :taxoverridetype => "TaxDate",
+      :taxamount => "0",
+      :taxdate => "1999-01-01",
+      :reason => "Override",
+      :currencycode => "USD",
+      :servicemode => "Remote",
+      :paymentdate => DateTime.now.strftime("%Y-%m-%d"),
+      :exchangerate => "0",
+      :exchangerateeffdate => "1900-01-01",
+      :poslanecode => "1",
+      :businessidentificationno => "2342",
+      :debug => false,
+      :hashcode => "0",
+      :taxoverridetype=>"None", 
+      :taxamount=>".0000", 
+      :taxdate=>"1900-01-01", 
+      :reason=>"", 
+      :addresses=>[{
+        :addresscode=>"123", 
+        :line1=>"100 ravine lane", 
+        :line2=>"Suite 21", 
+        :city=>"Bainbridge Island", 
+        :region=>"WA", 
+        :postalcode=>"98110", 
+        :country=>"US", 
+        :taxregionid=>"0", 
+        :latitude=>"", 
+        :longitude=>""
+        }, {
+        :addresscode=>"456", 
+        :line1=> "Attn. Accounting",
+        :line3=>"7070 West Arlington Drive", 
+        :postalcode=>"80123", 
+        :country=>"US", 
+        :taxregionid=>"0"
+        }],
+        :lines=>[{
+          :no=>"1", 
+          :itemcode=>"Canoe", 
+          :qty=>"1",
+          :amount=>"300.43", 
+          :discounted=>"false", 
+          :ref1=>"ref1", 
+          :ref2=>"ref2", 
+          :description=>"Blue canoe",
+            :taxoverridetypeline=>"TaxAmount", 
+            :taxamountline=>"10", 
+            :taxdateline=>"1900-01-01", 
+            :reasonline=>"Tax credit", 
+          :taxincluded=>"false" 
+          }, {
+          :no=>"2", 
+          :itemcode=>"Rowing boat", 
+          :qty=>"1", 
+          :destinationcodeline=>"123",
+          :amount=>"800.12", 
+          :discounted=>"false", 
+          :ref1=>"ref3", 
+          :ref2=>"ref4", 
+          :description=>"Red rowing boat", 
+          :taxoverridetype=>"None", 
+          :taxamount=>"0", 
+          :taxdate=>"1900-01-01", 
+          :taxincluded=>"true"
+          }]
+    }          
+  end
+  
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.adjusttax(@request_required)[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::TaxService.new(@creds)
+      @service.adjusttax(@request_required)[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.adjusttax(@request_required)[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.adjusttax(@request_required)[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.adjusttax(@request_required)[:result_code].should eql "Success"
+    end   
+  end
+  
+  describe "has consistent formatting for" do
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.adjusttax(@request_required)
+      @result[:result_code].should eql "Error" and @result[:details].should eql "The user or account could not be authenticated."
+    end
+    it "successful results" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.adjusttax(@request_required)
+      @result[:result_code].should eql "Success" and @result[:transaction_id].should_not be_nil
+    end
+  end  
+  describe "requests with" do
+    it "missing required parameters fail" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.adjusttax(@request_optional)
+      @result[:result_code].should eql "Error" 
+    end
+    it "invalid parameters ignore them" do
+      @service = AvaTax::TaxService.new(@creds)
+      @request_required[:bogus] = "data"
+      @result = @service.adjusttax(@request_required)
+      @result[:result_code].should eql "Success" 
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.adjusttax(@request_required)
+      @result[:result_code].should eql "Success" 
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.adjusttax(@request_required.merge(@request_optional))
+      @result[:result_code].should eql "Success" 
+    end
+  end
+  describe "workflow" do
+    it "should adjust committed documents" do      
+      @request_required[:customercode] = "NewCust"
+      @generic_request = { 
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+        :commit => true
+      }
+      @post_result = @svc.posttax(@generic_request)
+      @result = @svc.adjusttax(@request_required)
+      @history_result = @svc.gettaxhistory(@generic_request)
+      @result[:result_code].should eql "Success" and 
+      @history_result[:get_tax_request][:customer_code].should eql @request_required[:customercode] and
+      @history_result[:get_tax_result][:doc_status].should eql "Committed"
+    end
+    it "should adjust uncommitted documents" do
+      @request_required[:customercode] = "NewCust"
+      @generic_request = { 
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+        :commit => false
+      }
+      @post_result = @svc.posttax(@generic_request)
+      @result = @svc.adjusttax(@request_required)
+      @history_result = @svc.gettaxhistory(@generic_request)
+      @result[:result_code].should eql "Success" and 
+      @history_result[:get_tax_request][:customer_code].should eql @request_required[:customercode] and
+      @history_result[:get_tax_result][:doc_status].should eql "Saved"
+    end
+    
+  end
+  
+end