Transaction.calculateSalesTax

1. Taxes are collected according to the buyer’s address. If the shipping address is specified on the Transaction, Subscribe considers that address for tax calculation first. If not, Subscribe uses the billing address on the payment method. In the absence of those two addresses, Subscribe cannot calculate the taxes. For U.S. and Canadian addresses, be sure to provide full address information since taxes vary from state to state and, in many cases, from city to city.
2. Subscribe “cleans up” the address chosen to apply taxes. For example, Subscribe converts SAINT FORT, SAINTE FORT, or STE FORT to ST FORT, discards punctuation marks, and converts dashes to spaces.
3. Subscribe “fixes up” the address in question, by correcting misspelled street or city names, and by applying the correct postal code according to the street address. Subscribe does not change the actual address in the Transaction object; instead, Subscribe stores the corrected address in the Transaction object’s salesTaxAddress data member when returning the object to you. This step enables the Subscribe sales-tax engine to pinpoint the correct final jurisdiction (country, district, county, city, and postal code) to calculate taxes.
4. Subscribe looks in a database for the applicable tax rates for the jurisdiction. That database is continually updated with the latest information.

• Upload overriding tax rules to the Vindicia database. In those rules, you may define a specific tax rate for Subscribe to apply to your transactions if the customer address is in a specific city, county, state, or other location. You may also specify a date range for applying those tax rules. For more information, contact your Vindicia Client Services representative.
• Specify your tax nexus. In the United States, your tax nexus is the set of local and state governments that may collect sales tax on your transactions. This nexus depends on the physical location of your business registration. For example, if your company is registered only in California, only the State of California may collect sales tax on your transactions, and Subscribe applies sales tax only if your customer’s address is also in California. Contact your Vindicia Client Services representative for more information.
• Define the tax exemptions on your customer accounts. See the taxExemptions attribute in The Account Object.
• Define the tax classification on your Product and TransactionItem objects. The tax classification enables you to specify the categories, such as physical goods and electronic data, to which your sales items belong. If your nexus specifies that an item is taxable, Subscribe applies sales tax accordingly. See the taxClassification attribute in The Product Object, and in the TransactionItem Subobject.

​

Input

​

Output

​

Returns

​

Example

$tx = new Transaction();
$tx->setAmount('29.90');
$tx->setCurrency('USD');
$tx->setMerchantTransactionId('txid-123456');

$tx->setSourceIp('35.45.123.158');

$account = new Account();
$account->setMerchantAccountId('9876-5432');
$account->setEmailAddress('jdoe@mail.com');
$account->setName('J Doe');
$tx->setAccount($account);

$shippingAddress = new Address();
$shippingAddress->setName('Jane Doe');
$shippingAddress->setAddr1('44 Elm St.');
$shippingAddress->setCity('San Mateo');
$shippingAddress->setDistrict('CA');
$shippingAddress->setPostalCode('94403');
$shippingAddress->setCountry('US');

$tx->setShippingAddress($shippingAddress);

// The line items of the transaction
$tx_item = new TransactionItem();
$tx_item->setSku('sku-1234');
$tx_item->setName('Widget');
$tx_item->setPrice('3.30');
$tx_item->setQuantity('3');
$tx->setTransactionItems(array($tx_item));

$paymentMethod = new PaymentMethod();
$ccCard = new CreditCard();
$ccCard->setAccount('4111111111111111');
$ccCard->setExpirationDate('201109');
$paymentMethod->setType('CreditCard');
$paymentMethod->setCreditCard($ccCard);
$paymentMethod->setBillingAddress($shippingAddress);

$tx->setSourcePaymentMethod($paymentMethod); 

$response = $tx->calculateSalesTax();
if ($response['returnCode'] == 200) { 
   print "Address type used for computing tax: ";
   print $response['addressType'] . "\n";
   print "Taxes added: \n";
   $taxes = $response['taxItems'];
   foreach($taxes as $tax) {
      print $tax->getDescription() . " : " ;
      print $tax->getTax() . "\n";
   }
   print "Total tax: " . $response['totalTax'];
   print "Total transaction amount: " ;
   print $response['transaction']->getAmount() . "\n";
}