/**
* Creates a Suretax request from inputs from the invoice.
*
* @param invoice Invoice for which tax lines need to be calculated.
* @return Returns instance of com.sapienter.jbilling.client.suretax.request.SuretaxRequest
* @throws TaskException
*/
private SuretaxRequest getAssembledRequest(NewInvoiceContext invoice, Integer userId)
throws TaskException {
// Construct a suretax request to get the tax lines.
SuretaxRequest suretaxRequest = new SuretaxRequest();
// Get the pluggable task parameters here.
String clientNumber = getParameter(CLIENT_NUMBER, "");
String validationKey = getParameter(VALIDATION_KEY, "");
String responseGroup = getParameter(RESPONSE_GROUP, "03");
String responseType = getParameter(RESPONSE_TYPE, "D");
String numberOfDecimals = getParameter(NUMBER_OF_DECIMAL, "2");
Integer dataYear = null;
Integer dataMonth = null;
try {
dataYear = getParameter(DATA_YEAR, Calendar.getInstance().get(Calendar.YEAR));
dataMonth = getParameter(DATA_MONTH, Calendar.getInstance().get(Calendar.MONTH) + 1);
} catch (PluggableTaskException e) {
LOG.debug("Exception while retrieving Data Year or Data Month");
}
suretaxRequest.setClientNumber(clientNumber);
suretaxRequest.setValidationKey(validationKey);
String uniqueTrackingCode = System.currentTimeMillis() + "";
suretaxRequest.setClientTracking(uniqueTrackingCode);
suretaxRequest.setDataMonth(dataMonth.toString());
suretaxRequest.setDataYear(dataYear.toString());
suretaxRequest.setIndustryExemption("");
suretaxRequest.setBusinessUnit("");
suretaxRequest.setResponseGroup(responseGroup);
suretaxRequest.setResponseType(responseType + numberOfDecimals);
suretaxRequest.setReturnFileCode("0");
suretaxRequest.setTotalRevenue(getTotalRevenue(invoice).floatValue());
List<LineItem> itemList = new ArrayList<LineItem>();
for (InvoiceLineDTO invoiceLine : (List<InvoiceLineDTO>) invoice.getResultLines()) {
if (invoiceLine.getInvoiceLineType().getId()
!= ServerConstants.INVOICE_LINE_TYPE_TAX.intValue()) {
LOG.debug("Populating itemlist for invoice line: %s", invoiceLine);
itemList.add(
getLineItem(invoiceLine.getItem().getId(), invoiceLine, uniqueTrackingCode, userId));
}
}
suretaxRequest.setItemList(itemList);
return suretaxRequest;
}
protected BigDecimal getTotalRevenue(NewInvoiceContext invoice) {
// calculate TOTAL to include result lines
invoice.calculateTotal();
BigDecimal invoiceAmountSum = invoice.getTotal();
// Remove CARRIED BALANCE from tax calculation to avoid double taxation
LOG.debug("Carried balance is %s", invoice.getCarriedBalance());
if (null != invoice.getCarriedBalance()) {
invoiceAmountSum = invoiceAmountSum.subtract(invoice.getCarriedBalance());
}
// Remove TAX ITEMS from Invoice to avoid calculating tax on tax
for (int i = 0; i < invoice.getResultLines().size(); i++) {
InvoiceLineDTO invoiceLine = (InvoiceLineDTO) invoice.getResultLines().get(i);
if (null != invoiceLine.getInvoiceLineType()
&& invoiceLine.getInvoiceLineType().getId() == ServerConstants.INVOICE_LINE_TYPE_TAX) {
invoiceAmountSum = invoiceAmountSum.subtract(invoiceLine.getAmount());
}
}
return invoiceAmountSum;
}
/** This method is called for populating of the tax lines from the Suretax tax engine. */
@Override
public void apply(NewInvoiceContext invoice, Integer userId) throws TaskException {
this.invoice = invoice;
// Defaults to rolling back of invoice creation on error.
boolean rollback_invoice_on_suretax_error = true;
try {
rollback_invoice_on_suretax_error = getParameter(ROLLBACK_INVOICE_ON_ERROR, 1) == 1;
} catch (PluggableTaskException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
SuretaxResponse response = null;
SuretaxRequest suretaxRequest = null;
boolean errorOccurred = false;
try {
suretaxRequest = getAssembledRequest(invoice, userId);
// Save the suretax json request in the sure_tax_txn_log table
String jsonRequestString = mapper.writeValueAsString(suretaxRequest);
suretaxTransactionLogDAS.save(
new SuretaxTransactionLogDTO(
suretaxRequest.clientTracking,
"REQUEST",
jsonRequestString,
new Timestamp(System.currentTimeMillis()),
null,
"TAX"));
String suretaxRequestUrl = getParameter(SURETAX_REQUEST_URL, "");
response = new SuretaxClient().getResponse(suretaxRequest, suretaxRequestUrl);
} catch (Exception e) {
if (rollback_invoice_on_suretax_error) throw new TaskException(e);
else errorOccurred = true;
}
// If the control has come here but an error had occurred then
// the error was meant to be ignored. So, if an error had occurred
// then just ignore the next block of code. That is exit gracefully
if (!errorOccurred) {
// Save the suretax json response in the sure_tax_txn_log table
int transId = -1;
try {
transId = Integer.parseInt(response.transId);
} catch (Exception e) {
// TODO: handle exception
}
suretaxTransactionLogDAS.save(
new SuretaxTransactionLogDTO(
suretaxRequest.clientTracking,
"RESPONSE",
response.jsonString,
new Timestamp(System.currentTimeMillis()),
transId,
"TAX"));
if (response != null && !response.successful.equals("Y")) {
if (rollback_invoice_on_suretax_error) {
throw new TaskException(
"Error while obtaining the tax lines for this invoice:"
+ response.responseCode
+ ":"
+ response.headerMessage);
}
} else if (response != null
&& response.successful.equals("Y")
&& response.headerMessage.contains("Success with Item errors")) {
StringBuffer errorMessages = new StringBuffer("Error messages:[");
int count = 0;
for (ItemMessage itemMessage : response.itemMessages) {
if (count == 0) {
count++;
} else {
errorMessages.append(",");
}
errorMessages.append(itemMessage.message);
}
errorMessages.append("]");
if (rollback_invoice_on_suretax_error) {
throw new TaskException(
"Error while obtaining the tax lines for this invoice:" + errorMessages.toString());
}
} else {
LOG.debug(
"Response Code: %s, Header Message: %s, Client Tracking: %s, Total tax: %s, Trans Id: %s",
response.responseCode,
response.headerMessage,
response.clientTracking,
response.totalTax,
response.transId);
OrderDTO order = ((InvoiceLineDTO) invoice.getResultLines().get(0)).getOrder();
List<InvoiceLineDTO> taxLines = getTaxLines(response, order);
for (InvoiceLineDTO taxLine : taxLines) {
invoice.addResultLine(taxLine);
}
// Add the trans id in the invoice
MetaFieldHelper.setMetaField(
invoice.getEntityId(), invoice, SURETAX_TRANS_ID_META_FIELD_NAME, transId);
}
}
}
private LineItem getLineItem(
Integer itemId, InvoiceLineDTO invoiceLine, String uniqueTrackingCode, Integer userId)
throws TaskException {
// Get the meta field names
String secondaryZipCodeExtensionFieldname =
getParameter(SECONDARY_ZIP_CODE_EXTN_FIELDNAME, "Secondary Zip code extension");
String secondaryZipCodeFieldname =
getParameter(SECONDARY_ZIP_CODE_FIELDNAME, "Secondary Zip code");
String billingZipCodeFieldname =
getParameter(BILLING_ZIP_CODE_FIELDNAME, "Billing Zip code extension");
String regulatoryCodeFieldname = getParameter(REGULATORY_CODE_FIELDNAME, "Regulatory Code");
String salesTypeCodeFieldname = getParameter(SALES_TYPE_CODE_FIELDNAME, "Sales Type Code");
String taxExemptionCodeFieldname =
getParameter(TAX_EXEMPTION_CODE_FIELDNAME, "Tax exemption code");
String transactionTypeCodeFieldname =
getParameter(TRANSACTION_TYPE_CODE_FIELDNAME, "Transaction Type Code");
LineItem lineItem = new LineItem();
lineItem.setBillToNumber(""); // TODO: need to be addressed ?
String customerNumber = null;
List<NewInvoiceContext.OrderContext> orders = invoice.getOrders();
// We need to get the fresh item from the database because
// the item in the invoiceLine doesn't yet contain meta fields.
ItemDTO item = new ItemDAS().find(itemId);
OrderDTO orderDTO = null;
UserDTO invoiceToUser = null;
for (NewInvoiceContext.OrderContext orderCtx : orders) {
if (orderCtx.order.getId().intValue() == invoiceLine.getOrder().getId()) {
orderDTO = orderCtx.order;
break;
}
}
if (null == orderDTO) {
orderDTO = orders.get(0).order;
}
invoiceToUser = new UserDAS().find(userId);
customerNumber = invoiceToUser.getCustomer().getId() + "";
lineItem.setCustomerNumber(customerNumber);
lineItem.setInvoiceNumber("JB" + uniqueTrackingCode);
lineItem.setLineNumber(""); // TODO: need to be addressed ?
lineItem.setOrigNumber(""); // TODO: need to be addressed ?
MetaFieldValue<String> p2PPlus4 =
invoiceToUser.getCustomer().getMetaField(secondaryZipCodeExtensionFieldname);
if (p2PPlus4 != null) {
lineItem.setP2PPlus4(p2PPlus4.getValue());
} else {
lineItem.setP2PPlus4("");
}
MetaFieldValue<String> p2PZipcode =
invoiceToUser.getCustomer().getMetaField(secondaryZipCodeFieldname);
if (p2PZipcode != null) {
lineItem.setP2PZipcode(p2PZipcode.getValue());
} else {
lineItem.setP2PZipcode("");
}
MetaFieldValue<String> plus4 =
invoiceToUser.getCustomer().getMetaField(billingZipCodeFieldname);
if (plus4 != null) {
lineItem.setPlus4(plus4.getValue());
} else {
lineItem.setPlus4("");
}
LOG.debug("Meta fields: p2PPlus4: %s, p2PZipcode: %s, plus4:%s", p2PPlus4, p2PZipcode, plus4);
MetaFieldValue<String> regulatoryCode = null;
regulatoryCode = item.getMetaField(regulatoryCodeFieldname);
if (regulatoryCode == null
|| regulatoryCode.getValue() == null
|| regulatoryCode.getValue().isEmpty()) {
lineItem.setRegulatoryCode("00");
} else {
lineItem.setRegulatoryCode(regulatoryCode.getValue());
}
lineItem.setRevenue(invoiceLine.getAmount().floatValue());
MetaFieldValue<String> salesTypeCode = orderDTO.getMetaField(salesTypeCodeFieldname);
if (salesTypeCode == null
|| salesTypeCode.getValue() == null
|| salesTypeCode.getValue().isEmpty()) {
lineItem.setSalesTypeCode("R");
} else {
lineItem.setSalesTypeCode(salesTypeCode.getValue());
}
lineItem.setSeconds(
invoiceLine.getQuantity() != null ? invoiceLine.getQuantity().intValue() : 0);
List<String> taxExemptionCodeList = new ArrayList<String>();
// First get the tax exemption code from the customer
MetaFieldValue<String> taxExemptionCode =
invoiceToUser.getCustomer().getMetaField(taxExemptionCodeFieldname);
LOG.debug("Tax exemption code from customer: %s", taxExemptionCode);
if (!(taxExemptionCode != null
&& taxExemptionCode.getValue() != null
&& !taxExemptionCode.getValue().isEmpty())) {
taxExemptionCode = item.getMetaField(taxExemptionCodeFieldname);
LOG.debug("Tax exemption code from product: %s", taxExemptionCode);
}
if (taxExemptionCode == null) {
LOG.debug("Setting tax exemption code to be 00");
taxExemptionCodeList.add("00");
} else {
taxExemptionCodeList.add(taxExemptionCode.getValue());
}
LOG.debug(
"Meta fields: regulatoryCode: %s, salesTypeCode: %s, taxExemptionCode: %s",
regulatoryCode, salesTypeCode, taxExemptionCode);
lineItem.setTaxExemptionCodeList(taxExemptionCodeList);
lineItem.setTaxIncludedCode("0");
lineItem.setTermNumber("");
// TODO: Need to check if trans date will be current date or based on data year and data month ?
lineItem.setTransDate("07-10-2012");
MetaFieldValue<String> transTypeCode = null;
transTypeCode = item.getMetaField(transactionTypeCodeFieldname);
if (transTypeCode == null
|| transTypeCode.getValue() == null
|| transTypeCode.getValue().isEmpty()) {
throw new SessionInternalError(
"No valid transaction type code found on the product",
new String[] {"ItemDTOEx,transTypeCode,no.valid.transactionTypeCode.on.product"});
}
lineItem.setTransTypeCode(transTypeCode.getValue());
lineItem.setUnits(invoiceLine.getQuantity() != null ? invoiceLine.getQuantity().intValue() : 0);
lineItem.setUnitType("00");
if (invoiceToUser.getContact().getPostalCode() != null
&& plus4 != null
&& plus4.getValue() != null
&& !plus4.getValue().isEmpty()) {
lineItem.setZipcode(invoiceToUser.getContact().getPostalCode());
lineItem.setTaxSitusRule("05");
} else if (invoiceToUser.getContact().getPostalCode() != null
&& (plus4 == null || plus4.getValue() == null || plus4.getValue().isEmpty())) {
lineItem.setZipcode(invoiceToUser.getContact().getPostalCode());
lineItem.setPlus4("0000");
lineItem.setTaxSitusRule("05");
}
return lineItem;
}
