Examples with DisbursementVoucherDocument org.kuali.kfs.fp.document.DisbursementVoucherDocument used on opensource projects

Example 6 with DisbursementVoucherDocument

use of org.kuali.kfs.fp.document.DisbursementVoucherDocument in project cu-kfs by CU-CommunityApps.

the class CuDisbursementVoucherNonResidentAlienInformationValidation method validate.

@Override
public boolean validate(AttributedDocumentEvent event) {
    LOG.debug("validate start");
    boolean isValid = true;
    DisbursementVoucherDocument document = (DisbursementVoucherDocument) accountingDocumentForValidation;
    DisbursementVoucherNonResidentAlienTax nonResidentAlienTax = document.getDvNonResidentAlienTax();
    DisbursementVoucherPayeeDetail payeeDetail = document.getDvPayeeDetail();
    Person financialSystemUser = GlobalVariables.getUserSession().getPerson();
    List<String> taxEditMode = this.getTaxEditMode();
    if (!payeeDetail.isDisbVchrAlienPaymentCode() || !this.hasRequiredEditMode(document, financialSystemUser, taxEditMode)) {
        return true;
    }
    MessageMap errors = GlobalVariables.getMessageMap();
    errors.addToErrorPath(KFSPropertyConstants.DOCUMENT);
    errors.addToErrorPath(KFSPropertyConstants.DV_NON_RESIDENT_ALIEN_TAX);
    /* income class code required */
    if (StringUtils.isBlank(nonResidentAlienTax.getIncomeClassCode())) {
        errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_REQUIRED, "Income class code");
        return false;
    }
    /* country code required, unless income type is nonreportable */
    if (StringUtils.isBlank(nonResidentAlienTax.getPostalCountryCode()) && !NRA_TAX_INCOME_CLASS_NON_REPORTABLE.equals(nonResidentAlienTax.getIncomeClassCode())) {
        errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_REQUIRED, "Country code");
        return false;
    }
    // income class is FELLOWSHIP
    if (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_FELLOWSHIP)) {
    // Place holder for logic related to the ICC
    }
    // income class is INDEPENDENT CONTRACTOR
    if (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_INDEPENDENT_CONTRACTOR)) {
    // Place holder for logic related to the ICC
    }
    // income class is ROYALTIES
    if (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_ROYALTIES)) {
    // Place holder for logic related to the ICC
    }
    // income class is NON_REPORTABLE
    if (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_NON_REPORTABLE)) {
        if ((nonResidentAlienTax.isForeignSourceIncomeCode()) || (nonResidentAlienTax.isIncomeTaxTreatyExemptCode()) || (nonResidentAlienTax.isTaxOtherExemptIndicator()) || (nonResidentAlienTax.isIncomeTaxGrossUpCode()) || (nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) || (nonResidentAlienTax.getTaxSpecialW4Amount() != null) || (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) || (nonResidentAlienTax.getTaxNQIId() != null) || (nonResidentAlienTax.getPostalCountryCode() != null)) {
            String boxCode = "";
            if (nonResidentAlienTax.isForeignSourceIncomeCode()) {
                boxCode = "Foreign Source";
            }
            if (nonResidentAlienTax.isIncomeTaxTreatyExemptCode()) {
                boxCode = "Treaty Exempt";
            }
            if (nonResidentAlienTax.isTaxOtherExemptIndicator()) {
                boxCode = "Exempt Under Other Code";
            }
            if (nonResidentAlienTax.isIncomeTaxGrossUpCode()) {
                boxCode = "Gross Up Payment";
            }
            if (nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) {
                boxCode = "USAID Per Diem";
            }
            if (nonResidentAlienTax.getTaxSpecialW4Amount() != null) {
                boxCode = "Special W-4 Amount";
            }
            if (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) {
                boxCode = "Reference Doc";
            }
            if (nonResidentAlienTax.getTaxNQIId() != null) {
                boxCode = "NQI Id";
            }
            if (nonResidentAlienTax.getPostalCountryCode() != null) {
                boxCode = "Country Code";
            }
            errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NON_REPORTABLE_ONLY, boxCode);
            return false;
        }
    }
    /* check tax rates */
    if (((nonResidentAlienTax.getFederalIncomeTaxPercent() == null) || (nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO))) && (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_NON_REPORTABLE))) {
        nonResidentAlienTax.setFederalIncomeTaxPercent(KualiDecimal.ZERO);
    } else {
        if (nonResidentAlienTax.getFederalIncomeTaxPercent() == null) {
            errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_REQUIRED, "Federal tax percent");
            return false;
        } else {
            // check Federal tax percent is in non-resident alien tax percent table for income class code
            NonResidentAlienTaxPercent taxPercent = new NonResidentAlienTaxPercent();
            taxPercent.setIncomeClassCode(nonResidentAlienTax.getIncomeClassCode());
            taxPercent.setIncomeTaxTypeCode(FEDERAL_TAX_TYPE_CODE);
            taxPercent.setIncomeTaxPercent(nonResidentAlienTax.getFederalIncomeTaxPercent());
            NonResidentAlienTaxPercent retrievedPercent = (NonResidentAlienTaxPercent) SpringContext.getBean(BusinessObjectService.class).retrieve(taxPercent);
            if (retrievedPercent == null) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_INVALID_FED_TAX_PERCENT, new String[] { nonResidentAlienTax.getFederalIncomeTaxPercent().toString(), nonResidentAlienTax.getIncomeClassCode() });
                return false;
            }
        }
    }
    if (((nonResidentAlienTax.getStateIncomeTaxPercent() == null) || (nonResidentAlienTax.getStateIncomeTaxPercent().equals(KualiDecimal.ZERO))) && (nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_NON_REPORTABLE))) {
        nonResidentAlienTax.setStateIncomeTaxPercent(KualiDecimal.ZERO);
    } else {
        if (nonResidentAlienTax.getStateIncomeTaxPercent() == null) {
            errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_REQUIRED, "State tax percent");
            return false;
        } else {
            // check State tax percent is in non-resident alien tax percent table for income class code
            NonResidentAlienTaxPercent taxPercent = new NonResidentAlienTaxPercent();
            taxPercent.setIncomeClassCode(nonResidentAlienTax.getIncomeClassCode());
            taxPercent.setIncomeTaxTypeCode(STATE_TAX_TYPE_CODE);
            taxPercent.setIncomeTaxPercent(nonResidentAlienTax.getStateIncomeTaxPercent());
            PersistableBusinessObject retrievedPercent = SpringContext.getBean(BusinessObjectService.class).retrieve(taxPercent);
            if (retrievedPercent == null) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_INVALID_STATE_TAX_PERCENT, nonResidentAlienTax.getStateIncomeTaxPercent().toString(), nonResidentAlienTax.getIncomeClassCode());
                return false;
            } else {
                if ((!document.getDvNonResidentAlienTax().getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_ROYALTIES)) && (!document.getDvNonResidentAlienTax().getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_INDEPENDENT_CONTRACTOR))) {
                    // If fed tax rate is zero, the state tax rate should be zero.
                    if ((document.getDvNonResidentAlienTax().getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO)) && (!document.getDvNonResidentAlienTax().getStateIncomeTaxPercent().isZero())) {
                        errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_STATE_TAX_SHOULD_BE_ZERO);
                        return false;
                    }
                }
            }
        }
    }
    // the 4 check boxes (Foreign Source, Treaty Exempt, Gross Up Payment, Exempt Under Other Code) shall be mutual exclusive
    if (OneOrLessBoxesChecked(document)) {
        // if Foreign Source is checked
        if (nonResidentAlienTax.isForeignSourceIncomeCode()) {
            // Federal and State tax rate should be zero.
            if ((!nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO)) || (!nonResidentAlienTax.getStateIncomeTaxPercent().equals(KualiDecimal.ZERO))) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_FEDERAL_AND_STATE_TAXES_SHOULD_BE_ZERO, "Foreign Source");
                return false;
            }
            // No other items (mutual exclusiveness checking on USAID Per Diem and Special W-4 Amount are optional here since these are also ensured by their validation later)
            if ((nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) || (nonResidentAlienTax.getTaxSpecialW4Amount() != null) || (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) || (nonResidentAlienTax.getTaxNQIId() != null)) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_CANNOT_HAVE_VALUE, "Foreign Source", "NQI Id, Reference Doc, USAID Per Diem, or Special W-4 Amount");
                return false;
            }
        }
        // if Treaty Exempt is checked
        if (nonResidentAlienTax.isIncomeTaxTreatyExemptCode()) {
            // No other items (mutual exclusiveness checking on USAID Per Diem and Special W-4 Amount are optional here since these are also ensured by their validation later)
            if ((nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) || (nonResidentAlienTax.getTaxSpecialW4Amount() != null) || (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) || (nonResidentAlienTax.getTaxNQIId() != null)) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_CANNOT_HAVE_VALUE, "Treaty Exempt", "NQI Id, Reference Doc, USAID Per Diem, or Special W-4 Amount");
                return false;
            }
        }
        // if Gross Up Payment is checked
        if (nonResidentAlienTax.isIncomeTaxGrossUpCode()) {
            // NOTE: Also, state tax not allowed to be zero for income classes "R" and "I", however, this rule is already checked in the tax rate section, so no need to re-check
            if ((nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO))) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_FEDERAL_TAX_CANNOT_BE_ZERO, "Gross Up Payment");
                return false;
            }
            // No other items (mutual exclusiveness checking on USAID Per Diem and Special W-4 Amount are optional here since these are also ensured by their validation later)
            if ((nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) || (nonResidentAlienTax.getTaxSpecialW4Amount() != null) || (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) || (nonResidentAlienTax.getTaxNQIId() != null)) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_CANNOT_HAVE_VALUE, "Gross Up Payment", "NQI Id, Reference Doc, USAID Per Diem, or Special W-4 Amount");
                return false;
            }
        }
        // if Exempt Under Other Code is checked
        if (nonResidentAlienTax.isTaxOtherExemptIndicator()) {
            // Federal and State tax rate should be zero.
            if (!(nonResidentAlienTax.getStateIncomeTaxPercent().equals(KualiDecimal.ZERO)) || !(nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO))) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_FEDERAL_AND_STATE_TAXES_SHOULD_BE_ZERO, "Exempt Under Other Code");
                return false;
            }
        }
        // if USAID Per Diem is checked
        if (nonResidentAlienTax.isTaxUSAIDPerDiemIndicator()) {
            // income class code should be fellowship
            if (!nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_FELLOWSHIP)) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_SHOULD_BE_SELECTED, "USAID Per Diem", "Income Class Code : Fellowship");
                return false;
            }
            // Federal and State tax rate should be zero.
            if (!(nonResidentAlienTax.getStateIncomeTaxPercent().equals(KualiDecimal.ZERO)) || !(nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO))) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_FEDERAL_AND_STATE_TAXES_SHOULD_BE_ZERO, "USAID Per Diem");
                return false;
            }
            // Exempt Under Other Code should be checked; this will ensure the other 3 check boxes not checked due to mutual exclusiveness
            if (!nonResidentAlienTax.isTaxOtherExemptIndicator()) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_SHOULD_BE_SELECTED, "USAID Per Diem", "Exempt Under Other Code");
                return false;
            }
            // Special W-4 Amount shall have no value
            if (nonResidentAlienTax.getTaxSpecialW4Amount() != null) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_CANNOT_HAVE_VALUE, "USAID Per Diem", "Special W-4 Amount");
                return false;
            }
        }
        // if Special W-4 Amount is entered
        if (nonResidentAlienTax.getTaxSpecialW4Amount() != null) {
            // income class code should be fellowship
            if (!nonResidentAlienTax.getIncomeClassCode().equals(NRA_TAX_INCOME_CLASS_FELLOWSHIP)) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_SHOULD_BE_SELECTED, "Special W-4 Amount", "Income Class Code : Fellowship");
                return false;
            }
            // Federal and State tax rate should be zero.
            if (!(nonResidentAlienTax.getStateIncomeTaxPercent().equals(KualiDecimal.ZERO)) || !(nonResidentAlienTax.getFederalIncomeTaxPercent().equals(KualiDecimal.ZERO))) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_FEDERAL_AND_STATE_TAXES_SHOULD_BE_ZERO, "Special W-4 Amount");
                return false;
            }
            // Exempt Under Other Code should be checked; this will ensure the other 3 check boxes not checked due to mutual exclusiveness
            if (!nonResidentAlienTax.isTaxOtherExemptIndicator()) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_SHOULD_BE_SELECTED, "Special W-4 Amount", "Exempt Under Other Code");
                return false;
            }
            // USAID Per Diem should not be checked (mutual exclusive checking on USAID Per Diem here is optional since this is also ensured by validation on Special W-4 Amount above
            if ((nonResidentAlienTax.isTaxUSAIDPerDiemIndicator())) {
                errors.putErrorWithoutFullErrorPath("DVNRATaxErrors", KFSKeyConstants.ERROR_DV_NRA_TAX_WHEN_CHECKED_CANNOT_BE_SELECTED, "Special W-4 Amount", "USAID Per Diem");
                return false;
            }
        }
        // if NQI Id is entered
        if (nonResidentAlienTax.getTaxNQIId() != null) {
        }
        // if Reference Doc is entered
        if (nonResidentAlienTax.getReferenceFinancialDocumentNumber() != null) {
        }
    }
    if (validationType != "GENERATE") {
        // verify tax lines have been generated
        if ((nonResidentAlienTax.getFederalIncomeTaxPercent().isNonZero() || nonResidentAlienTax.getStateIncomeTaxPercent().isNonZero())) {
            if (StringUtils.isBlank(nonResidentAlienTax.getFinancialDocumentAccountingLineText())) {
                errors.putErrorWithoutFullErrorPath(KFSConstants.GENERAL_NRATAX_TAB_ERRORS, KFSKeyConstants.ERROR_DV_NRA_NO_TAXLINES_GENERATED);
                return false;
            }
        }
    }
    errors.removeFromErrorPath(KFSPropertyConstants.DV_NON_RESIDENT_ALIEN_TAX);
    errors.removeFromErrorPath(KFSPropertyConstants.DOCUMENT);
    return isValid;
}

