/****************************************************************************** * Product: Adempiere ERP & CRM Smart Business Solution * * Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved. * * This program is free software; you can redistribute it and/or modify it * * under the terms version 2 of the GNU General Public License as published * * by the Free Software Foundation. This program is distributed in the hope * * that it will be useful, but WITHOUT ANY WARRANTY; without even the implied * * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * * with this program; if not, write to the Free Software Foundation, Inc., * * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. * * For the text or an alternative of this public license, you may reach us * * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA * * or via info@compiere.org or http://www.compiere.org/license.html * *****************************************************************************/ package org.compiere.model; import java.io.File; import java.math.BigDecimal; import java.math.RoundingMode; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Timestamp; import java.util.ArrayList; import java.util.Arrays; import java.util.Hashtable; import java.util.List; import java.util.Properties; import java.util.Vector; import java.util.logging.Level; import org.adempiere.base.Core; import org.adempiere.base.CreditStatus; import org.adempiere.base.ICreditManager; import org.adempiere.exceptions.AdempiereException; import org.adempiere.exceptions.BPartnerNoAddressException; import org.adempiere.exceptions.DBException; import org.adempiere.exceptions.PeriodClosedException; import org.adempiere.model.ITaxProvider; import org.compiere.print.MPrintFormat; import org.compiere.print.ReportEngine; import org.compiere.process.DocAction; import org.compiere.process.DocumentEngine; import org.compiere.process.IDocsPostProcess; import org.compiere.process.ProcessInfo; import org.compiere.process.ServerProcessCtl; import org.compiere.util.CLogger; import org.compiere.util.DB; import org.compiere.util.Env; import org.compiere.util.KeyNamePair; import org.compiere.util.Msg; import org.compiere.util.TimeUtil; import org.compiere.util.Util; import org.eevolution.model.MPPProductBOM; import org.eevolution.model.MPPProductBOMLine; /** *

 *	Invoice Model.
 * 	Please do not set DocStatus and C_DocType_ID directly.
 * 	They are set in the process() method.
 * 	Use DocAction and C_DocTypeTarget_ID instead.
 *

* @author Jorg Janke * @version $Id: MInvoice.java,v 1.2 2006/07/30 00:51:02 jjanke Exp $ * @author victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com * @see https://sourceforge.net/p/adempiere/feature-requests/412/ *

FR [ 2520591 ] Support multiples calendar for Org * @see https://sourceforge.net/p/adempiere/feature-requests/631/ * Modifications: Added RMA functionality (Ashley Ramdass) * Modifications: Generate DocNo^ instead of using a new number when an invoice is reversed (Diego Ruiz-globalqss) */ public class MInvoice extends X_C_Invoice implements DocAction, IDocsPostProcess { /** * generated serial id */ private static final long serialVersionUID = 9166700544471146864L; public static final String MATCH_TO_RECEIPT_SQL = """ SELECT hdr.C_Invoice_ID, hdr.DocumentNo, hdr.DateInvoiced, bp.Name, hdr.C_BPartner_ID, lin.Line, lin.C_InvoiceLine_ID, p.Name, lin.M_Product_ID, CASE WHEN dt.DocBaseType='APC' THEN lin.QtyInvoiced * -1 ELSE lin.QtyInvoiced END,SUM(NVL(mi.Qty,0)), org.Name, hdr.AD_Org_ID FROM C_Invoice hdr INNER JOIN AD_Org org ON (hdr.AD_Org_ID=org.AD_Org_ID) INNER JOIN C_BPartner bp ON (hdr.C_BPartner_ID=bp.C_BPartner_ID) INNER JOIN C_InvoiceLine lin ON (hdr.C_Invoice_ID=lin.C_Invoice_ID) INNER JOIN M_Product p ON (lin.M_Product_ID=p.M_Product_ID) INNER JOIN C_DocType dt ON (hdr.C_DocType_ID=dt.C_DocType_ID AND dt.DocBaseType IN ('API','APC')) FULL JOIN M_MatchInv mi ON (lin.C_InvoiceLine_ID=mi.C_InvoiceLine_ID) WHERE hdr.DocStatus IN ('CO','CL') """; /** Matching to Receipt Group By Template */ private static final String BASE_MATCHING_GROUP_BY_SQL = """ GROUP BY hdr.C_Invoice_ID,hdr.DocumentNo,hdr.DateInvoiced,bp.Name,hdr.C_BPartner_ID, lin.Line,lin.C_InvoiceLine_ID,p.Name,lin.M_Product_ID,dt.DocBaseType,lin.QtyInvoiced, org.Name, hdr.AD_Org_ID, dt.DocBaseType HAVING %s <> SUM(NVL(mi.Qty,0)) """; public static final String NOT_FULLY_MATCHED_TO_RECEIPT_GROUP_BY = BASE_MATCHING_GROUP_BY_SQL .formatted("CASE WHEN dt.DocBaseType='APC' THEN lin.QtyInvoiced * -1 ELSE lin.QtyInvoiced END"); public static final String FULL_OR_PARTIALLY_MATCHED_TO_RECEIPT_GROUP_BY = BASE_MATCHING_GROUP_BY_SQL.formatted("0"); /** * @param C_BPartner_ID * @param M_Product_ID * @param M_InOutLine_ID * @param from * @param to * @param trxName * @return list of invoices not fully matched to receipt */ public static List getNotFullyMatchedToReceipt(int C_BPartner_ID, int M_Product_ID, int M_InOutLine_ID, Timestamp from, Timestamp to, String trxName) { StringBuilder builder = new StringBuilder(MATCH_TO_RECEIPT_SQL); if (M_InOutLine_ID > 0) { builder.append(" AND mi.M_InOutLine_ID = ").append(M_InOutLine_ID); } if (M_Product_ID > 0) { builder.append(" AND lin.M_Product_ID=").append(M_Product_ID); } if (C_BPartner_ID > 0) { builder.append(" AND hdr.C_BPartner_ID=").append(C_BPartner_ID); } if (from != null) { builder.append(" AND ").append("hdr.DateInvoiced").append(" >= ").append(DB.TO_DATE(from)); } if (to != null) { builder.append(" AND ").append("hdr.DateInvoiced").append(" <= ").append(DB.TO_DATE(to)); } String sql = MRole.getDefault().addAccessSQL( builder.toString(), "hdr", MRole.SQL_FULLYQUALIFIED, MRole.SQL_RO) + NOT_FULLY_MATCHED_TO_RECEIPT_GROUP_BY; List records = new ArrayList<>(); try (PreparedStatement stmt = DB.prepareStatement(sql, trxName)) { ResultSet rs = stmt.executeQuery(); while (rs.next()) { MatchingRecord matchingRecord = new MatchingRecord(rs.getInt(1), rs.getString(2), rs.getTimestamp(3), rs.getString(4), rs.getInt(5), rs.getInt(6), rs.getInt(7), rs.getString(8), rs.getInt(9), rs.getBigDecimal(10), rs.getBigDecimal(11), rs.getString(12), rs.getInt(13)); records.add(matchingRecord); } } catch (SQLException e) { throw new DBException(e.getMessage(), e); } return records; } /** * @param C_BPartner_ID * @param M_Product_ID * @param M_InOutLine_ID * @param from * @param to * @param trxName * @return list of invoices full or partially match to receipt */ public static List getFullOrPartiallyMatchedToReceipt(int C_BPartner_ID, int M_Product_ID, int M_InOutLine_ID, Timestamp from, Timestamp to, String trxName) { StringBuilder builder = new StringBuilder(MATCH_TO_RECEIPT_SQL); if (M_InOutLine_ID > 0) { builder.append(" AND mi.M_InOutLine_ID = ").append(M_InOutLine_ID); } if (M_Product_ID > 0) { builder.append(" AND lin.M_Product_ID=").append(M_Product_ID); } if (C_BPartner_ID > 0) { builder.append(" AND hdr.C_BPartner_ID=").append(C_BPartner_ID); } if (from != null) { builder.append(" AND ").append("hdr.DateInvoiced").append(" >= ").append(DB.TO_DATE(from)); } if (to != null) { builder.append(" AND ").append("hdr.DateInvoiced").append(" <= ").append(DB.TO_DATE(to)); } String sql = MRole.getDefault().addAccessSQL( builder.toString(), "hdr", MRole.SQL_FULLYQUALIFIED, MRole.SQL_RO) + FULL_OR_PARTIALLY_MATCHED_TO_RECEIPT_GROUP_BY; List records = new ArrayList<>(); try (PreparedStatement stmt = DB.prepareStatement(sql, trxName)) { ResultSet rs = stmt.executeQuery(); while (rs.next()) { MatchingRecord matchingRecord = new MatchingRecord(rs.getInt(1), rs.getString(2), rs.getTimestamp(3), rs.getString(4), rs.getInt(5), rs.getInt(6), rs.getInt(7), rs.getString(8), rs.getInt(9), rs.getBigDecimal(10), rs.getBigDecimal(11), rs.getString(12), rs.getInt(13)); records.add(matchingRecord); } } catch (SQLException e) { throw new DBException(e.getMessage(), e); } return records; } /** * record for matchings */ public static record MatchingRecord(int C_Invoice_ID, String documentNo, Timestamp documentDate, String businessPartnerName, int C_BPartner_ID, int line, int C_InvoiceLine_ID, String productName, int M_Product_ID, BigDecimal qtyInvoiced, BigDecimal matchedQty, String organizationName, int AD_Org_ID) {} /** * Get invoices Of BPartner * @param ctx context * @param C_BPartner_ID id * @param trxName transaction * @return array of invoice */ public static MInvoice[] getOfBPartner (Properties ctx, int C_BPartner_ID, String trxName) { List list = new Query(ctx, Table_Name, COLUMNNAME_C_BPartner_ID+"=?", trxName) .setParameters(C_BPartner_ID) .list(); return list.toArray(new MInvoice[list.size()]); } // getOfBPartner /** * Create new Invoice by copying * @param from invoice * @param dateDoc date of the document date * @param dateAcct original account date * @param C_DocTypeTarget_ID target doc type * @param isSOTrx sales order * @param counter create counter links * @param trxName trx * @param setOrder set Order links * @return Invoice */ public static MInvoice copyFrom (MInvoice from, Timestamp dateDoc, Timestamp dateAcct, int C_DocTypeTarget_ID, boolean isSOTrx, boolean counter, String trxName, boolean setOrder) { return copyFrom (from, dateDoc, dateAcct, C_DocTypeTarget_ID, isSOTrx, counter, trxName, setOrder,null); } /** * Create new Invoice by copying * @param from invoice * @param dateDoc date of the document date * @param dateAcct original account date * @param C_DocTypeTarget_ID target doc type * @param isSOTrx sales order * @param counter create counter links * @param trxName trx * @param setOrder set Order links * @param documentNo Document Number for reversed invoices * @return Invoice */ public static MInvoice copyFrom (MInvoice from, Timestamp dateDoc, Timestamp dateAcct, int C_DocTypeTarget_ID, boolean isSOTrx, boolean counter, String trxName, boolean setOrder, String documentNo) { MInvoice to = new MInvoice (from.getCtx(), 0, trxName); PO.copyValues (from, to, from.getAD_Client_ID(), from.getAD_Org_ID()); to.set_ValueNoCheck ("C_Invoice_ID", I_ZERO); to.set_ValueNoCheck ("DocumentNo", documentNo); // to.setDocStatus (DOCSTATUS_Drafted); // Draft to.setDocAction(DOCACTION_Complete); // to.setC_DocType_ID(0); to.setC_DocTypeTarget_ID (C_DocTypeTarget_ID); to.setIsSOTrx(isSOTrx); // to.setDateInvoiced (dateDoc); to.setDateAcct (dateAcct); to.setDatePrinted(null); to.setIsPrinted (false); // to.setIsApproved (false); to.setC_Payment_ID(0); to.setC_CashLine_ID(0); to.setIsPaid (false); to.setIsInDispute(false); // // Amounts are updated by trigger when adding lines to.setGrandTotal(Env.ZERO); to.setTotalLines(Env.ZERO); // to.setIsTransferred (false); to.setPosted (false); to.setProcessed (false); //[ 1633721 ] Reverse Documents- Processing=Y to.setProcessing(false); // delete references to.setIsSelfService(false); if (!setOrder) to.setC_Order_ID(0); if (counter) { to.setRef_Invoice_ID(from.getC_Invoice_ID()); MOrg org = MOrg.get(from.getAD_Org_ID()); int counterC_BPartner_ID = org.getLinkedC_BPartner_ID(trxName); if (counterC_BPartner_ID == 0) return null; to.setBPartner(MBPartner.get(from.getCtx(), counterC_BPartner_ID)); // Try to find Order link if (from.getC_Order_ID() != 0) { MOrder peer = new MOrder (from.getCtx(), from.getC_Order_ID(), from.get_TrxName()); if (peer.getRef_Order_ID() != 0) to.setC_Order_ID(peer.getRef_Order_ID()); } // Try to find RMA link if (from.getM_RMA_ID() != 0) { MRMA peer = new MRMA (from.getCtx(), from.getM_RMA_ID(), from.get_TrxName()); if (peer.getRef_RMA_ID() > 0) to.setM_RMA_ID(peer.getRef_RMA_ID()); } // } else to.setRef_Invoice_ID(0); to.saveEx(trxName); if (counter) from.setRef_Invoice_ID(to.getC_Invoice_ID()); // Lines if (to.copyLinesFrom(from, counter, setOrder) == 0) throw new IllegalStateException("Could not create Invoice Lines"); return to; } /** * @deprecated * Create new Invoice by copying * @param from invoice * @param dateDoc date of the document date * @param C_DocTypeTarget_ID target doc type * @param isSOTrx sales order * @param counter create counter links * @param trxName trx * @param setOrder set Order links * @return Invoice */ @Deprecated public static MInvoice copyFrom (MInvoice from, Timestamp dateDoc, int C_DocTypeTarget_ID, boolean isSOTrx, boolean counter, String trxName, boolean setOrder) { MInvoice to = copyFrom ( from, dateDoc, dateDoc, C_DocTypeTarget_ID, isSOTrx, counter, trxName, setOrder); return to; } // copyFrom /** * Get PDF File Name * @param documentDir directory * @param C_Invoice_ID invoice * @return file name */ public static String getPDFFileName (String documentDir, int C_Invoice_ID) { StringBuilder sb = new StringBuilder (documentDir); if (sb.length() == 0) sb.append("."); if (!sb.toString().endsWith(File.separator)) sb.append(File.separator); sb.append("C_Invoice_ID_") .append(C_Invoice_ID) .append(".pdf"); return sb.toString(); } // getPDFFileName /** * Get MInvoice from DB * @param C_Invoice_ID id * @return MInvoice */ public static MInvoice get (int C_Invoice_ID) { return get(Env.getCtx(), C_Invoice_ID); } /** * Get MInvoice from DB * @param C_Invoice_ID id * @return MInvoice */ public static MInvoice get (Properties ctx, int C_Invoice_ID) { MInvoice retValue = new MInvoice(ctx, C_Invoice_ID, (String)null); if (retValue.get_ID () == C_Invoice_ID) { return retValue; } return null; } // get /** * UUID based Constructor * @param ctx Context * @param C_Invoice_UU UUID key * @param trxName Transaction */ public MInvoice(Properties ctx, String C_Invoice_UU, String trxName) { super(ctx, C_Invoice_UU, trxName); if (Util.isEmpty(C_Invoice_UU)) setInitialDefaults(); } /** * Invoice Constructor * @param ctx context * @param C_Invoice_ID invoice or 0 for new * @param trxName trx name */ public MInvoice (Properties ctx, int C_Invoice_ID, String trxName) { this (ctx, C_Invoice_ID, trxName, (String[]) null); } // MInvoice /** * @param ctx * @param C_Invoice_ID * @param trxName * @param virtualColumns */ public MInvoice(Properties ctx, int C_Invoice_ID, String trxName, String... virtualColumns) { super(ctx, C_Invoice_ID, trxName, virtualColumns); if (C_Invoice_ID == 0) setInitialDefaults(); } /** * Set the initial defaults for a new record */ private void setInitialDefaults() { setDocStatus (DOCSTATUS_Drafted); // Draft setDocAction (DOCACTION_Complete); // setPaymentRule(PAYMENTRULE_OnCredit); // Payment Terms setDateInvoiced (new Timestamp (System.currentTimeMillis ())); setDateAcct (new Timestamp (System.currentTimeMillis ())); // setChargeAmt (Env.ZERO); setTotalLines (Env.ZERO); setGrandTotal (Env.ZERO); // setIsSOTrx (true); setIsTaxIncluded (false); setIsApproved (false); setIsDiscountPrinted (false); setIsPaid (false); setSendEMail (false); setIsPrinted (false); setIsTransferred (false); setIsSelfService(false); setIsPayScheduleValid(false); setIsInDispute(false); setPosted(false); super.setProcessed (false); setProcessing(false); } /** * Load Constructor * @param ctx context * @param rs result set record * @param trxName transaction */ public MInvoice (Properties ctx, ResultSet rs, String trxName) { super(ctx, rs, trxName); } // MInvoice /** * Create Invoice from Order * @param order order * @param C_DocTypeTarget_ID target document type * @param invoiceDate date or null */ public MInvoice (MOrder order, int C_DocTypeTarget_ID, Timestamp invoiceDate) { this (order.getCtx(), 0, order.get_TrxName()); setClientOrg(order); setOrder(order); // set base settings // if (C_DocTypeTarget_ID <= 0) { MDocType odt = MDocType.get(order.getC_DocType_ID()); if (odt != null) { C_DocTypeTarget_ID = odt.getC_DocTypeInvoice_ID(); if (C_DocTypeTarget_ID <= 0) throw new AdempiereException("@NotFound@ @C_DocTypeInvoice_ID@ - @C_DocType_ID@:"+odt.get_Translation(MDocType.COLUMNNAME_Name)); } } setC_DocTypeTarget_ID(C_DocTypeTarget_ID); if (invoiceDate != null) setDateInvoiced(invoiceDate); setDateAcct(getDateInvoiced()); // setSalesRep_ID(order.getSalesRep_ID()); // setC_BPartner_ID(order.getBill_BPartner_ID()); setC_BPartner_Location_ID(order.getBill_Location_ID()); setAD_User_ID(order.getBill_User_ID()); } // MInvoice /** * Create Invoice from Shipment/Receipt * @param ship shipment/receipt * @param invoiceDate date or null */ public MInvoice (MInOut ship, Timestamp invoiceDate) { this (ship.getCtx(), 0, ship.get_TrxName()); setClientOrg(ship); setShipment(ship); // set base settings // setC_DocTypeTarget_ID(); if (invoiceDate != null) setDateInvoiced(invoiceDate); setDateAcct(getDateInvoiced()); // if (getSalesRep_ID() == 0) setSalesRep_ID(ship.getSalesRep_ID()); } // MInvoice /** * Create Invoice from Batch Line * @param batch batch * @param line batch line */ public MInvoice (MInvoiceBatch batch, MInvoiceBatchLine line) { this (line.getCtx(), 0, line.get_TrxName()); setClientOrg(line); setDocumentNo(line.getDocumentNo()); // setIsSOTrx(batch.isSOTrx()); MBPartner bp = new MBPartner (line.getCtx(), line.getC_BPartner_ID(), line.get_TrxName()); setBPartner(bp); // defaults // setIsTaxIncluded(line.isTaxIncluded()); // May conflict with default price list setC_Currency_ID(batch.getC_Currency_ID()); setC_ConversionType_ID(batch.getC_ConversionType_ID()); // setDescription(batch.getDescription()); setAD_OrgTrx_ID(line.getAD_OrgTrx_ID()); setC_Project_ID(line.getC_Project_ID()); setC_Activity_ID(line.getC_Activity_ID()); setUser1_ID(line.getUser1_ID()); setUser2_ID(line.getUser2_ID()); // setC_DocTypeTarget_ID(line.getC_DocType_ID()); setDateInvoiced(line.getDateInvoiced()); setDateAcct(line.getDateAcct()); // setSalesRep_ID(batch.getSalesRep_ID()); // setC_BPartner_ID(line.getC_BPartner_ID()); setC_BPartner_Location_ID(line.getC_BPartner_Location_ID()); setAD_User_ID(line.getAD_User_ID()); } // MInvoice /** * Copy constructor * @param copy */ public MInvoice(MInvoice copy) { this(Env.getCtx(), copy); } /** * Copy constructor * @param ctx * @param copy */ public MInvoice(Properties ctx, MInvoice copy) { this(ctx, copy, (String) null); } /** * Copy constructor * @param ctx * @param copy * @param trxName */ public MInvoice(Properties ctx, MInvoice copy, String trxName) { this(ctx, 0, trxName); copyPO(copy); this.m_openAmt = copy.m_openAmt; this.m_lines = copy.m_lines != null ? Arrays.stream(copy.m_lines).map(e -> {var v = new MInvoiceLine(ctx, e, trxName); v.m_parent=this; return v;}).toArray(MInvoiceLine[]::new) : null; this.m_taxes = copy.m_taxes != null ? Arrays.stream(copy.m_taxes).map(e -> {return new MInvoiceTax(ctx, e, trxName);}).toArray(MInvoiceTax[]::new) : null; } /** Open Amount */ private BigDecimal m_openAmt = null; /** Invoice Lines */ private MInvoiceLine[] m_lines; /** Invoice Taxes */ private MInvoiceTax[] m_taxes; /** Logger */ private static CLogger s_log = CLogger.getCLogger(MInvoice.class); /** * Overwrite Client/Org if required * @param AD_Client_ID client * @param AD_Org_ID org */ @Override public void setClientOrg (int AD_Client_ID, int AD_Org_ID) { super.setClientOrg(AD_Client_ID, AD_Org_ID); } // setClientOrg /** * Set Business Partner Defaults and Details * @param bp business partner */ public void setBPartner (MBPartner bp) { if (bp == null) return; setC_BPartner_ID(bp.getC_BPartner_ID()); // Set Defaults int ii = 0; if (isSOTrx()) ii = bp.getC_PaymentTerm_ID(); else ii = bp.getPO_PaymentTerm_ID(); if (ii != 0) setC_PaymentTerm_ID(ii); // if (isSOTrx()) ii = bp.getM_PriceList_ID(); else ii = bp.getPO_PriceList_ID(); if (ii != 0) setM_PriceList_ID(ii); // String ss = bp.getPaymentRule(); if (ss != null) setPaymentRule(ss); // Set Locations MBPartnerLocation[] locs = bp.getLocations(false); if (locs != null) { for (int i = 0; i < locs.length; i++) { if ((locs[i].isBillTo() && isSOTrx()) || (locs[i].isPayFrom() && !isSOTrx())) setC_BPartner_Location_ID(locs[i].getC_BPartner_Location_ID()); } // set to first if (getC_BPartner_Location_ID() == 0 && locs.length > 0) setC_BPartner_Location_ID(locs[0].getC_BPartner_Location_ID()); } if (getC_BPartner_Location_ID() == 0) log.log(Level.SEVERE, new BPartnerNoAddressException(bp).getLocalizedMessage()); //TODO: throw exception? // Set Contact MUser[] contacts = bp.getContacts(false); if (contacts != null && contacts.length > 0) // get first User setAD_User_ID(contacts[0].getAD_User_ID()); } // setBPartner /** * Set Order Reference * @param order order */ public void setOrder (MOrder order) { if (order == null) return; setC_Order_ID(order.getC_Order_ID()); setIsSOTrx(order.isSOTrx()); setIsDiscountPrinted(order.isDiscountPrinted()); setIsSelfService(order.isSelfService()); setSendEMail(order.isSendEMail()); // setM_PriceList_ID(order.getM_PriceList_ID()); setIsTaxIncluded(order.isTaxIncluded()); setC_Currency_ID(order.getC_Currency_ID()); setC_ConversionType_ID(order.getC_ConversionType_ID()); // setPaymentRule(order.getPaymentRule()); setC_PaymentTerm_ID(order.getC_PaymentTerm_ID()); setPOReference(order.getPOReference()); setDescription(order.getDescription()); setDateOrdered(order.getDateOrdered()); // setAD_OrgTrx_ID(order.getAD_OrgTrx_ID()); setC_Project_ID(order.getC_Project_ID()); setC_Campaign_ID(order.getC_Campaign_ID()); setC_Activity_ID(order.getC_Activity_ID()); setUser1_ID(order.getUser1_ID()); setUser2_ID(order.getUser2_ID()); } // setOrder /** * Set Shipment Reference * @param ship shipment */ public void setShipment (MInOut ship) { if (ship == null) return; setIsSOTrx(ship.isSOTrx()); // MBPartner bp = new MBPartner (getCtx(), ship.getC_BPartner_ID(), null); setBPartner (bp); // setAD_User_ID(ship.getAD_User_ID()); // setSendEMail(ship.isSendEMail()); // setPOReference(ship.getPOReference()); setDescription(ship.getDescription()); setDateOrdered(ship.getDateOrdered()); // setAD_OrgTrx_ID(ship.getAD_OrgTrx_ID()); setC_Project_ID(ship.getC_Project_ID()); setC_Campaign_ID(ship.getC_Campaign_ID()); setC_Activity_ID(ship.getC_Activity_ID()); setUser1_ID(ship.getUser1_ID()); setUser2_ID(ship.getUser2_ID()); // if (ship.getC_Order_ID() != 0) { setC_Order_ID(ship.getC_Order_ID()); MOrder order = new MOrder (getCtx(), ship.getC_Order_ID(), get_TrxName()); setIsDiscountPrinted(order.isDiscountPrinted()); setM_PriceList_ID(order.getM_PriceList_ID()); setIsTaxIncluded(order.isTaxIncluded()); setC_Currency_ID(order.getC_Currency_ID()); setC_ConversionType_ID(order.getC_ConversionType_ID()); setPaymentRule(order.getPaymentRule()); setC_PaymentTerm_ID(order.getC_PaymentTerm_ID()); // MDocType dt = MDocType.get(order.getC_DocType_ID()); if (dt.getC_DocTypeInvoice_ID() != 0) setC_DocTypeTarget_ID(dt.getC_DocTypeInvoice_ID()); // Overwrite Invoice BPartner setC_BPartner_ID(order.getBill_BPartner_ID()); // Overwrite Invoice Address setC_BPartner_Location_ID(order.getBill_Location_ID()); // Overwrite Contact setAD_User_ID(order.getBill_User_ID()); setSalesRep_ID(order.getSalesRep_ID()); // } // Check if Shipment/Receipt is based on RMA if (ship.getM_RMA_ID() != 0) { setM_RMA_ID(ship.getM_RMA_ID()); MRMA rma = new MRMA(getCtx(), ship.getM_RMA_ID(), get_TrxName()); // Retrieves the invoice DocType MDocType dt = MDocType.get(rma.getC_DocType_ID()); if (dt.getC_DocTypeInvoice_ID() != 0) { setC_DocTypeTarget_ID(dt.getC_DocTypeInvoice_ID()); } setIsSOTrx(rma.isSOTrx()); MOrder rmaOrder = rma.getOriginalOrder(); if (rmaOrder != null) { setM_PriceList_ID(rmaOrder.getM_PriceList_ID()); setIsTaxIncluded(rmaOrder.isTaxIncluded()); setC_Currency_ID(rmaOrder.getC_Currency_ID()); setC_ConversionType_ID(rmaOrder.getC_ConversionType_ID()); setPaymentRule(rmaOrder.getPaymentRule()); setC_PaymentTerm_ID(rmaOrder.getC_PaymentTerm_ID()); setC_BPartner_Location_ID(rmaOrder.getBill_Location_ID()); } } } // setShipment /** * Set Target Document Type * @param DocBaseType doc type MDocType.DOCBASETYPE_ */ public void setC_DocTypeTarget_ID (String DocBaseType) { String sql = "SELECT C_DocType_ID FROM C_DocType " + "WHERE AD_Client_ID=? AND AD_Org_ID in (0,?) AND DocBaseType=?" + " AND IsActive='Y' " + "ORDER BY IsDefault DESC, AD_Org_ID DESC"; int C_DocType_ID = DB.getSQLValueEx(null, sql, getAD_Client_ID(), getAD_Org_ID(), DocBaseType); if (C_DocType_ID <= 0) log.log(Level.SEVERE, "Not found for AD_Client_ID=" + getAD_Client_ID() + " - " + DocBaseType); else { log.fine(DocBaseType); setC_DocTypeTarget_ID (C_DocType_ID); boolean isSOTrx = MDocType.DOCBASETYPE_ARInvoice.equals(DocBaseType) || MDocType.DOCBASETYPE_ARCreditMemo.equals(DocBaseType); setIsSOTrx (isSOTrx); } } // setC_DocTypeTarget_ID /** * Set Target Document Type. * Based on SO flag AR/AP Invoice. */ public void setC_DocTypeTarget_ID () { if (getC_DocTypeTarget_ID() > 0) return; if (isSOTrx()) setC_DocTypeTarget_ID(MDocType.DOCBASETYPE_ARInvoice); else setC_DocTypeTarget_ID(MDocType.DOCBASETYPE_APInvoice); } // setC_DocTypeTarget_ID /** * Get Grand Total * @param creditMemoAdjusted true to negate amount return * @return grand total */ public BigDecimal getGrandTotal (boolean creditMemoAdjusted) { if (!creditMemoAdjusted) return super.getGrandTotal(); // BigDecimal amt = getGrandTotal(); if (isCreditMemo()) return amt.negate(); return amt; } // getGrandTotal /** * Get Total Lines * @param creditMemoAdjusted true to negate amount return * @return total lines */ public BigDecimal getTotalLines (boolean creditMemoAdjusted) { if (!creditMemoAdjusted) return super.getTotalLines(); // BigDecimal amt = getTotalLines(); if (isCreditMemo()) return amt.negate(); return amt; } // getTotalLines /** * Get Invoice Lines of Invoice * @param whereClause must start with AND * @return lines */ private MInvoiceLine[] getLines (String whereClause) { String whereClauseFinal = "C_Invoice_ID=? "; if (whereClause != null) whereClauseFinal += whereClause; List list = new Query(getCtx(), I_C_InvoiceLine.Table_Name, whereClauseFinal, get_TrxName()) .setParameters(getC_Invoice_ID()) .setOrderBy("Line, C_InvoiceLine_ID") .list(); return list.toArray(new MInvoiceLine[list.size()]); } // getLines /** * Get Invoice Lines * @param requery * @return lines */ public MInvoiceLine[] getLines (boolean requery) { if (m_lines == null || m_lines.length == 0 || requery) { m_lines = getLines(null); } set_TrxName(m_lines, get_TrxName()); return m_lines; } // getLines /** * Get Lines of Invoice * @return lines */ public MInvoiceLine[] getLines() { return getLines(false); } // getLines /** * Renumber Lines * @param step start and step to increment */ public void renumberLines (int step) { int number = step; MInvoiceLine[] lines = getLines(false); for (int i = 0; i < lines.length; i++) { MInvoiceLine line = lines[i]; line.setLine(number); line.saveEx(); number += step; } m_lines = null; } // renumberLines /** * Copy Lines From other Invoice. * @param otherInvoice invoice * @param counter create counter links * @param setOrder set order links * @return number of lines copied */ public int copyLinesFrom (MInvoice otherInvoice, boolean counter, boolean setOrder){ return copyLinesFrom (otherInvoice, counter, setOrder, true); } /** * Copy Lines From other Invoice. * @param otherInvoice invoice * @param counter create counter links * @param setOrder set order links * @param copyClientOrg copy also Client and Org * @return number of lines copied */ public int copyLinesFrom (MInvoice otherInvoice, boolean counter, boolean setOrder, boolean copyClientOrg) { if (isProcessed() || isPosted() || otherInvoice == null) return 0; MInvoiceLine[] fromLines = otherInvoice.getLines(false); int count = 0; for (int i = 0; i < fromLines.length; i++) { MInvoiceLine line = new MInvoiceLine (getCtx(), 0, get_TrxName()); MInvoiceLine fromLine = fromLines[i]; if (counter || !copyClientOrg) // header PO.copyValues (fromLine, line, getAD_Client_ID(), getAD_Org_ID()); else PO.copyValues (fromLine, line, fromLine.getAD_Client_ID(), fromLine.getAD_Org_ID()); line.setC_Invoice_ID(getC_Invoice_ID()); line.setInvoice(this); line.set_ValueNoCheck ("C_InvoiceLine_ID", I_ZERO); // new // Reset if (!setOrder) line.setC_OrderLine_ID(0); line.setRef_InvoiceLine_ID(0); line.setM_InOutLine_ID(0); line.setA_Asset_ID(0); line.setM_AttributeSetInstance_ID(0); line.setS_ResourceAssignment_ID(0); // New Tax if (getC_BPartner_ID() != otherInvoice.getC_BPartner_ID()) line.setTax(); // recalculate // if (counter) { line.setRef_InvoiceLine_ID(fromLine.getC_InvoiceLine_ID()); if (fromLine.getC_OrderLine_ID() != 0) { MOrderLine peer = new MOrderLine (getCtx(), fromLine.getC_OrderLine_ID(), get_TrxName()); if (peer.getRef_OrderLine_ID() != 0) line.setC_OrderLine_ID(peer.getRef_OrderLine_ID()); } line.setM_InOutLine_ID(0); if (fromLine.getM_InOutLine_ID() != 0) { MInOutLine peer = new MInOutLine (getCtx(), fromLine.getM_InOutLine_ID(), get_TrxName()); if (peer.getRef_InOutLine_ID() != 0) line.setM_InOutLine_ID(peer.getRef_InOutLine_ID()); } } // line.setProcessed(false); if (line.save(get_TrxName())) count++; // Cross Link if (counter) { fromLine.setRef_InvoiceLine_ID(line.getC_InvoiceLine_ID()); fromLine.saveEx(get_TrxName()); } // copy the landed cost line.copyLandedCostFrom(fromLine); line.allocateLandedCosts(); } if (fromLines.length != count) log.log(Level.SEVERE, "Line difference - From=" + fromLines.length + " <> Saved=" + count); return count; } // copyLinesFrom /** Reversal Flag */ private boolean m_reversal = false; /** * Set Reversal state (in memory flag) * @param reversal reversal */ public void setReversal(boolean reversal) { m_reversal = reversal; } // setReversal /** * Is Reversal * @return reversal state (in memory flag) */ public boolean isReversal() { return m_reversal; } // isReversal /** * Get Taxes * @param requery true to requery from DB * @return array of taxes */ public MInvoiceTax[] getTaxes (boolean requery) { if (m_taxes != null && !requery) return m_taxes; final String whereClause = MInvoiceTax.COLUMNNAME_C_Invoice_ID+"=?"; List list = new Query(getCtx(), I_C_InvoiceTax.Table_Name, whereClause, get_TrxName()) .setParameters(get_ID()) .list(); m_taxes = list.toArray(new MInvoiceTax[list.size()]); return m_taxes; } // getTaxes /** * Add to Description * @param description text */ public void addDescription (String description) { String desc = getDescription(); if (desc == null) setDescription(description); else{ StringBuilder msgd = new StringBuilder(desc).append(" | ").append(description); setDescription(msgd.toString()); } } // addDescription /** * Is it a Credit Memo? * @return true if this is CM document (DOCBASETYPE_APCreditMemo or DOCBASETYPE_ARCreditMemo) */ public boolean isCreditMemo() { MDocType dt = MDocType.get(getC_DocType_ID()==0 ? getC_DocTypeTarget_ID() : getC_DocType_ID()); return MDocType.DOCBASETYPE_APCreditMemo.equals(dt.getDocBaseType()) || MDocType.DOCBASETYPE_ARCreditMemo.equals(dt.getDocBaseType()); } // isCreditMemo /** * Set Processed. * Propagate to Lines/Taxes. * @param processed processed */ @Override public void setProcessed (boolean processed) { super.setProcessed (processed); if (get_ID() == 0) return; StringBuilder set = new StringBuilder("SET Processed='") .append((processed ? "Y" : "N")) .append("' WHERE C_Invoice_ID=").append(getC_Invoice_ID()); StringBuilder msgdb = new StringBuilder("UPDATE C_InvoiceLine ").append(set); int noLine = DB.executeUpdate(msgdb.toString(), get_TrxName()); msgdb = new StringBuilder("UPDATE C_InvoiceTax ").append(set); int noTax = DB.executeUpdate(msgdb.toString(), get_TrxName()); m_lines = null; m_taxes = null; if (log.isLoggable(Level.FINE)) log.fine(processed + " - Lines=" + noLine + ", Tax=" + noTax); } // setProcessed /** * Validate Invoice Pay Schedule * @return true if pay schedule is valid */ public boolean validatePaySchedule() { MInvoicePaySchedule[] schedule = MInvoicePaySchedule.getInvoicePaySchedule (getCtx(), getC_Invoice_ID(), 0, get_TrxName()); if (log.isLoggable(Level.FINE)) log.fine("#" + schedule.length); if (schedule.length == 0) { setIsPayScheduleValid(false); return false; } // Add up due amounts BigDecimal total = Env.ZERO; for (int i = 0; i < schedule.length; i++) { schedule[i].setParent(this); BigDecimal due = schedule[i].getDueAmt(); if (due != null) total = total.add(due); } boolean valid = getGrandTotal().compareTo(total) == 0; setIsPayScheduleValid(valid); // Update Schedule Lines for (int i = 0; i < schedule.length; i++) { if (schedule[i].isValid() != valid) { schedule[i].setIsValid(valid); schedule[i].saveEx(get_TrxName()); } } return valid; } // validatePaySchedule private volatile static boolean recursiveCall = false; /** * Before Save * @param newRecord new * @return true */ @Override protected boolean beforeSave (boolean newRecord) { if (log.isLoggable(Level.FINE)) log.fine(""); // No Partner Info - set Template if (getC_BPartner_ID() == 0) setBPartner(MBPartner.getTemplate(getCtx(), getAD_Client_ID())); if (getC_BPartner_Location_ID() == 0) setBPartner(new MBPartner(getCtx(), getC_BPartner_ID(), null)); // Price List if (getM_PriceList_ID() == 0) { int ii = Env.getContextAsInt(getCtx(), Env.M_PRICELIST_ID); if (ii != 0) { MPriceList pl = new MPriceList(getCtx(), ii, null); if (isSOTrx() == pl.isSOPriceList()) setM_PriceList_ID(ii); } if (getM_PriceList_ID() == 0) { String sql = "SELECT M_PriceList_ID FROM M_PriceList WHERE AD_Client_ID=? AND IsSOPriceList=? AND IsActive='Y' ORDER BY IsDefault DESC"; ii = DB.getSQLValue (null, sql, getAD_Client_ID(), isSOTrx()); if (ii != 0) setM_PriceList_ID (ii); } } // Currency if (getC_Currency_ID() == 0) { String sql = "SELECT C_Currency_ID FROM M_PriceList WHERE M_PriceList_ID=?"; int ii = DB.getSQLValue (null, sql, getM_PriceList_ID()); if (ii != 0) setC_Currency_ID (ii); else setC_Currency_ID(Env.getContextAsInt(getCtx(), Env.C_CURRENCY_ID)); } // Sales Rep if (getSalesRep_ID() == 0) { int ii = Env.getContextAsInt(getCtx(), Env.SALESREP_ID); if (ii != 0) setSalesRep_ID (ii); } // Document Type if (getC_DocType_ID() == 0) setC_DocType_ID (0); // make sure it's set to 0 if (getC_DocTypeTarget_ID() == 0) setC_DocTypeTarget_ID(isSOTrx() ? MDocType.DOCBASETYPE_ARInvoice : MDocType.DOCBASETYPE_APInvoice); // Payment Term if (getC_PaymentTerm_ID() == 0) { int ii = Env.getContextAsInt(getCtx(), Env.C_PAYMENTTERM_ID); if (ii != 0) setC_PaymentTerm_ID (ii); else { String sql = "SELECT C_PaymentTerm_ID FROM C_PaymentTerm WHERE AD_Client_ID=? AND IsDefault='Y' AND IsActive='Y'"; ii = DB.getSQLValue(null, sql, getAD_Client_ID()); if (ii != 0) setC_PaymentTerm_ID (ii); } } // assign cash plan line from order if (getC_Order_ID() > 0 && getC_CashPlanLine_ID() <= 0) { MOrder order = new MOrder(getCtx(), getC_Order_ID(), get_TrxName()); if (order.getC_CashPlanLine_ID() > 0) setC_CashPlanLine_ID(order.getC_CashPlanLine_ID()); } // IDEMPIERE-1597 Price List and Date must be not-updateable if (!newRecord && (is_ValueChanged(COLUMNNAME_M_PriceList_ID) || is_ValueChanged(COLUMNNAME_DateInvoiced))) { int cnt = DB.getSQLValueEx(get_TrxName(), "SELECT COUNT(*) FROM C_InvoiceLine WHERE C_Invoice_ID=? AND M_Product_ID>0", getC_Invoice_ID()); if (cnt > 0) { if (is_ValueChanged(COLUMNNAME_M_PriceList_ID)) { log.saveError("Error", Msg.getMsg(getCtx(), "CannotChangePlIn")); return false; } if (is_ValueChanged(COLUMNNAME_DateInvoiced)) { MPriceList pList = MPriceList.get(getCtx(), getM_PriceList_ID(), null); MPriceListVersion plOld = pList.getPriceListVersion((Timestamp)get_ValueOld(COLUMNNAME_DateInvoiced)); MPriceListVersion plNew = pList.getPriceListVersion((Timestamp)get_Value(COLUMNNAME_DateInvoiced)); if (plNew == null || !plNew.equals(plOld)) { log.saveError("Error", Msg.getMsg(getCtx(), "CannotChangeDateInvoiced")); return false; } } } } if (! recursiveCall && (!newRecord && is_ValueChanged(COLUMNNAME_C_PaymentTerm_ID))) { recursiveCall = true; try { MPaymentTerm pt = new MPaymentTerm (getCtx(), getC_PaymentTerm_ID(), get_TrxName()); boolean valid = pt.apply(this); setIsPayScheduleValid(valid); } catch (Exception e) { throw e; } finally { recursiveCall = false; } } if (!isProcessed()) { MClientInfo info = MClientInfo.get(getCtx(), getAD_Client_ID(), get_TrxName()); MAcctSchema as = MAcctSchema.get (getCtx(), info.getC_AcctSchema1_ID(), get_TrxName()); if (as.getC_Currency_ID() != getC_Currency_ID()) { if (isOverrideCurrencyRate()) { if(getCurrencyRate() == null || getCurrencyRate().signum() == 0) { log.saveError("FillMandatory", Msg.getElement(getCtx(), COLUMNNAME_CurrencyRate)); return false; } } else { setCurrencyRate(null); } } else { setCurrencyRate(null); } } return true; } // beforeSave /** * Before Delete * @return true if it can be deleted */ @Override protected boolean beforeDelete () { if (getC_Order_ID() != 0) { //Load invoice lines for afterDelete() getLines(); } return true; } // beforeDelete /** * After Delete * @param success success * @return true if deleted */ @Override protected boolean afterDelete(boolean success) { // If delete invoice failed then do nothing if (!success) return success; if (getC_Order_ID() != 0) { // reset shipment line invoiced flag MInvoiceLine[] lines = getLines(false); for (int i = 0; i < lines.length; i++) { if (lines[i].getM_InOutLine_ID() > 0) { MInOutLine sLine = new MInOutLine(getCtx(), lines[i].getM_InOutLine_ID(), get_TrxName()); sLine.setIsInvoiced(false); sLine.saveEx(); } } } return true; } //afterDelete /** * String Representation * @return info */ @Override public String toString () { StringBuilder sb = new StringBuilder ("MInvoice[") .append(get_ID()).append("-").append(getDocumentNo()) .append(",GrandTotal=").append(getGrandTotal()); if (m_lines != null) sb.append(" (#").append(m_lines.length).append(")"); sb.append ("]"); return sb.toString (); } // toString /** * Get Document Info * @return document info (untranslated) */ @Override public String getDocumentInfo() { MDocType dt; if (getC_DocType_ID() == 0) { dt = MDocType.get(getCtx(), getC_DocTypeTarget_ID()); } else { dt = MDocType.get(getCtx(), getC_DocType_ID()); } StringBuilder msgreturn = new StringBuilder().append(dt.getNameTrl()).append(" ").append(getDocumentNo()); return msgreturn.toString(); } // getDocumentInfo /** * After Save * @param newRecord new * @param success success * @return success */ @Override protected boolean afterSave (boolean newRecord, boolean success) { if (!success || newRecord) return success; if (is_ValueChanged("AD_Org_ID")) { StringBuilder sql = new StringBuilder("UPDATE C_InvoiceLine ol") .append(" SET AD_Org_ID =") .append("(SELECT AD_Org_ID") .append(" FROM C_Invoice o WHERE ol.C_Invoice_ID=o.C_Invoice_ID) ") .append("WHERE C_Invoice_ID=").append(getC_Invoice_ID()); int no = DB.executeUpdate(sql.toString(), get_TrxName()); if (log.isLoggable(Level.FINE)) log.fine("Lines -> #" + no); } return true; } // afterSave /** * Set Price List (and Currency) when valid * @param M_PriceList_ID price list */ @Override public void setM_PriceList_ID (int M_PriceList_ID) { MPriceList pl = MPriceList.get(getCtx(), M_PriceList_ID, null); if (pl != null) { setC_Currency_ID(pl.getC_Currency_ID()); super.setM_PriceList_ID(M_PriceList_ID); } } // setM_PriceList_ID /** * Get Allocated Amt in Invoice Currency * @return pos/neg amount or null */ public BigDecimal getAllocatedAmt () { BigDecimal retValue = null; String sql = "SELECT SUM(currencyConvert(al.Amount+al.DiscountAmt+al.WriteOffAmt," + "ah.C_Currency_ID, i.C_Currency_ID,ah.DateTrx,COALESCE(i.C_ConversionType_ID,0), al.AD_Client_ID,al.AD_Org_ID)) " + "FROM C_AllocationLine al" + " INNER JOIN C_AllocationHdr ah ON (al.C_AllocationHdr_ID=ah.C_AllocationHdr_ID)" + " INNER JOIN C_Invoice i ON (al.C_Invoice_ID=i.C_Invoice_ID) " + "WHERE al.C_Invoice_ID=?" + " AND ah.IsActive='Y' AND al.IsActive='Y'"; PreparedStatement pstmt = null; ResultSet rs = null; try { pstmt = DB.prepareStatement(sql, get_TrxName()); pstmt.setInt(1, getC_Invoice_ID()); rs = pstmt.executeQuery(); if (rs.next()) { retValue = rs.getBigDecimal(1); } } catch (SQLException e) { throw new DBException(e, sql); } finally { DB.close(rs, pstmt); rs = null; pstmt = null; } return retValue; } // getAllocatedAmt /** * Test Allocation (and set paid flag) * @param beingCompleted true if call during processing of Complete document action * @return true if updated IsPaid */ public boolean testAllocation(boolean beingCompleted) { boolean change = false; if ( isProcessed() || beingCompleted) { BigDecimal alloc = getAllocatedAmt(); // absolute if (alloc == null) alloc = Env.ZERO; BigDecimal total = getGrandTotal(); if (!isSOTrx()) total = total.negate(); if (isCreditMemo()) total = total.negate(); boolean test = total.compareTo(alloc) == 0; change = test != isPaid(); if (change) setIsPaid(test); if (log.isLoggable(Level.FINE)) log.fine("Paid=" + test + " (" + alloc + "=" + total + ")"); } return change; } // testAllocation /** * Test Allocation (and set paid flag) * @return true if updated IsPaid */ public boolean testAllocation() { return testAllocation(false); } /** * Set Paid Flag for invoices * @param ctx context * @param C_BPartner_ID if 0 all * @param trxName transaction */ public static void setIsPaid (Properties ctx, int C_BPartner_ID, String trxName) { List