ERP 2.50:Developers Guide/Reference/Entity Model/FinancialMgmtGLJournal
FinancialMgmtGLJournal
The GL Journal Tab defines the control parameters for a single GL Journal.
To the database table (GL_Journal) 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* | GL_Journal_ID | Mandatory Max Length: 32 | java.lang.String | The General Ledger Journal identifies a group of journal lines which represent a logical business transaction |
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. |
stDimension | User1_ID | Max Length: 22 | java.lang.String | The user defined element displays the optional elements that have been defined for this account combination. |
ndDimension | User2_ID | Max Length: 22 | java.lang.String | The user defined element displays the optional elements that have been defined for this account combination. |
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. | |
project | C_Project_ID | Project | Identifier of a project defined within the Project & Service Management module. | |
accountingSchema | C_AcctSchema_ID | Mandatory | FinancialMgmtAcctSchema | An Accounting Schema defines the rules used in accounting such as costing method, currency and calendar |
documentType | C_DocType_ID | Mandatory | DocumentType | The Document Type determines document sequence and processing rules |
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). |
documentStatus | DocStatus | Mandatory Max Length: 60 | java.lang.String | The Document Status indicates the status of a document at this time. To change the status of a document, use one of the buttons usually located at the bottom of the document window. |
documentAction | DocAction | Mandatory Max Length: 60 | java.lang.String |
You find the current status in the Document Status field. The options are listed in a popup |
approved | IsApproved | Mandatory | java.lang.Boolean | The Approved checkbox indicates if this document requires approval before it can be processed. |
IsPrinted | java.lang.Boolean | The Printed checkbox indicates if this document or line will included when printing. | ||
description | Description | Mandatory Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
postingType | PostingType | Mandatory Max Length: 60 | java.lang.String | The Posting Type indicates the type of amount (Actual, Encumbrance, Budget) this journal updated. |
gLCategory | GL_Category_ID | Mandatory | FinancialMgmtGLCategory | The General Ledger Category is an optional, user defined method of grouping journal lines. |
documentDate | DateDoc | Mandatory | java.util.Date | The Document Date indicates the date the document was generated. It may or may not be the same as the accounting date. |
accountingDate | DateAcct | Mandatory | 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. |
period | C_Period_ID | Mandatory | FinancialMgmtPeriod | The Period indicates an exclusive range of dates for a calendar. |
currency | C_Currency_ID | Currency | Indicates the currency to be used when processing this document. | |
currencyRateType | CurrencyRateType | Mandatory Max Length: 60 | java.lang.String | The Conversion Rate Type indicates the type of rate to use when retrieving the conversion rate. It allows you to define multiple rates for the same to and from currency. For example you may have a set of rates used for daily transactions with a rate type of SPOT and rates for currency revaluation defined as REVAL. |
rate | CurrencyRate | Mandatory | java.math.BigDecimal | The Currency Conversion Rate indicates the rate to use when converting the source currency to the accounting currency |
journalBatch | GL_JournalBatch_ID | FinancialMgmtGLBatch | The General Ledger Journal Batch identifies a group of journals to be processed as a group. | |
totalDebitAmount | TotalDr | Mandatory | java.math.BigDecimal | The Total Debit indicates the total debit amount for a journal or journal batch in the source currency |
totalCreditAmount | TotalCr | Mandatory | java.math.BigDecimal | The Total Credit indicates the total credit amount for a journal or journal batch in the source currency |
controlAmount | ControlAmt | java.math.BigDecimal | If the control amount is zero, no check is performed.Otherwise the total Debit amount must be equal to the control amount, before the document is processed. | |
processNow | Processing | java.lang.Boolean | When this field is set as 'Y' a process is being performed on this record. | |
processed | Processed | java.lang.Boolean | 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. |
opening | IsOpening | Mandatory | java.lang.Boolean | A flag indicating this is an opening entry |
financialMgmtGLJournalLineList | List of FinancialMgmtGLJournalLine |
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.gl; 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.financialmgmt.accounting.coa.AcctSchema; import org.openbravo.model.financialmgmt.calendar.Period; import org.openbravo.model.marketing.Campaign; 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 FinancialMgmtGLJournal (stored in table GL_Journal). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class GLJournal extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "GL_Journal"; public static final String FinancialMgmtGLJournal = "FinancialMgmtGLJournal"; 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_STDIMENSION = "stDimension"; public static final String PROPERTY_NDDIMENSION = "ndDimension"; public static final String PROPERTY_SALESCAMPAIGN = "salesCampaign"; public static final String PROPERTY_PROJECT = "project"; public static final String PROPERTY_ACCOUNTINGSCHEMA = "accountingSchema"; public static final String PROPERTY_DOCUMENTTYPE = "documentType"; public static final String PROPERTY_DOCUMENTNO = "documentNo"; public static final String PROPERTY_DOCUMENTSTATUS = "documentStatus"; public static final String PROPERTY_DOCUMENTACTION = "documentAction"; public static final String PROPERTY_APPROVED = "approved"; public static final String PROPERTY_PRINT = "print"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_POSTINGTYPE = "postingType"; public static final String PROPERTY_GLCATEGORY = "gLCategory"; public static final String PROPERTY_DOCUMENTDATE = "documentDate"; public static final String PROPERTY_ACCOUNTINGDATE = "accountingDate"; public static final String PROPERTY_PERIOD = "period"; public static final String PROPERTY_CURRENCY = "currency"; public static final String PROPERTY_CURRENCYRATETYPE = "currencyRateType"; public static final String PROPERTY_RATE = "rate"; public static final String PROPERTY_JOURNALBATCH = "journalBatch"; public static final String PROPERTY_TOTALDEBITAMOUNT = "totalDebitAmount"; public static final String PROPERTY_TOTALCREDITAMOUNT = "totalCreditAmount"; public static final String PROPERTY_CONTROLAMOUNT = "controlAmount"; 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_OPENING = "opening"; public static final String PROPERTY_FINANCIALMGMTGLJOURNALLINELIST = "financialMgmtGLJournalLineList"; public GLJournal() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_DOCUMENTSTATUS, "DR"); setDefaultValue(PROPERTY_DOCUMENTACTION, "CO"); setDefaultValue(PROPERTY_APPROVED, true); setDefaultValue(PROPERTY_PRINT, false); setDefaultValue(PROPERTY_CURRENCYRATETYPE, "S"); setDefaultValue(PROPERTY_RATE, new BigDecimal(1)); setDefaultValue(PROPERTY_TOTALDEBITAMOUNT, new BigDecimal(0)); setDefaultValue(PROPERTY_TOTALCREDITAMOUNT, new BigDecimal(0)); setDefaultValue(PROPERTY_PROCESSNOW, false); setDefaultValue(PROPERTY_PROCESSED, false); setDefaultValue(PROPERTY_POSTED, "N"); setDefaultValue(PROPERTY_OPENING, false); setDefaultValue(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST, new ArrayList<Object>()); } @Override public String getEntityName() { return FinancialMgmtGLJournal; } 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 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 Campaign getSalesCampaign() { return (Campaign) get(PROPERTY_SALESCAMPAIGN); } public void setSalesCampaign(Campaign salesCampaign) { set(PROPERTY_SALESCAMPAIGN, salesCampaign); } public Project getProject() { return (Project) get(PROPERTY_PROJECT); } public void setProject(Project project) { set(PROPERTY_PROJECT, project); } public AcctSchema getAccountingSchema() { return (AcctSchema) get(PROPERTY_ACCOUNTINGSCHEMA); } public void setAccountingSchema(AcctSchema accountingSchema) { set(PROPERTY_ACCOUNTINGSCHEMA, accountingSchema); } public DocumentType getDocumentType() { return (DocumentType) get(PROPERTY_DOCUMENTTYPE); } public void setDocumentType(DocumentType documentType) { set(PROPERTY_DOCUMENTTYPE, documentType); } public String getDocumentNo() { return (String) get(PROPERTY_DOCUMENTNO); } public void setDocumentNo(String documentNo) { set(PROPERTY_DOCUMENTNO, documentNo); } public String getDocumentStatus() { return (String) get(PROPERTY_DOCUMENTSTATUS); } public void setDocumentStatus(String documentStatus) { set(PROPERTY_DOCUMENTSTATUS, documentStatus); } public String getDocumentAction() { return (String) get(PROPERTY_DOCUMENTACTION); } public void setDocumentAction(String documentAction) { set(PROPERTY_DOCUMENTACTION, documentAction); } public Boolean isApproved() { return (Boolean) get(PROPERTY_APPROVED); } public void setApproved(Boolean approved) { set(PROPERTY_APPROVED, approved); } public Boolean isPrint() { return (Boolean) get(PROPERTY_PRINT); } public void setPrint(Boolean print) { set(PROPERTY_PRINT, print); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getPostingType() { return (String) get(PROPERTY_POSTINGTYPE); } public void setPostingType(String postingType) { set(PROPERTY_POSTINGTYPE, postingType); } public GLCategory getGLCategory() { return (GLCategory) get(PROPERTY_GLCATEGORY); } public void setGLCategory(GLCategory gLCategory) { set(PROPERTY_GLCATEGORY, gLCategory); } public Date getDocumentDate() { return (Date) get(PROPERTY_DOCUMENTDATE); } public void setDocumentDate(Date documentDate) { set(PROPERTY_DOCUMENTDATE, documentDate); } public Date getAccountingDate() { return (Date) get(PROPERTY_ACCOUNTINGDATE); } public void setAccountingDate(Date accountingDate) { set(PROPERTY_ACCOUNTINGDATE, accountingDate); } public Period getPeriod() { return (Period) get(PROPERTY_PERIOD); } public void setPeriod(Period period) { set(PROPERTY_PERIOD, period); } public Currency getCurrency() { return (Currency) get(PROPERTY_CURRENCY); } public void setCurrency(Currency currency) { set(PROPERTY_CURRENCY, currency); } public String getCurrencyRateType() { return (String) get(PROPERTY_CURRENCYRATETYPE); } public void setCurrencyRateType(String currencyRateType) { set(PROPERTY_CURRENCYRATETYPE, currencyRateType); } public BigDecimal getRate() { return (BigDecimal) get(PROPERTY_RATE); } public void setRate(BigDecimal rate) { set(PROPERTY_RATE, rate); } public GLBatch getJournalBatch() { return (GLBatch) get(PROPERTY_JOURNALBATCH); } public void setJournalBatch(GLBatch journalBatch) { set(PROPERTY_JOURNALBATCH, journalBatch); } public BigDecimal getTotalDebitAmount() { return (BigDecimal) get(PROPERTY_TOTALDEBITAMOUNT); } public void setTotalDebitAmount(BigDecimal totalDebitAmount) { set(PROPERTY_TOTALDEBITAMOUNT, totalDebitAmount); } public BigDecimal getTotalCreditAmount() { return (BigDecimal) get(PROPERTY_TOTALCREDITAMOUNT); } public void setTotalCreditAmount(BigDecimal totalCreditAmount) { set(PROPERTY_TOTALCREDITAMOUNT, totalCreditAmount); } public BigDecimal getControlAmount() { return (BigDecimal) get(PROPERTY_CONTROLAMOUNT); } public void setControlAmount(BigDecimal controlAmount) { set(PROPERTY_CONTROLAMOUNT, controlAmount); } public Boolean isProcessNow() { return (Boolean) get(PROPERTY_PROCESSNOW); } public void setProcessNow(Boolean processNow) { set(PROPERTY_PROCESSNOW, processNow); } public Boolean isProcessed() { return (Boolean) get(PROPERTY_PROCESSED); } public void setProcessed(Boolean processed) { set(PROPERTY_PROCESSED, processed); } public String getPosted() { return (String) get(PROPERTY_POSTED); } public void setPosted(String posted) { set(PROPERTY_POSTED, posted); } public Boolean isOpening() { return (Boolean) get(PROPERTY_OPENING); } public void setOpening(Boolean opening) { set(PROPERTY_OPENING, opening); } @SuppressWarnings("unchecked") public List<GLJournalLine> getFinancialMgmtGLJournalLineList() { return (List<GLJournalLine>) get(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST); } public void setFinancialMgmtGLJournalLineList( List<GLJournalLine> financialMgmtGLJournalLineList) { set(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST, financialMgmtGLJournalLineList); } }