Example 7 with DisbursementVoucherDocument

use of org.kuali.kfs.fp.document.DisbursementVoucherDocument in project cu-kfs by CU-CommunityApps.

the class DisbursementVoucherAction method setupPayeeAsCustomer.

/**
 * setup the payee as a customer with the given id number and address id
 */
protected void setupPayeeAsCustomer(DisbursementVoucherForm dvForm, String payeeIdNumber, String payeeAddressIdentifier) {
    AccountsReceivableCustomer customer = SpringContext.getBean(AccountsReceivableModuleService.class).findCustomer(payeeIdNumber);
    AccountsReceivableCustomerAddress customerAddress = null;
    if (StringUtils.isNotBlank(payeeAddressIdentifier)) {
        customerAddress = SpringContext.getBean(AccountsReceivableModuleService.class).findCustomerAddress(payeeIdNumber, payeeAddressIdentifier);
    }
    dvForm.setTempPayeeIdNumber(payeeIdNumber);
    dvForm.setOldPayeeType(KFSConstants.PaymentPayeeTypes.CUSTOMER);
    ((DisbursementVoucherDocument) dvForm.getDocument()).templateCustomer(customer, customerAddress);
}

Example 8 with DisbursementVoucherDocument

use of org.kuali.kfs.fp.document.DisbursementVoucherDocument in project cu-kfs by CU-CommunityApps.

