ERP/2.50/Developers Guide/Reference/Entity Model/FinancialMgmtTaxRate
FinancialMgmtTaxRate
The Tax Rate Window defines the different taxes used for each tax category.
To the database table (C_Tax) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | C_Tax_ID | Mandatory Max Length: 32 | java.lang.String | The Tax indicates the type of tax for this document line. |
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. |
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. |
updatedBy | UpdatedBy | Mandatory | ADUser | The Updated By field indicates the user who updated this record. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
taxSearchKey | TaxIndicator | Max Length: 5 | java.lang.String | The Tax Indicator identifies the short name that will print on documents referencing this tax. |
validFromDate | ValidFrom | Mandatory | java.util.Date | The Valid From date indicates the first day of a date range |
summaryLevel | IsSummary | Mandatory | java.lang.Boolean | A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values. |
rate | Rate | Mandatory | java.math.BigDecimal | The Rate indicates the percentage to be multiplied by the source to arrive at the tax or exchange amount. |
parentTaxRate | Parent_Tax_ID | FinancialMgmtTaxRate | The Parent Tax indicates a tax that is a reference for multiple taxes. This allows you to charge multiple taxes on a document by entering the Parent Tax | |
country | C_Country_ID | Country | The Country defines a Country. Each Country must be defined before it can be used in any document. | |
region | C_Region_ID | Region | The Region identifies a unique Region for this Country. | |
destinationCountry | To_Country_ID | Country | The To Country indicates the receiving country on a document | |
destinationRegion | To_Region_ID | Region | The To Region indicates the receiving region on a document | |
taxCategory# | C_TaxCategory_ID | Mandatory | FinancialMgmtTaxCategory | The Tax Category provides a method of grouping similar taxes. For example, Sales Tax or Value Added Tax. |
default | IsDefault | Mandatory | java.lang.Boolean | The Default Checkbox indicates if this record will be used as a default value. |
taxExempt | IsTaxExempt | Mandatory | java.lang.Boolean | If a business partner is exempt from tax, the exempt tax rate is used. For this, you need to set up a tax rate with a 0% rate and indicate that this is your tax exempt rate. This is required for tax reporting, so that you can track tax exempt transactions. |
salesPurchaseType | SOPOType | Mandatory Max Length: 60 | java.lang.String | Sales Tax: charged when selling - examples: Sales Tax, Output VAT (payable)Purchase Tax: tax charged when purchasing - examples: Use Tax, Input VAT (receivable) |
cascade | Cascade | java.lang.Boolean | Indicates if it is applied in an accumulative way or if it is applied to the base amount. | |
businessPartnerTaxCategory | C_BP_TaxCategory_ID | BusinessPartnerTaxCategory | Bussines Partner Tax Category is a category defined for applying default taxes to procurement transactions. | |
lineNo | Line | java.lang.Long | Indicates the unique line for a document. It will also control the display order of the lines within a document. | |
withholdingTax | IsWithholdingTax | java.lang.Boolean | Describe if the tax is included in the Withholding's Calculation. | |
notTaxable | IsNoTaxable | java.lang.Boolean | Check if it is not taxable | |
deductableRate | Deducpercent | java.math.BigDecimal | It is the deductable percentage | |
originalRate | Originalrate | java.math.BigDecimal | Original Rate | |
notTaxdeductable | IsTaxUndeductable | java.lang.Boolean | Check it if the tax is not deductible | |
istaxdeductable | IsTaxDeductable | java.lang.Boolean | If active, this rate will behave as a tax deductible rate, no matter if the organization where used is tax deductible or not. | |
noVAT | IsNoVAT | java.lang.Boolean | Is no VAT | |
baseAmount | BaseAmount | Mandatory Max Length: 10 | java.lang.String | Base Amount to be used as base for the calculation. Line net amount or alternate line net amount can be selected as base for the tax calculation. |
taxBase | C_TaxBase_ID | FinancialMgmtTaxRate | The amount of the tax selected here will be used as tax base amount for the tax calculation. | |
docTaxAmount | DocTaxAmount | Mandatory Max Length: 60 | java.lang.String | Criteria used for the calculation of tax base amount at document level. |
financialMgmtTaxTrlList | List of FinancialMgmtTaxTrl | |||
financialMgmtTaxZoneList | List of FinancialMgmtTaxZone | |||
financialMgmtTaxRateAccountsList | List of FinancialMgmtTaxRateAccounts |
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 http://www.openbravo.com/legal/license.html * 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): ______________________________________. ************************************************************************ */ package org.openbravo.model.financialmgmt.tax; 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.ad.access.User; import org.openbravo.model.ad.system.Client; import org.openbravo.model.common.businesspartner.TaxCategory; import org.openbravo.model.common.enterprise.Organization; import org.openbravo.model.common.geography.Country; import org.openbravo.model.common.geography.Region; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.math.BigDecimal; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity FinancialMgmtTaxRate (stored in table C_Tax). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class TaxRate extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "C_Tax"; public static final String FinancialMgmtTaxRate = "FinancialMgmtTaxRate"; 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_NAME = "name"; public static final String PROPERTY_UPDATEDBY = "updatedBy"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_TAXSEARCHKEY = "taxSearchKey"; public static final String PROPERTY_VALIDFROMDATE = "validFromDate"; public static final String PROPERTY_SUMMARYLEVEL = "summaryLevel"; public static final String PROPERTY_RATE = "rate"; public static final String PROPERTY_PARENTTAXRATE = "parentTaxRate"; public static final String PROPERTY_COUNTRY = "country"; public static final String PROPERTY_REGION = "region"; public static final String PROPERTY_DESTINATIONCOUNTRY = "destinationCountry"; public static final String PROPERTY_DESTINATIONREGION = "destinationRegion"; public static final String PROPERTY_TAXCATEGORY = "taxCategory"; public static final String PROPERTY_DEFAULT = "default"; public static final String PROPERTY_TAXEXEMPT = "taxExempt"; public static final String PROPERTY_SALESPURCHASETYPE = "salesPurchaseType"; public static final String PROPERTY_CASCADE = "cascade"; public static final String PROPERTY_BUSINESSPARTNERTAXCATEGORY = "businessPartnerTaxCategory"; public static final String PROPERTY_LINENO = "lineNo"; public static final String PROPERTY_WITHHOLDINGTAX = "withholdingTax"; public static final String PROPERTY_NOTTAXABLE = "notTaxable"; public static final String PROPERTY_DEDUCTABLERATE = "deductableRate"; public static final String PROPERTY_ORIGINALRATE = "originalRate"; public static final String PROPERTY_NOTTAXDEDUCTABLE = "notTaxdeductable"; public static final String PROPERTY_ISTAXDEDUCTABLE = "istaxdeductable"; public static final String PROPERTY_NOVAT = "noVAT"; public static final String PROPERTY_BASEAMOUNT = "baseAmount"; public static final String PROPERTY_TAXBASE = "taxBase"; public static final String PROPERTY_DOCTAXAMOUNT = "docTaxAmount"; public static final String PROPERTY_FINANCIALMGMTTAXTRLLIST = "financialMgmtTaxTrlList"; public static final String PROPERTY_FINANCIALMGMTTAXZONELIST = "financialMgmtTaxZoneList"; public static final String PROPERTY_FINANCIALMGMTTAXRATEACCOUNTSLIST = "financialMgmtTaxRateAccountsList"; public TaxRate() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_SUMMARYLEVEL, false); setDefaultValue(PROPERTY_DEFAULT, false); setDefaultValue(PROPERTY_TAXEXEMPT, false); setDefaultValue(PROPERTY_SALESPURCHASETYPE, "B"); setDefaultValue(PROPERTY_CASCADE, false); setDefaultValue(PROPERTY_WITHHOLDINGTAX, false); setDefaultValue(PROPERTY_NOTTAXABLE, false); setDefaultValue(PROPERTY_NOTTAXDEDUCTABLE, false); setDefaultValue(PROPERTY_ISTAXDEDUCTABLE, false); setDefaultValue(PROPERTY_NOVAT, false); setDefaultValue(PROPERTY_BASEAMOUNT, "LNA"); setDefaultValue(PROPERTY_DOCTAXAMOUNT, "D"); setDefaultValue(PROPERTY_FINANCIALMGMTTAXTRLLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_FINANCIALMGMTTAXZONELIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_FINANCIALMGMTTAXRATEACCOUNTSLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return FinancialMgmtTaxRate; } 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 String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getTaxSearchKey() { return (String) get(PROPERTY_TAXSEARCHKEY); } public void setTaxSearchKey(String taxSearchKey) { set(PROPERTY_TAXSEARCHKEY, taxSearchKey); } public Date getValidFromDate() { return (Date) get(PROPERTY_VALIDFROMDATE); } public void setValidFromDate(Date validFromDate) { set(PROPERTY_VALIDFROMDATE, validFromDate); } public Boolean isSummaryLevel() { return (Boolean) get(PROPERTY_SUMMARYLEVEL); } public void setSummaryLevel(Boolean summaryLevel) { set(PROPERTY_SUMMARYLEVEL, summaryLevel); } public BigDecimal getRate() { return (BigDecimal) get(PROPERTY_RATE); } public void setRate(BigDecimal rate) { set(PROPERTY_RATE, rate); } public TaxRate getParentTaxRate() { return (TaxRate) get(PROPERTY_PARENTTAXRATE); } public void setParentTaxRate(TaxRate parentTaxRate) { set(PROPERTY_PARENTTAXRATE, parentTaxRate); } public Country getCountry() { return (Country) get(PROPERTY_COUNTRY); } public void setCountry(Country country) { set(PROPERTY_COUNTRY, country); } public Region getRegion() { return (Region) get(PROPERTY_REGION); } public void setRegion(Region region) { set(PROPERTY_REGION, region); } public Country getDestinationCountry() { return (Country) get(PROPERTY_DESTINATIONCOUNTRY); } public void setDestinationCountry(Country destinationCountry) { set(PROPERTY_DESTINATIONCOUNTRY, destinationCountry); } public Region getDestinationRegion() { return (Region) get(PROPERTY_DESTINATIONREGION); } public void setDestinationRegion(Region destinationRegion) { set(PROPERTY_DESTINATIONREGION, destinationRegion); } public org.openbravo.model.financialmgmt.tax.TaxCategory getTaxCategory() { return (org.openbravo.model.financialmgmt.tax.TaxCategory) get(PROPERTY_TAXCATEGORY); } public void setTaxCategory( org.openbravo.model.financialmgmt.tax.TaxCategory taxCategory) { set(PROPERTY_TAXCATEGORY, taxCategory); } public Boolean isDefault() { return (Boolean) get(PROPERTY_DEFAULT); } public void setDefault(Boolean deflt) { set(PROPERTY_DEFAULT, deflt); } public Boolean isTaxExempt() { return (Boolean) get(PROPERTY_TAXEXEMPT); } public void setTaxExempt(Boolean taxExempt) { set(PROPERTY_TAXEXEMPT, taxExempt); } public String getSalesPurchaseType() { return (String) get(PROPERTY_SALESPURCHASETYPE); } public void setSalesPurchaseType(String salesPurchaseType) { set(PROPERTY_SALESPURCHASETYPE, salesPurchaseType); } public Boolean isCascade() { return (Boolean) get(PROPERTY_CASCADE); } public void setCascade(Boolean cascade) { set(PROPERTY_CASCADE, cascade); } public TaxCategory getBusinessPartnerTaxCategory() { return (TaxCategory) get(PROPERTY_BUSINESSPARTNERTAXCATEGORY); } public void setBusinessPartnerTaxCategory( TaxCategory businessPartnerTaxCategory) { set(PROPERTY_BUSINESSPARTNERTAXCATEGORY, businessPartnerTaxCategory); } public Long getLineNo() { return (Long) get(PROPERTY_LINENO); } public void setLineNo(Long lineNo) { set(PROPERTY_LINENO, lineNo); } public Boolean isWithholdingTax() { return (Boolean) get(PROPERTY_WITHHOLDINGTAX); } public void setWithholdingTax(Boolean withholdingTax) { set(PROPERTY_WITHHOLDINGTAX, withholdingTax); } public Boolean isNotTaxable() { return (Boolean) get(PROPERTY_NOTTAXABLE); } public void setNotTaxable(Boolean notTaxable) { set(PROPERTY_NOTTAXABLE, notTaxable); } public BigDecimal getDeductableRate() { return (BigDecimal) get(PROPERTY_DEDUCTABLERATE); } public void setDeductableRate(BigDecimal deductableRate) { set(PROPERTY_DEDUCTABLERATE, deductableRate); } public BigDecimal getOriginalRate() { return (BigDecimal) get(PROPERTY_ORIGINALRATE); } public void setOriginalRate(BigDecimal originalRate) { set(PROPERTY_ORIGINALRATE, originalRate); } public Boolean isNotTaxdeductable() { return (Boolean) get(PROPERTY_NOTTAXDEDUCTABLE); } public void setNotTaxdeductable(Boolean notTaxdeductable) { set(PROPERTY_NOTTAXDEDUCTABLE, notTaxdeductable); } public Boolean isTaxdeductable() { return (Boolean) get(PROPERTY_ISTAXDEDUCTABLE); } public void setTaxdeductable(Boolean istaxdeductable) { set(PROPERTY_ISTAXDEDUCTABLE, istaxdeductable); } public Boolean isNoVAT() { return (Boolean) get(PROPERTY_NOVAT); } public void setNoVAT(Boolean noVAT) { set(PROPERTY_NOVAT, noVAT); } public String getBaseAmount() { return (String) get(PROPERTY_BASEAMOUNT); } public void setBaseAmount(String baseAmount) { set(PROPERTY_BASEAMOUNT, baseAmount); } public TaxRate getTaxBase() { return (TaxRate) get(PROPERTY_TAXBASE); } public void setTaxBase(TaxRate taxBase) { set(PROPERTY_TAXBASE, taxBase); } public String getDocTaxAmount() { return (String) get(PROPERTY_DOCTAXAMOUNT); } public void setDocTaxAmount(String docTaxAmount) { set(PROPERTY_DOCTAXAMOUNT, docTaxAmount); } @SuppressWarnings("unchecked") public List<TaxTrl> getFinancialMgmtTaxTrlList() { return (List<TaxTrl>) get(PROPERTY_FINANCIALMGMTTAXTRLLIST); } public void setFinancialMgmtTaxTrlList(List<TaxTrl> financialMgmtTaxTrlList) { set(PROPERTY_FINANCIALMGMTTAXTRLLIST, financialMgmtTaxTrlList); } @SuppressWarnings("unchecked") public List<TaxZone> getFinancialMgmtTaxZoneList() { return (List<TaxZone>) get(PROPERTY_FINANCIALMGMTTAXZONELIST); } public void setFinancialMgmtTaxZoneList( List<TaxZone> financialMgmtTaxZoneList) { set(PROPERTY_FINANCIALMGMTTAXZONELIST, financialMgmtTaxZoneList); } @SuppressWarnings("unchecked") public List<TaxRateAccounts> getFinancialMgmtTaxRateAccountsList() { return (List<TaxRateAccounts>) get(PROPERTY_FINANCIALMGMTTAXRATEACCOUNTSLIST); } public void setFinancialMgmtTaxRateAccountsList( List<TaxRateAccounts> financialMgmtTaxRateAccountsList) { set(PROPERTY_FINANCIALMGMTTAXRATEACCOUNTSLIST, financialMgmtTaxRateAccountsList); } }