function createStandardRequest($calc, $products, $sign = 1)
{
if (!class_exists('TaxServiceSoap')) {
require VMAVALARA_CLASS_PATH . DS . 'TaxServiceSoap.class.php';
}
if (!class_exists('DocumentType')) {
require VMAVALARA_CLASS_PATH . DS . 'DocumentType.class.php';
}
if (!class_exists('DetailLevel')) {
require VMAVALARA_CLASS_PATH . DS . 'DetailLevel.class.php';
}
if (!class_exists('Line')) {
require VMAVALARA_CLASS_PATH . DS . 'Line.class.php';
}
if (!class_exists('ServiceMode')) {
require VMAVALARA_CLASS_PATH . DS . 'ServiceMode.class.php';
}
if (!class_exists('Line')) {
require VMAVALARA_CLASS_PATH . DS . 'Line.class.php';
}
if (!class_exists('GetTaxRequest')) {
require VMAVALARA_CLASS_PATH . DS . 'GetTaxRequest.class.php';
}
if (!class_exists('GetTaxResult')) {
require VMAVALARA_CLASS_PATH . DS . 'GetTaxResult.class.php';
}
if (!class_exists('Address')) {
require VMAVALARA_CLASS_PATH . DS . 'Address.class.php';
}
if (is_object($calc)) {
$calc = get_object_vars($calc);
}
$request = new GetTaxRequest();
$origin = new Address();
//In Virtuemart we have not differenct warehouses, but we have a shipment address
//So when the vendor has a shipment address, we assume that it is his warehouse
//Later we can combine products with shipment addresses for different warehouse (yehye, future music)
//But for now we just use the BT address
if (!class_exists('VirtueMartModelVendor')) {
require JPATH_VM_ADMINISTRATOR . DS . 'models' . DS . 'vendor.php';
}
$userId = VirtueMartModelVendor::getUserIdByVendorId($calc['virtuemart_vendor_id']);
$userModel = VmModel::getModel('user');
$virtuemart_userinfo_id = $userModel->getBTuserinfo_id($userId);
// this is needed to set the correct user id for the vendor when the user is logged
$userModel->getVendor($calc['virtuemart_vendor_id']);
$vendorFieldsArray = $userModel->getUserInfoInUserFields('mail', 'BT', $virtuemart_userinfo_id, FALSE, TRUE);
$vendorFields = $vendorFieldsArray[$virtuemart_userinfo_id];
$origin->setLine1($vendorFields['fields']['address_1']['value']);
$origin->setLine2($vendorFields['fields']['address_2']['value']);
$origin->setCity($vendorFields['fields']['city']['value']);
$origin->setCountry($vendorFields['fields']['virtuemart_country_id']['country_2_code']);
$origin->setRegion($vendorFields['fields']['virtuemart_state_id']['state_2_code']);
$origin->setPostalCode($vendorFields['fields']['zip']['value']);
$request->setOriginAddress($origin);
//Address
if (isset($this->addresses[0])) {
$destination = $this->addresses[0];
} else {
return FALSE;
}
if (!class_exists('calculationHelper')) {
require JPATH_VM_ADMINISTRATOR . DS . 'helpers' . DS . 'calculationh.php';
}
$calculator = calculationHelper::getInstance();
$request->setCurrencyCode($calculator->_currencyDisplay->_vendorCurrency_code_3);
//CurrencyCode
$request->setDestinationAddress($destination);
//Address
$request->setCompanyCode($calc['company_code']);
// Your Company Code From the Dashboard
$request->setDocDate(date('Y-m-d'));
//date, checked
$request->setCustomerCode(self::$vmadd['customer_number']);
//string Required
if (isset(self::$vmadd['tax_usage_type'])) {
$request->setCustomerUsageType(self::$vmadd['tax_usage_type']);
//string Entity Usage
}
if (isset(self::$vmadd['tax_exemption_number'])) {
$request->setExemptionNo(self::$vmadd['tax_exemption_number']);
//string if not using ECMS which keys on customer code
}
if (isset(self::$vmadd['taxOverride'])) {
$request->setTaxOverride(self::$vmadd['taxOverride']);
avadebug('I set tax override ', self::$vmadd['taxOverride']);
}
$setAllDiscounted = false;
if (isset($products['discountAmount'])) {
if (!empty($products['discountAmount'])) {
//$request->setDiscount($sign * $products['discountAmount'] * (-1)); //decimal
$request->setDiscount($sign * $products['discountAmount']);
//decimal
vmdebug('We sent as discount ' . $request->getDiscount());
$setAllDiscounted = true;
}
unset($products['discountAmount']);
}
$request->setDetailLevel('Tax');
//Summary or Document or Line or Tax or Diagnostic
$lines = array();
$n = 0;
$this->_lineNumbersToCartProductId = array();
foreach ($products as $k => $product) {
$n++;
$this->_lineNumbersToCartProductId[$n] = $k;
$line = new Line();
$line->setNo($n);
//string // line Number of invoice
$line->setItemCode($product['product_sku']);
//string
$line->setDescription($product['product_name']);
//product description, like in cart, atm only the name, todo add customfields
if (!empty($product['categories'])) {
//avadebug('AvaTax setTaxCode Product has categories !',$catNames);
if (!class_exists('TableCategories')) {
require JPATH_VM_ADMINISTRATOR . DS . 'tables' . DS . 'categories.php';
}
$db = JFactory::getDbo();
$catTable = new TableCategories($db);
foreach ($product['categories'] as $cat) {
$catTable->load($cat);
$catslug = $catTable->slug;
if (strpos($catslug, 'avatax-') !== FALSE) {
$taxCode = substr($catslug, 7);
if (!empty($taxCode)) {
$line->setTaxCode($taxCode);
} else {
vmError('AvaTax setTaxCode, category could not be parsed ' . $catslug);
}
break;
}
}
}
//$line->setTaxCode(""); //string
$line->setQty($product['amount']);
//decimal
$line->setAmount($sign * $product['price'] * $product['amount']);
//decimal // TotalAmmount
if ($setAllDiscounted or !empty($product['discount'])) {
$line->setDiscounted(1);
} else {
$line->setDiscounted(0);
}
$line->setRevAcct("");
//string
$line->setRef1("");
//string
$line->setRef2("");
//string
if (isset(self::$vmadd['tax_usage_type'])) {
$line->setCustomerUsageType(self::$vmadd['tax_usage_type']);
//string Entity Usage
}
if (isset(self::$vmadd['tax_exemption_number'])) {
$line->setExemptionNo(self::$vmadd['tax_exemption_number']);
//string if not using ECMS which keys on customer code
}
if (isset(self::$vmadd['taxOverride'])) {
//create new TaxOverride Object set
//$line->setTaxOverride(self::$vmadd['taxOverride']);
}
$lines[] = $line;
}
$this->newATConfig($calc);
$request->setLines($lines);
return $request;
}
/**
* @brief Executes tax actions on documents
*
* @param Array $products Array of Product for which taxes need to be calculated
* @param Array $params
* type : (default SalesOrder) SalesOrder|SalesInvoice|ReturnInvoice
* cart : (required for SalesOrder and SalesInvoice) Cart object
* DocCode : (required in ReturnInvoice, and when 'cart' is not set) Specify the Document Code
*
*/
public function getTax($products = array(), $params = array())
{
$confValues = Configuration::getMultiple(array('AVALARATAX_COMPANY_CODE', 'AVALARATAX_ADDRESS_LINE1', 'AVALARATAX_ADDRESS_LINE2', 'AVALARATAX_CITY', 'AVALARATAX_STATE', 'AVALARATAX_ZIP_CODE'));
if (!isset($params['type'])) {
$params['type'] = 'SalesOrder';
}
$this->_connectToAvalara();
$client = new TaxServiceSoap(Configuration::get('AVALARATAX_MODE'));
$request = new GetTaxRequest();
if (isset($params['cart']) && (int) $params['cart']->{Configuration::get('PS_TAX_ADDRESS_TYPE')}) {
$address = new Address((int) $params['cart']->{Configuration::get('PS_TAX_ADDRESS_TYPE')});
} elseif (isset($this->context->cookie) && isset($this->contract->cookie->id_customer) && $this->context->cookie->id_customer) {
$address = new Address((int) Db::getInstance()->getValue('SELECT `id_address` FROM `' . _DB_PREFIX_ . 'address` WHERE `id_customer` = ' . (int) $this->context->cookie->id_customer . ' AND active = 1 AND deleted = 0'));
}
if (isset($address)) {
if (!empty($address->id_state)) {
$state = new State((int) $address->id_state);
}
$addressDest = array();
$addressDest['Line1'] = $address->address1;
$addressDest['Line2'] = $address->address2;
$addressDest['City'] = $address->city;
$addressDest['Region'] = isset($state) ? $state->iso_code : '';
$addressDest['PostalCode'] = $address->postcode;
$addressDest['Country'] = Country::getIsoById($address->id_country);
// Try to normalize the address depending on option in the BO
if (Configuration::get('AVALARATAX_ADDRESS_NORMALIZATION')) {
$normalizedAddress = $this->validateAddress($address);
}
if (isset($normalizedAddress['Normalized'])) {
$addressDest = $normalizedAddress['Normalized'];
}
// Add Destination address (Customer address)
$destination = new AvalaraAddress();
$destination->setLine1($addressDest['Line1']);
$destination->setLine2($addressDest['Line2']);
$destination->setCity($addressDest['City']);
$destination->setRegion($addressDest['Region']);
$destination->setPostalCode($addressDest['PostalCode']);
$destination->setCountry($addressDest['Country']);
$request->setDestinationAddress($destination);
}
// Origin Address (Store Address or address setup in BO)
$origin = new AvalaraAddress();
$origin->setLine1(isset($confValues['AVALARATAX_ADDRESS_LINE1']) ? $confValues['AVALARATAX_ADDRESS_LINE1'] : '');
$origin->setLine2(isset($confValues['AVALARATAX_ADDRESS_LINE2']) ? $confValues['AVALARATAX_ADDRESS_LINE2'] : '');
$origin->setCity(isset($confValues['AVALARATAX_CITY']) ? $confValues['AVALARATAX_CITY'] : '');
$origin->setRegion(isset($confValues['AVALARATAX_STATE']) ? $confValues['AVALARATAX_STATE'] : '');
$origin->setPostalCode(isset($confValues['AVALARATAX_ZIP_CODE']) ? $confValues['AVALARATAX_ZIP_CODE'] : '');
$request->setOriginAddress($origin);
$request->setCompanyCode(isset($confValues['AVALARATAX_COMPANY_CODE']) ? $confValues['AVALARATAX_COMPANY_CODE'] : '');
$orderId = isset($params['cart']) ? (int) $params['cart']->id : (int) $params['DocCode'];
$nowTime = date('mdHis');
// Type: Only supported types are SalesInvoice or SalesOrder
if ($params['type'] == 'SalesOrder') {
// SalesOrder: Occurs when customer adds product to the cart (generally to check how much the tax will be)
$request->setDocType(DocumentType::$SalesOrder);
} elseif ($params['type'] == 'SalesInvoice') {
$request->setDocType(DocumentType::$SalesInvoice);
$orderId = Db::getInstance()->getValue('SELECT `id_order` FROM ' . _DB_PREFIX_ . 'orders WHERE `id_cart` = ' . (int) $params['cart']->id);
// Make sure we got the orderId, even if it was/wasn't passed in $params['DocCode']
} elseif ($params['type'] == 'ReturnInvoice') {
$orderId = isset($params['type']) && $params['type'] == 'ReturnInvoice' ? $orderId . '.' . $nowTime : $orderId;
$orderDate = Db::getInstance()->ExecuteS('
SELECT `id_order`, `date_add`
FROM `' . _DB_PREFIX_ . 'orders`
WHERE ' . (isset($params['cart']) ? '`id_cart` = ' . (int) $params['cart']->id : '`id_order` = ' . (int) $params['DocCode']));
$request->setDocType(DocumentType::$ReturnInvoice);
$request->setCommit(true);
$taxOverride = new TaxOverride();
$taxOverride->setTaxOverrideType(TaxOverrideType::$TaxDate);
$taxOverride->setTaxDate(date('Y-m-d', strtotime($orderDate[0]['date_add'])));
$taxOverride->setReason('Refund');
$request->setTaxOverride($taxOverride);
}
if (isset($this->context->cookie->id_customer)) {
$customerCode = $this->context->cookie->id_customer;
} else {
if (isset($params['DocCode'])) {
$id_order = (int) $params['DocCode'];
} elseif (isset($_POST['id_order'])) {
$id_order = (int) $_POST['id_order'];
} elseif (isset($params['id_order'])) {
$id_order = (int) $params['id_order'];
} else {
$id_order = 0;
}
$customerCode = (int) Db::getInstance()->getValue('SELECT `id_customer` FROM `' . _DB_PREFIX_ . 'orders` WHERE `id_order` = ' . (int) $id_order);
}
$request->setDocCode('Order ' . Tools::safeOutput($orderId));
// Order Id - has to be float due to the . and more numbers for returns
$request->setDocDate(date('Y-m-d'));
// date
$request->setCustomerCode('CustomerID: ' . (int) $customerCode);
// string Required
$request->setCustomerUsageType('');
// string Entity Usage
$request->setDiscount(0.0);
// decimal
$request->setDetailLevel(DetailLevel::$Tax);
// Summary or Document or Line or Tax or Diagnostic
// Add line
$lines = array();
$i = 0;
foreach ($products as $product) {
// Retrieve the tax_code for the current product if not defined
if (isset($params['taxable']) && !$params['taxable']) {
$taxCode = 'NT';
} else {
$taxCode = !isset($product['tax_code']) ? $this->getProductTaxCode((int) $product['id_product']) : $product['tax_code'];
}
if (isset($product['id_product'])) {
$line = new Line();
$line->setNo($i++);
// string line Number of invoice ($i)
$line->setItemCode((int) $product['id_product'] . ' - ' . substr($product['name'], 0, 20));
$line->setDescription(substr(Tools::safeOutput($product['name'] . ' - ' . $product['description_short']), 0, 250));
$line->setTaxCode($taxCode);
$line->setQty(isset($product['quantity']) ? (double) $product['quantity'] : 1);
$line->setAmount($params['type'] == 'ReturnInvoice' && (double) $product['total'] > 0 ? (double) $product['total'] * -1 : (double) $product['total']);
$line->setDiscounted(false);
$lines[] = $line;
}
}
// Send shipping as new line
if (isset($params['cart'])) {
$line = new Line();
$line->setNo('Shipping');
// string line Number of invoice ($i)
$line->setItemCode('Shipping');
$line->setDescription('Shipping costs');
if (isset($params['taxable']) && !$params['taxable']) {
$line->setTaxCode('NT');
} else {
$line->setTaxCode('FR020100');
}
// Default TaxCode for Shipping. Avalara will decide depending on the State if taxes should be charged or not
$line->setQty(1);
$line->setAmount((double) $params['cart']->getOrderTotal(false, Cart::ONLY_SHIPPING));
$line->setDiscounted(false);
$lines[] = $line;
}
$request->setLines($lines);
$buffer = array();
try {
$result = $client->getTax($request);
$buffer['ResultCode'] = Tools::safeOutput($result->getResultCode());
if ($result->getResultCode() == SeverityLevel::$Success) {
$buffer['DocCode'] = Tools::safeOutput($request->getDocCode());
$buffer['TotalAmount'] = Tools::safeOutput($result->getTotalAmount());
$buffer['TotalTax'] = Tools::safeOutput($result->getTotalTax());
$buffer['NowTime'] = $nowTime;
foreach ($result->getTaxLines() as $ctl) {
$buffer['TaxLines'][$ctl->getNo()]['GetTax'] = Tools::safeOutput($ctl->getTax());
$buffer['TaxLines'][$ctl->getNo()]['TaxCode'] = Tools::safeOutput($ctl->getTaxCode());
foreach ($ctl->getTaxDetails() as $ctd) {
$buffer['TaxLines'][$ctl->getNo()]['TaxDetails']['JurisType'] = Tools::safeOutput($ctd->getJurisType());
$buffer['TaxLines'][$ctl->getNo()]['TaxDetails']['JurisName'] = Tools::safeOutput($ctd->getJurisName());
$buffer['TaxLines'][$ctl->getNo()]['TaxDetails']['Region'] = Tools::safeOutput($ctd->getRegion());
$buffer['TaxLines'][$ctl->getNo()]['TaxDetails']['Rate'] = Tools::safeOutput($ctd->getRate());
$buffer['TaxLines'][$ctl->getNo()]['TaxDetails']['Tax'] = Tools::safeOutput($ctd->getTax());
}
}
} else {
foreach ($result->getMessages() as $msg) {
$buffer['Messages']['Name'] = Tools::safeOutput($msg->getName());
$buffer['Messages']['Summary'] = Tools::safeOutput($msg->getSummary());
}
}
} catch (SoapFault $exception) {
$buffer['Exception']['FaultString'] = Tools::safeOutput($exception->faultstring);
$buffer['Exception']['LastRequest'] = Tools::safeOutput($client->__getLastRequest());
$buffer['Exception']['LastResponse'] = Tools::safeOutput($client->__getLastResponse());
}
return $buffer;
}