the class DisbursementVoucherAction method setupPayeeAsVendor.

/**
 * setup the payee as a vendor with the given id number and address id
 */
protected void setupPayeeAsVendor(DisbursementVoucherForm dvForm, String payeeIdNumber, String payeeAddressIdentifier) {
    VendorDetail vendorDetail = new VendorDetail();
    vendorDetail.setVendorNumber(payeeIdNumber);
    vendorDetail = (VendorDetail) SpringContext.getBean(BusinessObjectService.class).retrieve(vendorDetail);
    VendorAddress vendorAddress = new VendorAddress();
    if (StringUtils.isNotBlank(payeeAddressIdentifier)) {
        try {
            vendorAddress.setVendorAddressGeneratedIdentifier(new Integer(payeeAddressIdentifier));
            vendorAddress = (VendorAddress) SpringContext.getBean(BusinessObjectService.class).retrieve(vendorAddress);
            dvForm.setTempPayeeIdNumber(payeeIdNumber);
            dvForm.setOldPayeeType(KFSConstants.PaymentPayeeTypes.VENDOR);
        } catch (Exception e) {
            LOG.error("Exception while attempting to retrieve vendor address for vendor address id " + payeeAddressIdentifier + ": " + e);
        }
    }
    ((DisbursementVoucherDocument) dvForm.getDocument()).templateVendor(vendorDetail, vendorAddress);
}

