View source | Discuss this page | Page history | Printable version   

ERP/2.50/Developers Guide/Reference/Entity Model/FinancialMgmtWithholding


The Withholding Rules Tab define the rules governing the withholding of amounts.

To the database table (C_Withholding) of this entity.

Back to the entity model.



Property Column Constraints Type Description
id* C_Withholding_ID Mandatory
Max Length: 32
java.lang.String The Withholding indicates the type of withholding to be calculated.
client AD_Client_ID Mandatory ADClient A Client is a company or a legal entity. You cannot share data between Clients.
organization AD_Org_ID Mandatory Organization An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
active IsActive Mandatory java.lang.Boolean There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:

(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.

creationDate Created Mandatory java.util.Date The Created field indicates the date that this record was created.
createdBy CreatedBy Mandatory ADUser The Created By field indicates the user who created this record.
updated Updated Mandatory java.util.Date The Updated field indicates the date that this record was updated.
updatedBy UpdatedBy Mandatory ADUser The Updated By field indicates the user who updated this record.
name# Name Mandatory
Max Length: 60
java.lang.String A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
paymentTerms C_PaymentTerm_ID FinancialMgmtPaymentTerm Payment Terms identify the method and timing of payment for this transaction.
taxWithholding IsTaxWithholding Mandatory java.lang.Boolean The Tax Withholding checkbox indicates if this withholding is tax related.
prorateTax IsTaxProrated Mandatory java.lang.Boolean The Prorate Tax checkbox indicates if this tax is prorated.
paymentToExternalParty IsPaidTo3Party Mandatory java.lang.Boolean The Paid to Third Party checkbox indicates that the amounts are paid to someone other than the Business Partner.
beneficiary Beneficiary BusinessPartner The Beneficiary indicates the Business Partner to whom payment will be made. This field is only displayed if the Paid to Third Party checkbox is selected.
withholdingPercentage IsPercentWithholding Mandatory java.lang.Boolean The Percent Withholding checkbox indicates if the withholding amount is a percentage of the invoice amount.
percent Percent java.math.BigDecimal The Percent indicates the percentage used for withholding.
fixAmount FixAmt java.math.BigDecimal The Fixed Amount indicates a fixed amount to be levied or paid.
thresholdMin Thresholdmin java.math.BigDecimal The Threshold Minimum indicates the minimum gross amount to be used in the withholding calculation.
thresholdMax ThresholdMax java.math.BigDecimal The Threshold maximum indicates the maximum gross amount to be used in the withholding calculation . A value of 0 indicates there is no limit.
minAmount MinAmt java.math.BigDecimal The Minimum amount indicates the minimum amount as stated in the currency of the invoice.
maxAmount MaxAmt java.math.BigDecimal The Maximum Amount indicates the maximum amount in invoice currency.
rate Rate Min: 0 java.math.BigDecimal The Rate indicates the percentage to be multiplied by the source to arrive at the tax or exchange amount.
financialMgmtWithholdingAccountsList List of FinancialMgmtWithholdingAccounts

Java Entity Class

 * The contents of this file are subject to the Openbravo  Public  License
 * Version  1.1  (the  "License"),  being   the  Mozilla   Public  License
 * Version 1.1  with a permitted attribution clause; you may not  use this
 * file except in compliance with the License. You  may  obtain  a copy of
 * the License at
 * Software distributed under the License  is  distributed  on  an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific  language  governing  rights  and  limitations
 * under the License.
 * The Original Code is Openbravo ERP.
 * The Initial Developer of the Original Code is Openbravo SLU
 * All portions are Copyright (C) 2008-2010 Openbravo SLU
 * All Rights Reserved.
 * Contributor(s):  ______________________________________.
import org.openbravo.base.structure.ActiveEnabled;
import org.openbravo.base.structure.BaseOBObject;
import org.openbravo.base.structure.ClientEnabled;
import org.openbravo.base.structure.OrganizationEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.common.businesspartner.BusinessPartner;
import org.openbravo.model.common.enterprise.Organization;
import org.openbravo.model.financialmgmt.payment.PaymentTerm;
import java.lang.Boolean;
import java.lang.String;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 * Entity class for entity FinancialMgmtWithholding (stored in table C_Withholding).
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
public class Withholding extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_Withholding";
    public static final String FinancialMgmtWithholding = "FinancialMgmtWithholding";
    public static final String PROPERTY_ID = "id";
    public static final String PROPERTY_CLIENT = "client";
    public static final String PROPERTY_ORGANIZATION = "organization";
    public static final String PROPERTY_ACTIVE = "active";
    public static final String PROPERTY_CREATIONDATE = "creationDate";
    public static final String PROPERTY_CREATEDBY = "createdBy";
    public static final String PROPERTY_UPDATED = "updated";
    public static final String PROPERTY_UPDATEDBY = "updatedBy";
    public static final String PROPERTY_NAME = "name";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_PAYMENTTERMS = "paymentTerms";
    public static final String PROPERTY_TAXWITHHOLDING = "taxWithholding";
    public static final String PROPERTY_PRORATETAX = "prorateTax";
    public static final String PROPERTY_PAYMENTTOEXTERNALPARTY =
    public static final String PROPERTY_BENEFICIARY = "beneficiary";
    public static final String PROPERTY_WITHHOLDINGPERCENTAGE =
    public static final String PROPERTY_PERCENT = "percent";
    public static final String PROPERTY_FIXAMOUNT = "fixAmount";
    public static final String PROPERTY_THRESHOLDMIN = "thresholdMin";
    public static final String PROPERTY_THRESHOLDMAX = "thresholdMax";
    public static final String PROPERTY_MINAMOUNT = "minAmount";
    public static final String PROPERTY_MAXAMOUNT = "maxAmount";
    public static final String PROPERTY_RATE = "rate";
    public Withholding() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_TAXWITHHOLDING, false);
        setDefaultValue(PROPERTY_PRORATETAX, false);
        setDefaultValue(PROPERTY_PAYMENTTOEXTERNALPARTY, false);
        setDefaultValue(PROPERTY_WITHHOLDINGPERCENTAGE, false);
        setDefaultValue(PROPERTY_RATE, new BigDecimal(0));
            new ArrayList<Object>());
    public String getEntityName() {
        return FinancialMgmtWithholding;
    public String getId() {
        return (String) get(PROPERTY_ID);
    public void setId(String id) {
        set(PROPERTY_ID, id);
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    public void setClient(Client client) {
        set(PROPERTY_CLIENT, client);
    public Organization getOrganization() {
        return (Organization) get(PROPERTY_ORGANIZATION);
    public void setOrganization(Organization organization) {
        set(PROPERTY_ORGANIZATION, organization);
    public Boolean isActive() {
        return (Boolean) get(PROPERTY_ACTIVE);
    public void setActive(Boolean active) {
        set(PROPERTY_ACTIVE, active);
    public Date getCreationDate() {
        return (Date) get(PROPERTY_CREATIONDATE);
    public void setCreationDate(Date creationDate) {
        set(PROPERTY_CREATIONDATE, creationDate);
    public User getCreatedBy() {
        return (User) get(PROPERTY_CREATEDBY);
    public void setCreatedBy(User createdBy) {
        set(PROPERTY_CREATEDBY, createdBy);
    public Date getUpdated() {
        return (Date) get(PROPERTY_UPDATED);
    public void setUpdated(Date updated) {
        set(PROPERTY_UPDATED, updated);
    public User getUpdatedBy() {
        return (User) get(PROPERTY_UPDATEDBY);
    public void setUpdatedBy(User updatedBy) {
        set(PROPERTY_UPDATEDBY, updatedBy);
    public String getName() {
        return (String) get(PROPERTY_NAME);
    public void setName(String name) {
        set(PROPERTY_NAME, name);
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    public PaymentTerm getPaymentTerms() {
        return (PaymentTerm) get(PROPERTY_PAYMENTTERMS);
    public void setPaymentTerms(PaymentTerm paymentTerms) {
        set(PROPERTY_PAYMENTTERMS, paymentTerms);
    public Boolean isTaxWithholding() {
        return (Boolean) get(PROPERTY_TAXWITHHOLDING);
    public void setTaxWithholding(Boolean taxWithholding) {
        set(PROPERTY_TAXWITHHOLDING, taxWithholding);
    public Boolean isProrateTax() {
        return (Boolean) get(PROPERTY_PRORATETAX);
    public void setProrateTax(Boolean prorateTax) {
        set(PROPERTY_PRORATETAX, prorateTax);
    public Boolean isPaymentToExternalParty() {
        return (Boolean) get(PROPERTY_PAYMENTTOEXTERNALPARTY);
    public void setPaymentToExternalParty(Boolean paymentToExternalParty) {
        set(PROPERTY_PAYMENTTOEXTERNALPARTY, paymentToExternalParty);
    public BusinessPartner getBeneficiary() {
        return (BusinessPartner) get(PROPERTY_BENEFICIARY);
    public void setBeneficiary(BusinessPartner beneficiary) {
        set(PROPERTY_BENEFICIARY, beneficiary);
    public Boolean isWithholdingPercentage() {
        return (Boolean) get(PROPERTY_WITHHOLDINGPERCENTAGE);
    public void setWithholdingPercentage(Boolean withholdingPercentage) {
        set(PROPERTY_WITHHOLDINGPERCENTAGE, withholdingPercentage);
    public BigDecimal getPercent() {
        return (BigDecimal) get(PROPERTY_PERCENT);
    public void setPercent(BigDecimal percent) {
        set(PROPERTY_PERCENT, percent);
    public BigDecimal getFixAmount() {
        return (BigDecimal) get(PROPERTY_FIXAMOUNT);
    public void setFixAmount(BigDecimal fixAmount) {
        set(PROPERTY_FIXAMOUNT, fixAmount);
    public BigDecimal getThresholdMin() {
        return (BigDecimal) get(PROPERTY_THRESHOLDMIN);
    public void setThresholdMin(BigDecimal thresholdMin) {
        set(PROPERTY_THRESHOLDMIN, thresholdMin);
    public BigDecimal getThresholdMax() {
        return (BigDecimal) get(PROPERTY_THRESHOLDMAX);
    public void setThresholdMax(BigDecimal thresholdMax) {
        set(PROPERTY_THRESHOLDMAX, thresholdMax);
    public BigDecimal getMinAmount() {
        return (BigDecimal) get(PROPERTY_MINAMOUNT);
    public void setMinAmount(BigDecimal minAmount) {
        set(PROPERTY_MINAMOUNT, minAmount);
    public BigDecimal getMaxAmount() {
        return (BigDecimal) get(PROPERTY_MAXAMOUNT);
    public void setMaxAmount(BigDecimal maxAmount) {
        set(PROPERTY_MAXAMOUNT, maxAmount);
    public BigDecimal getRate() {
        return (BigDecimal) get(PROPERTY_RATE);
    public void setRate(BigDecimal rate) {
        set(PROPERTY_RATE, rate);
    public List<WithholdingAccounts> getFinancialMgmtWithholdingAccountsList() {
        return (List<WithholdingAccounts>) get(PROPERTY_FINANCIALMGMTWITHHOLDINGACCOUNTSLIST);
    public void setFinancialMgmtWithholdingAccountsList(
        List<WithholdingAccounts> financialMgmtWithholdingAccountsList) {

Retrieved from ""

This page has been accessed 1,845 times. This page was last modified on 2 July 2011, at 21:58. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.