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

ERP/3.0/Developers Guide/Reference/Entity Model/OrderTax

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#OrderTax


OrderTax

The table constains the tax amount for an Order based on the lines entered.

To the database table (C_OrderTax) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_OrderTax_ID Mandatory
Max Length: 32
java.lang.String
salesOrder# C_Order_ID Mandatory
Order Unique identifier and a reference to a Sales Order originating from the document sequence defined for this document type.
tax# C_Tax_ID Mandatory
FinancialMgmtTaxRate 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.
updatedBy UpdatedBy Mandatory
ADUser The Updated By field indicates the user who updated this record.
taxableAmount TaxBaseAmt Mandatory
java.math.BigDecimal The Tax Base Amount indicates the base amount used for calculating the tax amount.
taxAmount TaxAmt Mandatory
java.math.BigDecimal The Tax Amount displays the total tax amount for a document.
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.


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-2020 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.common.order;
 
 import java.math.BigDecimal;
 import java.util.Date;
 
 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.enterprise.Organization;
 import org.openbravo.model.financialmgmt.tax.TaxRate;
 /**
  * Entity class for entity OrderTax (stored in table C_OrderTax).
  * <br>
  * Help: {@literal The table constains the tax amount for an Order based on the lines entered.}
  * <br>
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class OrderTax extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_OrderTax";
     public static final String ENTITY_NAME = "OrderTax";
 
     /**
      * Property id stored in column C_OrderTax_ID in table C_OrderTax 
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property salesOrder stored in column C_Order_ID in table C_OrderTax<br>
      * Help: {@literal Unique identifier and a reference to a Sales Order originating from the document sequence
      *       defined for this document type.}
      * 
      */
     public static final String PROPERTY_SALESORDER = "salesOrder";
 
     /**
      * Property tax stored in column C_Tax_ID in table C_OrderTax<br>
      * Help: {@literal The Tax indicates the type of tax for this document line.}
      * 
      */
     public static final String PROPERTY_TAX = "tax";
 
     /**
      * Property client stored in column AD_Client_ID in table C_OrderTax 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_OrderTax 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table C_OrderTax 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_OrderTax 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table C_OrderTax 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_OrderTax 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table C_OrderTax 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property taxableAmount stored in column TaxBaseAmt in table C_OrderTax<br>
      * Help: {@literal The Tax Base Amount indicates the base amount used for calculating the tax amount.}
      * 
      */
     public static final String PROPERTY_TAXABLEAMOUNT = "taxableAmount";
 
     /**
      * Property taxAmount stored in column TaxAmt in table C_OrderTax<br>
      * Help: {@literal The Tax Amount displays the total tax amount for a document.}
      * 
      */
     public static final String PROPERTY_TAXAMOUNT = "taxAmount";
 
     /**
      * Property lineNo stored in column Line in table C_OrderTax<br>
      * Help: {@literal Indicates the unique line for a document.  It will also control the display order of the
      *       lines within a document.}
      * 
      */
     public static final String PROPERTY_LINENO = "lineNo";
 
 
     public OrderTax() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_TAXABLEAMOUNT, new BigDecimal(0));
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see OrderTax#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see OrderTax#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see OrderTax#PROPERTY_SALESORDER
      * 
      */
     public Order getSalesOrder() {
         return (Order) get(PROPERTY_SALESORDER);
     }
     /**
      * @see OrderTax#PROPERTY_SALESORDER
      * 
      */
     public void setSalesOrder(Order salesOrder) {
         set(PROPERTY_SALESORDER, salesOrder);
     }
 
     /**
      * @see OrderTax#PROPERTY_TAX
      * 
      */
     public TaxRate getTax() {
         return (TaxRate) get(PROPERTY_TAX);
     }
     /**
      * @see OrderTax#PROPERTY_TAX
      * 
      */
     public void setTax(TaxRate tax) {
         set(PROPERTY_TAX, tax);
     }
 
     /**
      * @see OrderTax#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see OrderTax#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see OrderTax#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see OrderTax#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see OrderTax#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see OrderTax#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see OrderTax#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see OrderTax#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see OrderTax#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see OrderTax#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see OrderTax#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see OrderTax#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see OrderTax#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see OrderTax#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see OrderTax#PROPERTY_TAXABLEAMOUNT
      * 
      */
     public BigDecimal getTaxableAmount() {
         return (BigDecimal) get(PROPERTY_TAXABLEAMOUNT);
     }
     /**
      * @see OrderTax#PROPERTY_TAXABLEAMOUNT
      * 
      */
     public void setTaxableAmount(BigDecimal taxableAmount) {
         set(PROPERTY_TAXABLEAMOUNT, taxableAmount);
     }
 
     /**
      * @see OrderTax#PROPERTY_TAXAMOUNT
      * 
      */
     public BigDecimal getTaxAmount() {
         return (BigDecimal) get(PROPERTY_TAXAMOUNT);
     }
     /**
      * @see OrderTax#PROPERTY_TAXAMOUNT
      * 
      */
     public void setTaxAmount(BigDecimal taxAmount) {
         set(PROPERTY_TAXAMOUNT, taxAmount);
     }
 
     /**
      * @see OrderTax#PROPERTY_LINENO
      * 
      */
     public Long getLineNo() {
         return (Long) get(PROPERTY_LINENO);
     }
     /**
      * @see OrderTax#PROPERTY_LINENO
      * 
      */
     public void setLineNo(Long lineNo) {
         set(PROPERTY_LINENO, lineNo);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/OrderTax"

This page has been accessed 1,996 times. This page was last modified on 30 November 2020, at 01:55. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.