View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

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

FinancialMgmtSettlement

Termination of a business operation by using its assets to discharge its liabilities. For example, once the goods have been shipped to the customer, the merchant can key a transaction for settlement at which time the customer's credit card is charged for the transaction and the proceeds are deposited into the merchant account.

To the database table (C_Settlement) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* C_Settlement_ID Mandatory
Max Length: 32
java.lang.String Termination of a business operation by using its assets to discharge its liabilities.
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.
documentNo# DocumentNo Mandatory
Max Length: 30
java.lang.String The document number is usually automatically generated by the system and determined by the document type of the document. If the document is not saved, the preliminary number is displayed in "<>". If the document type of your document has no automatic document sequence defined, the field will be empty when creating a new document. This is for documents which usually have an external number (like vendor invoice). If you leave the field empty, the system will generate a document number for you. The document sequence used for this fallback number is defined in the "Document Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table inside the database (e.g. C_Order).
transactionDate# DateTrx Mandatory java.util.Date The Transaction Date indicates the date of the transaction.
documentType C_DocType_ID Mandatory DocumentType The Document Type determines document sequence and processing rules
processNow Processing java.lang.Boolean When this field is set as 'Y' a process is being performed on this record.
processed Processed Mandatory
Max Length: 60
java.lang.String The Processed checkbox indicates that a document has been processed.
posted Posted Mandatory
Max Length: 60
java.lang.String An accounting status button that indicates if the transaction has already been posted to the general ledger or not. When doing the accounting manually this button can be used to post or unpost the transaction from the general ledger by hand.
project C_Project_ID Project Identifier of a project defined within the Project & Service Management module.
salesCampaign C_Campaign_ID MarketingCampaign The Campaign defines a unique marketing program. Projects can be associated with a pre defined Marketing Campaign. You can then report based on a specific Campaign.
activity C_Activity_ID MaterialMgmtABCActivity Activities indicate tasks that are performed and used to utilize Activity based Costing
stDimension User1_ID Max Length: 12 java.lang.String The user defined element displays the optional elements that have been defined for this account combination.
ndDimension User2_ID Max Length: 12 java.lang.String The user defined element displays the optional elements that have been defined for this account combination.
createLinesFrom CreateFrom java.lang.Boolean A process that allows the user to copy lines (products) from an existing document different from the one being copied into. For example, in case of entering a new Goods Shipment, the user can copy lines (products) from an existing Sales Order or Sales Invoice.
currency C_Currency_ID Mandatory Currency Indicates the currency to be used when processing this document.
canceledNotCharged Cancelednotchargeamt java.math.BigDecimal Indicates the amount that has been canceled but has generated no charges in the bank account or cash.
createdAmount Generatedamt java.math.BigDecimal Indicates the total amount of the payments that have been generated in this settlement.
chargedAmount Chargedamt java.math.BigDecimal Indicates the total amount of the payments that have been canceled and charged.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
createFile CreateFile Mandatory java.lang.Boolean Create file
accountingDate DateAcct java.util.Date The date this transaction is recorded on in the general ledger. This date also indicates which accounting period within the fiscal year this transaction will be part of.
settlementType Settlementtype Max Length: 60 java.lang.String Indicates the type of settlement (settlement or manual settlement)
openSettlement SettlementOpen java.lang.Boolean
copyFrom CopyFrom Mandatory java.lang.Boolean Copy lines (products) from another document of the same type.
generated IsGenerated java.lang.Boolean The Generated checkbox identifies a journal line that was generated from a source document. Lines could also be entered manually or imported.
template IsTemplate java.lang.Boolean Template is checked when the element is used as a template.
financialMgmtDebtPaymentCancelVList List of FinancialMgmtDebtPaymentCancelV
financialMgmtDebtPaymentGenerateVList List of FinancialMgmtDebtPaymentGenerateV
financialMgmtDebtPaymentSettlementCancelledList List of FinancialMgmtDebtPayment
financialMgmtDebtPaymentCSettlementGenerateIDList List of FinancialMgmtDebtPayment

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.payment;
 
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.currency.Currency;
import org.openbravo.model.common.enterprise.DocumentType;
import org.openbravo.model.common.enterprise.Organization;
import org.openbravo.model.marketing.Campaign;
import org.openbravo.model.materialmgmt.cost.ABCActivity;
import org.openbravo.model.project.Project;
 
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 FinancialMgmtSettlement (stored in table C_Settlement).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class Settlement extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_Settlement";
    public static final String FinancialMgmtSettlement = "FinancialMgmtSettlement";
    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_DOCUMENTNO = "documentNo";
    public static final String PROPERTY_TRANSACTIONDATE = "transactionDate";
    public static final String PROPERTY_DOCUMENTTYPE = "documentType";
    public static final String PROPERTY_PROCESSNOW = "processNow";
    public static final String PROPERTY_PROCESSED = "processed";
    public static final String PROPERTY_POSTED = "posted";
    public static final String PROPERTY_PROJECT = "project";
    public static final String PROPERTY_SALESCAMPAIGN = "salesCampaign";
    public static final String PROPERTY_ACTIVITY = "activity";
    public static final String PROPERTY_STDIMENSION = "stDimension";
    public static final String PROPERTY_NDDIMENSION = "ndDimension";
    public static final String PROPERTY_CREATELINESFROM = "createLinesFrom";
    public static final String PROPERTY_CURRENCY = "currency";
    public static final String PROPERTY_CANCELEDNOTCHARGED =
        "canceledNotCharged";
    public static final String PROPERTY_CREATEDAMOUNT = "createdAmount";
    public static final String PROPERTY_CHARGEDAMOUNT = "chargedAmount";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_CREATEFILE = "createFile";
    public static final String PROPERTY_ACCOUNTINGDATE = "accountingDate";
    public static final String PROPERTY_SETTLEMENTTYPE = "settlementType";
    public static final String PROPERTY_OPENSETTLEMENT = "openSettlement";
    public static final String PROPERTY_COPYFROM = "copyFrom";
    public static final String PROPERTY_GENERATED = "generated";
    public static final String PROPERTY_TEMPLATE = "template";
    public static final String PROPERTY_FINANCIALMGMTDEBTPAYMENTCANCELVLIST =
        "financialMgmtDebtPaymentCancelVList";
    public static final String PROPERTY_FINANCIALMGMTDEBTPAYMENTGENERATEVLIST =
        "financialMgmtDebtPaymentGenerateVList";
    public static final String PROPERTY_FINANCIALMGMTDEBTPAYMENTSETTLEMENTCANCELLEDLIST =
        "financialMgmtDebtPaymentSettlementCancelledList";
    public static final String PROPERTY_FINANCIALMGMTDEBTPAYMENTCSETTLEMENTGENERATEIDLIST =
        "financialMgmtDebtPaymentCSettlementGenerateIDList";
 
    public Settlement() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_PROCESSNOW, false);
        setDefaultValue(PROPERTY_PROCESSED, "N");
        setDefaultValue(PROPERTY_POSTED, "N");
        setDefaultValue(PROPERTY_CREATELINESFROM, false);
        setDefaultValue(PROPERTY_CANCELEDNOTCHARGED, new BigDecimal(0));
        setDefaultValue(PROPERTY_CREATEDAMOUNT, new BigDecimal(0));
        setDefaultValue(PROPERTY_CHARGEDAMOUNT, new BigDecimal(0));
        setDefaultValue(PROPERTY_CREATEFILE, false);
        setDefaultValue(PROPERTY_OPENSETTLEMENT, false);
        setDefaultValue(PROPERTY_COPYFROM, false);
        setDefaultValue(PROPERTY_GENERATED, false);
        setDefaultValue(PROPERTY_TEMPLATE, false);
        setDefaultValue(PROPERTY_FINANCIALMGMTDEBTPAYMENTCANCELVLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTDEBTPAYMENTGENERATEVLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTDEBTPAYMENTSETTLEMENTCANCELLEDLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTDEBTPAYMENTCSETTLEMENTGENERATEIDLIST,
            new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return FinancialMgmtSettlement;
    }
 
    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 getDocumentNo() {
        return (String) get(PROPERTY_DOCUMENTNO);
    }
 
    public void setDocumentNo(String documentNo) {
        set(PROPERTY_DOCUMENTNO, documentNo);
    }
 
    public Date getTransactionDate() {
        return (Date) get(PROPERTY_TRANSACTIONDATE);
    }
 
    public void setTransactionDate(Date transactionDate) {
        set(PROPERTY_TRANSACTIONDATE, transactionDate);
    }
 
    public DocumentType getDocumentType() {
        return (DocumentType) get(PROPERTY_DOCUMENTTYPE);
    }
 
    public void setDocumentType(DocumentType documentType) {
        set(PROPERTY_DOCUMENTTYPE, documentType);
    }
 
    public Boolean isProcessNow() {
        return (Boolean) get(PROPERTY_PROCESSNOW);
    }
 
    public void setProcessNow(Boolean processNow) {
        set(PROPERTY_PROCESSNOW, processNow);
    }
 
    public String getProcessed() {
        return (String) get(PROPERTY_PROCESSED);
    }
 
    public void setProcessed(String processed) {
        set(PROPERTY_PROCESSED, processed);
    }
 
    public String getPosted() {
        return (String) get(PROPERTY_POSTED);
    }
 
    public void setPosted(String posted) {
        set(PROPERTY_POSTED, posted);
    }
 
    public Project getProject() {
        return (Project) get(PROPERTY_PROJECT);
    }
 
    public void setProject(Project project) {
        set(PROPERTY_PROJECT, project);
    }
 
    public Campaign getSalesCampaign() {
        return (Campaign) get(PROPERTY_SALESCAMPAIGN);
    }
 
    public void setSalesCampaign(Campaign salesCampaign) {
        set(PROPERTY_SALESCAMPAIGN, salesCampaign);
    }
 
    public ABCActivity getActivity() {
        return (ABCActivity) get(PROPERTY_ACTIVITY);
    }
 
    public void setActivity(ABCActivity activity) {
        set(PROPERTY_ACTIVITY, activity);
    }
 
    public String getStDimension() {
        return (String) get(PROPERTY_STDIMENSION);
    }
 
    public void setStDimension(String stDimension) {
        set(PROPERTY_STDIMENSION, stDimension);
    }
 
    public String getNdDimension() {
        return (String) get(PROPERTY_NDDIMENSION);
    }
 
    public void setNdDimension(String ndDimension) {
        set(PROPERTY_NDDIMENSION, ndDimension);
    }
 
    public Boolean isCreateLinesFrom() {
        return (Boolean) get(PROPERTY_CREATELINESFROM);
    }
 
    public void setCreateLinesFrom(Boolean createLinesFrom) {
        set(PROPERTY_CREATELINESFROM, createLinesFrom);
    }
 
    public Currency getCurrency() {
        return (Currency) get(PROPERTY_CURRENCY);
    }
 
    public void setCurrency(Currency currency) {
        set(PROPERTY_CURRENCY, currency);
    }
 
    public BigDecimal getCanceledNotCharged() {
        return (BigDecimal) get(PROPERTY_CANCELEDNOTCHARGED);
    }
 
    public void setCanceledNotCharged(BigDecimal canceledNotCharged) {
        set(PROPERTY_CANCELEDNOTCHARGED, canceledNotCharged);
    }
 
    public BigDecimal getCreatedAmount() {
        return (BigDecimal) get(PROPERTY_CREATEDAMOUNT);
    }
 
    public void setCreatedAmount(BigDecimal createdAmount) {
        set(PROPERTY_CREATEDAMOUNT, createdAmount);
    }
 
    public BigDecimal getChargedAmount() {
        return (BigDecimal) get(PROPERTY_CHARGEDAMOUNT);
    }
 
    public void setChargedAmount(BigDecimal chargedAmount) {
        set(PROPERTY_CHARGEDAMOUNT, chargedAmount);
    }
 
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    }
 
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    }
 
    public Boolean isCreateFile() {
        return (Boolean) get(PROPERTY_CREATEFILE);
    }
 
    public void setCreateFile(Boolean createFile) {
        set(PROPERTY_CREATEFILE, createFile);
    }
 
    public Date getAccountingDate() {
        return (Date) get(PROPERTY_ACCOUNTINGDATE);
    }
 
    public void setAccountingDate(Date accountingDate) {
        set(PROPERTY_ACCOUNTINGDATE, accountingDate);
    }
 
    public String getSettlementType() {
        return (String) get(PROPERTY_SETTLEMENTTYPE);
    }
 
    public void setSettlementType(String settlementType) {
        set(PROPERTY_SETTLEMENTTYPE, settlementType);
    }
 
    public Boolean isOpenSettlement() {
        return (Boolean) get(PROPERTY_OPENSETTLEMENT);
    }
 
    public void setOpenSettlement(Boolean openSettlement) {
        set(PROPERTY_OPENSETTLEMENT, openSettlement);
    }
 
    public Boolean isCopyFrom() {
        return (Boolean) get(PROPERTY_COPYFROM);
    }
 
    public void setCopyFrom(Boolean copyFrom) {
        set(PROPERTY_COPYFROM, copyFrom);
    }
 
    public Boolean isGenerated() {
        return (Boolean) get(PROPERTY_GENERATED);
    }
 
    public void setGenerated(Boolean generated) {
        set(PROPERTY_GENERATED, generated);
    }
 
    public Boolean isTemplate() {
        return (Boolean) get(PROPERTY_TEMPLATE);
    }
 
    public void setTemplate(Boolean template) {
        set(PROPERTY_TEMPLATE, template);
    }
 
    @SuppressWarnings("unchecked")
    public List<DebtPaymentCancelV> getFinancialMgmtDebtPaymentCancelVList() {
        return (List<DebtPaymentCancelV>) get(PROPERTY_FINANCIALMGMTDEBTPAYMENTCANCELVLIST);
    }
 
    public void setFinancialMgmtDebtPaymentCancelVList(
        List<DebtPaymentCancelV> financialMgmtDebtPaymentCancelVList) {
        set(PROPERTY_FINANCIALMGMTDEBTPAYMENTCANCELVLIST,
            financialMgmtDebtPaymentCancelVList);
    }
 
    @SuppressWarnings("unchecked")
    public List<DebtPaymentGenerateV> getFinancialMgmtDebtPaymentGenerateVList() {
        return (List<DebtPaymentGenerateV>) get(PROPERTY_FINANCIALMGMTDEBTPAYMENTGENERATEVLIST);
    }
 
    public void setFinancialMgmtDebtPaymentGenerateVList(
        List<DebtPaymentGenerateV> financialMgmtDebtPaymentGenerateVList) {
        set(PROPERTY_FINANCIALMGMTDEBTPAYMENTGENERATEVLIST,
            financialMgmtDebtPaymentGenerateVList);
    }
 
    @SuppressWarnings("unchecked")
    public List<DebtPayment> getFinancialMgmtDebtPaymentSettlementCancelledList() {
        return (List<DebtPayment>) get(PROPERTY_FINANCIALMGMTDEBTPAYMENTSETTLEMENTCANCELLEDLIST);
    }
 
    public void setFinancialMgmtDebtPaymentSettlementCancelledList(
        List<DebtPayment> financialMgmtDebtPaymentSettlementCancelledList) {
        set(PROPERTY_FINANCIALMGMTDEBTPAYMENTSETTLEMENTCANCELLEDLIST,
            financialMgmtDebtPaymentSettlementCancelledList);
    }
 
    @SuppressWarnings("unchecked")
    public List<DebtPayment> getFinancialMgmtDebtPaymentCSettlementGenerateIDList() {
        return (List<DebtPayment>) get(PROPERTY_FINANCIALMGMTDEBTPAYMENTCSETTLEMENTGENERATEIDLIST);
    }
 
    public void setFinancialMgmtDebtPaymentCSettlementGenerateIDList(
        List<DebtPayment> financialMgmtDebtPaymentCSettlementGenerateIDList) {
        set(PROPERTY_FINANCIALMGMTDEBTPAYMENTCSETTLEMENTGENERATEIDLIST,
            financialMgmtDebtPaymentCSettlementGenerateIDList);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/FinancialMgmtSettlement"

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