ERP 2.50:Developers Guide/Reference/Entity Model/SalesCommissionAmount
SalesCommissionAmount
Contains all the commission lines amounts
To the database table (C_CommissionAmt) 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_CommissionAmt_ID | Mandatory Max Length: 32 | java.lang.String | The Commission Amount indicates the resulting amount from a Commission Run. |
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. |
commissionRun# | C_CommissionRun_ID | Mandatory | SalesCommissionRun | The Commission Run is a unique system defined identifier of a specific run of commission. When a Commission is processed on the Commission Screen, the Commission Run ID will display. |
commissionLine# | C_CommissionLine_ID | Mandatory | SalesCommissionLine | The Commission Line is a unique instance of a Commission Run. If the commission run was done in summary mode then there will be a single line representing the selected documents totals. If the commission run was done in detail mode then each document that was included in the run will have its own commission line. |
convertedAmount | ConvertedAmt | Mandatory | java.math.BigDecimal | The Converted Amount is the result of multiplying the Source Amount by the Conversion Rate for this target currency. |
actualQuantity | ActualQty | Mandatory | java.math.BigDecimal | The Actual Quantity indicates the quantity as referenced on a document. |
amount | CommissionAmt | Mandatory | java.math.BigDecimal | The Commission Amount is the total calculated commission. It is based on the parameters as defined for this Commission Run. |
salesCommissionDetailList | List of SalesCommissionDetail |
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.sales; 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 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 SalesCommissionAmount (stored in table C_CommissionAmt). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class CommissionAmount extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "C_CommissionAmt"; public static final String SalesCommissionAmount = "SalesCommissionAmount"; 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_COMMISSIONRUN = "commissionRun"; public static final String PROPERTY_COMMISSIONLINE = "commissionLine"; public static final String PROPERTY_CONVERTEDAMOUNT = "convertedAmount"; public static final String PROPERTY_ACTUALQUANTITY = "actualQuantity"; public static final String PROPERTY_AMOUNT = "amount"; public static final String PROPERTY_SALESCOMMISSIONDETAILLIST = "salesCommissionDetailList"; public CommissionAmount() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_SALESCOMMISSIONDETAILLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return SalesCommissionAmount; } 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 CommissionRun getCommissionRun() { return (CommissionRun) get(PROPERTY_COMMISSIONRUN); } public void setCommissionRun(CommissionRun commissionRun) { set(PROPERTY_COMMISSIONRUN, commissionRun); } public CommissionLine getCommissionLine() { return (CommissionLine) get(PROPERTY_COMMISSIONLINE); } public void setCommissionLine(CommissionLine commissionLine) { set(PROPERTY_COMMISSIONLINE, commissionLine); } public BigDecimal getConvertedAmount() { return (BigDecimal) get(PROPERTY_CONVERTEDAMOUNT); } public void setConvertedAmount(BigDecimal convertedAmount) { set(PROPERTY_CONVERTEDAMOUNT, convertedAmount); } public BigDecimal getActualQuantity() { return (BigDecimal) get(PROPERTY_ACTUALQUANTITY); } public void setActualQuantity(BigDecimal actualQuantity) { set(PROPERTY_ACTUALQUANTITY, actualQuantity); } public BigDecimal getAmount() { return (BigDecimal) get(PROPERTY_AMOUNT); } public void setAmount(BigDecimal amount) { set(PROPERTY_AMOUNT, amount); } @SuppressWarnings("unchecked") public List<CommissionDetail> getSalesCommissionDetailList() { return (List<CommissionDetail>) get(PROPERTY_SALESCOMMISSIONDETAILLIST); } public void setSalesCommissionDetailList( List<CommissionDetail> salesCommissionDetailList) { set(PROPERTY_SALESCOMMISSIONDETAILLIST, salesCommissionDetailList); } }