Example 9 with DisbursementVoucherDocument

use of org.kuali.kfs.fp.document.DisbursementVoucherDocument in project cu-kfs by CU-CommunityApps.

the class DisbursementVoucherAction method loadDocument.

/**
 * @see org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase#loadDocument(org.kuali.kfs.kns.web.struts.form.KualiDocumentFormBase)
 */
@Override
protected void loadDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException {
    super.loadDocument(kualiDocumentFormBase);
    DisbursementVoucherForm dvForm = (DisbursementVoucherForm) kualiDocumentFormBase;
    DisbursementVoucherDocument dvDoc = (DisbursementVoucherDocument) dvForm.getDocument();
    // do not execute the further refreshing logic if a payee is not selected
    String payeeIdNumber = dvDoc.getDvPayeeDetail().getDisbVchrPayeeIdNumber();
    // ==== CU Customization: Updated condition to prevent errors when opening no-payee, non-SAVED DV docs that are at the initial AdHoc node. ====
    if ((payeeIdNumber != null && !payeeIdNumber.isEmpty()) || (!dvDoc.getDocumentHeader().getWorkflowDocument().checkStatus(DocumentStatus.SAVED) && !dvDoc.getDocumentHeader().getWorkflowDocument().getCurrentNodeNames().contains(DV_ADHOC_NODE))) {
        Entity entity = KimApiServiceLocator.getIdentityService().getEntityByEmployeeId(payeeIdNumber);
        // KFSMI-8935: When an employee is inactive, the Payment Type field on DV documents should display the message "Is this payee an employee" = No
        if (entity != null && entity.isActive()) {
            dvDoc.getDvPayeeDetail().setDisbVchrPayeeEmployeeCode(true);
        } else {
            dvDoc.getDvPayeeDetail().setDisbVchrPayeeEmployeeCode(false);
        }
    }
}

Example 10 with DisbursementVoucherDocument

use of org.kuali.kfs.fp.document.DisbursementVoucherDocument in project cu-kfs by CU-CommunityApps.

the class DisbursementVoucherAction method generateNonResidentAlienTaxLines.

/**
 * Calls service to generate tax accounting lines and updates nra tax line string in action form.
 */
public ActionForward generateNonResidentAlienTaxLines(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
    DisbursementVoucherForm dvForm = (DisbursementVoucherForm) form;
    DisbursementVoucherDocument document = (DisbursementVoucherDocument) dvForm.getDocument();
    DisbursementVoucherTaxService taxService = SpringContext.getBean(DisbursementVoucherTaxService.class);
    /* call service to generate new tax lines */
    GlobalVariables.getMessageMap().addToErrorPath("document");
    taxService.processNonResidentAlienTax(document);
    GlobalVariables.getMessageMap().removeFromErrorPath("document");
    return mapping.findForward(KFSConstants.MAPPING_BASIC);
}