Log in / create account
View source | Discuss this page | Page history | Printable version   

ERP 2.50:Developers Guide/Reference/Entity Model/SalesCommissionLine

SalesCommissionLine

Define the selection criteria for paying the commission. If you do not enter restricting parameters (e.g. for specific Business Partner (Groups) or Product (Categories), etc. all transactions for the period will be used to calculate the commission.

To the database table (C_CommissionLine) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* C_CommissionLine_ID Mandatory
Max Length: 32 		java.lang.String 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.
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.
commission# C_Commission_ID Mandatory SalesCommission The Commission ID is a unique identifier of a set of commission rules.
lineNo# Line Mandatory java.lang.Long Indicates the unique line for a document. It will also control the display order of the lines within a document.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
subtractAmount AmtSubtract Mandatory java.math.BigDecimal The Subtract Amount indicates the amount to subtract from the total amount prior to multiplication.
multiplierAmount AmtMultiplier Mandatory java.math.BigDecimal The Multiplier Amount indicates the amount to multiply the total amount generated by this commission run by.
subtractQuantity QtySubtract Mandatory java.math.BigDecimal The Quantity Subtract identifies the quantity to be subtracted before multiplication
multiplierQuantity QtyMultiplier Mandatory java.math.BigDecimal The Multiplier Quantity field indicates the amount to multiply the quantities accumulated for this commission run.
positiveOnly IsPositiveOnly Mandatory java.lang.Boolean The Positive Only check box indicates that if the result of the subtraction is negative, it is ignored. This would mean that negative commissions would not be generated.
commissionOnlySpecifiedOrders CommissionOrders Mandatory java.lang.Boolean Sales Reps are entered in Orders and Invoices. If selected, only Orders and Invoices for this Sales Reps are included in the calculation of the commission.
trxOrganization Org_ID Organization An organization is a unit of your client or legal entity - examples are store, department.
productCategory M_Product_Category_ID ProductCategory Identifies the category which this product belongs to. Product categories are used for pricing.
product M_Product_ID Product Identifies an item which is either purchased or sold in this organization.
businessPartnerCategory C_BP_Group_ID BusinessPartnerCategory A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners.
businessPartner C_BPartner_ID BusinessPartner A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these.
salesRegion C_SalesRegion_ID SalesRegion The Sales Region indicates a specific area of sales coverage.

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.businesspartner.BusinessPartner;
import org.openbravo.model.common.businesspartner.Category;
import org.openbravo.model.common.enterprise.Organization;
import org.openbravo.model.common.plm.Product;
import org.openbravo.model.common.plm.ProductCategory;
 
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
 
import java.math.BigDecimal;
 
import java.util.Date;
 
/**
 * Entity class for entity SalesCommissionLine (stored in table C_CommissionLine).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class CommissionLine extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_CommissionLine";
    public static final String SalesCommissionLine = "SalesCommissionLine";
    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_COMMISSION = "commission";
    public static final String PROPERTY_LINENO = "lineNo";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_SUBTRACTAMOUNT = "subtractAmount";
    public static final String PROPERTY_MULTIPLIERAMOUNT = "multiplierAmount";
    public static final String PROPERTY_SUBTRACTQUANTITY = "subtractQuantity";
    public static final String PROPERTY_MULTIPLIERQUANTITY =
        "multiplierQuantity";
    public static final String PROPERTY_POSITIVEONLY = "positiveOnly";
    public static final String PROPERTY_COMMISSIONONLYSPECIFIEDORDERS =
        "commissionOnlySpecifiedOrders";
    public static final String PROPERTY_TRXORGANIZATION = "trxOrganization";
    public static final String PROPERTY_PRODUCTCATEGORY = "productCategory";
    public static final String PROPERTY_PRODUCT = "product";
    public static final String PROPERTY_BUSINESSPARTNERCATEGORY =
        "businessPartnerCategory";
    public static final String PROPERTY_BUSINESSPARTNER = "businessPartner";
    public static final String PROPERTY_SALESREGION = "salesRegion";
 
    public CommissionLine() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_POSITIVEONLY, false);
        setDefaultValue(PROPERTY_COMMISSIONONLYSPECIFIEDORDERS, false);
    }
 
    @Override
    public String getEntityName() {
        return SalesCommissionLine;
    }
 
    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 Commission getCommission() {
        return (Commission) get(PROPERTY_COMMISSION);
    }
 
    public void setCommission(Commission commission) {
        set(PROPERTY_COMMISSION, commission);
    }
 
    public Long getLineNo() {
        return (Long) get(PROPERTY_LINENO);
    }
 
    public void setLineNo(Long lineNo) {
        set(PROPERTY_LINENO, lineNo);
    }
 
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    }
 
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    }
 
    public BigDecimal getSubtractAmount() {
        return (BigDecimal) get(PROPERTY_SUBTRACTAMOUNT);
    }
 
    public void setSubtractAmount(BigDecimal subtractAmount) {
        set(PROPERTY_SUBTRACTAMOUNT, subtractAmount);
    }
 
    public BigDecimal getMultiplierAmount() {
        return (BigDecimal) get(PROPERTY_MULTIPLIERAMOUNT);
    }
 
    public void setMultiplierAmount(BigDecimal multiplierAmount) {
        set(PROPERTY_MULTIPLIERAMOUNT, multiplierAmount);
    }
 
    public BigDecimal getSubtractQuantity() {
        return (BigDecimal) get(PROPERTY_SUBTRACTQUANTITY);
    }
 
    public void setSubtractQuantity(BigDecimal subtractQuantity) {
        set(PROPERTY_SUBTRACTQUANTITY, subtractQuantity);
    }
 
    public BigDecimal getMultiplierQuantity() {
        return (BigDecimal) get(PROPERTY_MULTIPLIERQUANTITY);
    }
 
    public void setMultiplierQuantity(BigDecimal multiplierQuantity) {
        set(PROPERTY_MULTIPLIERQUANTITY, multiplierQuantity);
    }
 
    public Boolean isPositiveOnly() {
        return (Boolean) get(PROPERTY_POSITIVEONLY);
    }
 
    public void setPositiveOnly(Boolean positiveOnly) {
        set(PROPERTY_POSITIVEONLY, positiveOnly);
    }
 
    public Boolean isCommissionOnlySpecifiedOrders() {
        return (Boolean) get(PROPERTY_COMMISSIONONLYSPECIFIEDORDERS);
    }
 
    public void setCommissionOnlySpecifiedOrders(
        Boolean commissionOnlySpecifiedOrders) {
        set(PROPERTY_COMMISSIONONLYSPECIFIEDORDERS,
            commissionOnlySpecifiedOrders);
    }
 
    public Organization getTrxOrganization() {
        return (Organization) get(PROPERTY_TRXORGANIZATION);
    }
 
    public void setTrxOrganization(Organization trxOrganization) {
        set(PROPERTY_TRXORGANIZATION, trxOrganization);
    }
 
    public ProductCategory getProductCategory() {
        return (ProductCategory) get(PROPERTY_PRODUCTCATEGORY);
    }
 
    public void setProductCategory(ProductCategory productCategory) {
        set(PROPERTY_PRODUCTCATEGORY, productCategory);
    }
 
    public Product getProduct() {
        return (Product) get(PROPERTY_PRODUCT);
    }
 
    public void setProduct(Product product) {
        set(PROPERTY_PRODUCT, product);
    }
 
    public Category getBusinessPartnerCategory() {
        return (Category) get(PROPERTY_BUSINESSPARTNERCATEGORY);
    }
 
    public void setBusinessPartnerCategory(Category businessPartnerCategory) {
        set(PROPERTY_BUSINESSPARTNERCATEGORY, businessPartnerCategory);
    }
 
    public BusinessPartner getBusinessPartner() {
        return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER);
    }
 
    public void setBusinessPartner(BusinessPartner businessPartner) {
        set(PROPERTY_BUSINESSPARTNER, businessPartner);
    }
 
    public SalesRegion getSalesRegion() {
        return (SalesRegion) get(PROPERTY_SALESREGION);
    }
 
    public void setSalesRegion(SalesRegion salesRegion) {
        set(PROPERTY_SALESREGION, salesRegion);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP_2.50:Developers_Guide/Reference/Entity_Model/SalesCommissionLine"

This page has been accessed 1,260 times. This page was last modified on 14 June 2011, at 11:04. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.