Log in / create account
Openbravo.com
Issues
Forge
University
View source | Discuss this page | Page history | Printable version   

ERP 2.50:Developers Guide/Reference/Entity Model/FIN Payment

FIN_Payment

Payment events

To the database table (FIN_Payment) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* Fin_Payment_ID Mandatory
Max Length: 32 		java.lang.String Payment event
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.
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.
active Isactive 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.

receipt Isreceipt java.lang.Boolean Indicated a sales transaction (Accounts Receivable if Receipt=Y) or a purchase transaction (Accounts Payable if Receipt=N).
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.
paymentDate# Paymentdate java.util.Date
currency C_Currency_ID Mandatory Currency Indicates the currency to be used when processing this document.
amount# Amount Mandatory java.math.BigDecimal
writeoffAmount# Writeoffamt Mandatory java.math.BigDecimal The Write Off Amount indicates the amount to be written off as uncollectible.
paymentMethod Fin_Paymentmethod_ID Mandatory FIN_PaymentMethod
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).
referenceNo Referenceno Max Length: 40 java.lang.String The reference number can be printed on orders and invoices to allow your business partner to faster identify your records.
status Status Mandatory
Max Length: 40 		java.lang.String Current status of a debt/payment.
processed Processed Mandatory java.lang.Boolean The Processed checkbox indicates that a document has been processed.
processNow Processing Mandatory java.lang.Boolean When this field is set as 'Y' a process is being performed on this record.
posted Posted Mandatory
Max Length: 1 		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.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
account Fin_Financial_Account_ID Mandatory FIN_Financial_Account Financial account used to deposit / withdrawal money such as bank accounts or petty cash
documentType C_DocType_ID Mandatory DocumentType The Document Type determines document sequence and processing rules
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: 32 java.lang.String The user defined element displays the optional elements that have been defined for this account combination.
ndDimension User2_ID Max Length: 32 java.lang.String The user defined element displays the optional elements that have been defined for this account combination.
generatedCredit Generated_Credit java.math.BigDecimal Amount left as credit on the payment.
usedCredit Used_Credit java.math.BigDecimal If the payment has some generated credit is the amount already used on other payments.

If the payment does not have a generated credit amount is the amount of credit used on the payment.

createdByAlgorithm CreatedByAlgorithm Mandatory java.lang.Boolean This column reflects whether the document was created by the matching algorithm or not.
fINPaymentDetailVList List of FIN_Payment_Detail_V
fINPaymentDetailList List of FIN_Payment_Detail
financialMgmtPaymentExecutionHistoryVList List of FinancialMgmtPaymentExecutionHistoryV
financialMgmtPaymentRunPaymentList List of FinancialMgmtPaymentRunPayment

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.businesspartner.BusinessPartner;
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 FIN_Payment (stored in table FIN_Payment).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class FIN_Payment extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "FIN_Payment";
    public static final String FIN_Payment = "FIN_Payment";
    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_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_ACTIVE = "active";
    public static final String PROPERTY_RECEIPT = "receipt";
    public static final String PROPERTY_BUSINESSPARTNER = "businessPartner";
    public static final String PROPERTY_PAYMENTDATE = "paymentDate";
    public static final String PROPERTY_CURRENCY = "currency";
    public static final String PROPERTY_AMOUNT = "amount";
    public static final String PROPERTY_WRITEOFFAMOUNT = "writeoffAmount";
    public static final String PROPERTY_PAYMENTMETHOD = "paymentMethod";
    public static final String PROPERTY_DOCUMENTNO = "documentNo";
    public static final String PROPERTY_REFERENCENO = "referenceNo";
    public static final String PROPERTY_STATUS = "status";
    public static final String PROPERTY_PROCESSED = "processed";
    public static final String PROPERTY_PROCESSNOW = "processNow";
    public static final String PROPERTY_POSTED = "posted";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_ACCOUNT = "account";
    public static final String PROPERTY_DOCUMENTTYPE = "documentType";
    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_GENERATEDCREDIT = "generatedCredit";
    public static final String PROPERTY_USEDCREDIT = "usedCredit";
    public static final String PROPERTY_CREATEDBYALGORITHM =
        "createdByAlgorithm";
    public static final String PROPERTY_FINPAYMENTDETAILVLIST =
        "fINPaymentDetailVList";
    public static final String PROPERTY_FINPAYMENTDETAILLIST =
        "fINPaymentDetailList";
    public static final String PROPERTY_FINANCIALMGMTPAYMENTEXECUTIONHISTORYVLIST =
        "financialMgmtPaymentExecutionHistoryVList";
    public static final String PROPERTY_FINANCIALMGMTPAYMENTRUNPAYMENTLIST =
        "financialMgmtPaymentRunPaymentList";
 
    public FIN_Payment() {
        setDefaultValue(PROPERTY_CREATIONDATE, new Date());
        setDefaultValue(PROPERTY_UPDATED, new Date());
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_AMOUNT, new BigDecimal(0));
        setDefaultValue(PROPERTY_WRITEOFFAMOUNT, new BigDecimal(0));
        setDefaultValue(PROPERTY_STATUS, "RPAP");
        setDefaultValue(PROPERTY_PROCESSED, false);
        setDefaultValue(PROPERTY_PROCESSNOW, false);
        setDefaultValue(PROPERTY_POSTED, "N");
        setDefaultValue(PROPERTY_GENERATEDCREDIT, new BigDecimal(0));
        setDefaultValue(PROPERTY_USEDCREDIT, new BigDecimal(0));
        setDefaultValue(PROPERTY_CREATEDBYALGORITHM, false);
        setDefaultValue(PROPERTY_FINPAYMENTDETAILVLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINPAYMENTDETAILLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTPAYMENTEXECUTIONHISTORYVLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTPAYMENTRUNPAYMENTLIST,
            new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return FIN_Payment;
    }
 
    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 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 Boolean isActive() {
        return (Boolean) get(PROPERTY_ACTIVE);
    }
 
    public void setActive(Boolean active) {
        set(PROPERTY_ACTIVE, active);
    }
 
    public Boolean isReceipt() {
        return (Boolean) get(PROPERTY_RECEIPT);
    }
 
    public void setReceipt(Boolean receipt) {
        set(PROPERTY_RECEIPT, receipt);
    }
 
    public BusinessPartner getBusinessPartner() {
        return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER);
    }
 
    public void setBusinessPartner(BusinessPartner businessPartner) {
        set(PROPERTY_BUSINESSPARTNER, businessPartner);
    }
 
    public Date getPaymentDate() {
        return (Date) get(PROPERTY_PAYMENTDATE);
    }
 
    public void setPaymentDate(Date paymentDate) {
        set(PROPERTY_PAYMENTDATE, paymentDate);
    }
 
    public Currency getCurrency() {
        return (Currency) get(PROPERTY_CURRENCY);
    }
 
    public void setCurrency(Currency currency) {
        set(PROPERTY_CURRENCY, currency);
    }
 
    public BigDecimal getAmount() {
        return (BigDecimal) get(PROPERTY_AMOUNT);
    }
 
    public void setAmount(BigDecimal amount) {
        set(PROPERTY_AMOUNT, amount);
    }
 
    public BigDecimal getWriteoffAmount() {
        return (BigDecimal) get(PROPERTY_WRITEOFFAMOUNT);
    }
 
    public void setWriteoffAmount(BigDecimal writeoffAmount) {
        set(PROPERTY_WRITEOFFAMOUNT, writeoffAmount);
    }
 
    public org.openbravo.model.financialmgmt.payment.FIN_PaymentMethod getPaymentMethod() {
        return (org.openbravo.model.financialmgmt.payment.FIN_PaymentMethod) get(PROPERTY_PAYMENTMETHOD);
    }
 
    public void setPaymentMethod(
        org.openbravo.model.financialmgmt.payment.FIN_PaymentMethod paymentMethod) {
        set(PROPERTY_PAYMENTMETHOD, paymentMethod);
    }
 
    public String getDocumentNo() {
        return (String) get(PROPERTY_DOCUMENTNO);
    }
 
    public void setDocumentNo(String documentNo) {
        set(PROPERTY_DOCUMENTNO, documentNo);
    }
 
    public String getReferenceNo() {
        return (String) get(PROPERTY_REFERENCENO);
    }
 
    public void setReferenceNo(String referenceNo) {
        set(PROPERTY_REFERENCENO, referenceNo);
    }
 
    public String getStatus() {
        return (String) get(PROPERTY_STATUS);
    }
 
    public void setStatus(String status) {
        set(PROPERTY_STATUS, status);
    }
 
    public Boolean isProcessed() {
        return (Boolean) get(PROPERTY_PROCESSED);
    }
 
    public void setProcessed(Boolean processed) {
        set(PROPERTY_PROCESSED, processed);
    }
 
    public Boolean isProcessNow() {
        return (Boolean) get(PROPERTY_PROCESSNOW);
    }
 
    public void setProcessNow(Boolean processNow) {
        set(PROPERTY_PROCESSNOW, processNow);
    }
 
    public String getPosted() {
        return (String) get(PROPERTY_POSTED);
    }
 
    public void setPosted(String posted) {
        set(PROPERTY_POSTED, posted);
    }
 
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    }
 
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    }
 
    public org.openbravo.model.financialmgmt.payment.FIN_FinancialAccount getAccount() {
        return (org.openbravo.model.financialmgmt.payment.FIN_FinancialAccount) get(PROPERTY_ACCOUNT);
    }
 
    public void setAccount(
        org.openbravo.model.financialmgmt.payment.FIN_FinancialAccount account) {
        set(PROPERTY_ACCOUNT, account);
    }
 
    public DocumentType getDocumentType() {
        return (DocumentType) get(PROPERTY_DOCUMENTTYPE);
    }
 
    public void setDocumentType(DocumentType documentType) {
        set(PROPERTY_DOCUMENTTYPE, documentType);
    }
 
    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 BigDecimal getGeneratedCredit() {
        return (BigDecimal) get(PROPERTY_GENERATEDCREDIT);
    }
 
    public void setGeneratedCredit(BigDecimal generatedCredit) {
        set(PROPERTY_GENERATEDCREDIT, generatedCredit);
    }
 
    public BigDecimal getUsedCredit() {
        return (BigDecimal) get(PROPERTY_USEDCREDIT);
    }
 
    public void setUsedCredit(BigDecimal usedCredit) {
        set(PROPERTY_USEDCREDIT, usedCredit);
    }
 
    public Boolean isCreatedByAlgorithm() {
        return (Boolean) get(PROPERTY_CREATEDBYALGORITHM);
    }
 
    public void setCreatedByAlgorithm(Boolean createdByAlgorithm) {
        set(PROPERTY_CREATEDBYALGORITHM, createdByAlgorithm);
    }
 
    @SuppressWarnings("unchecked")
    public List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetailV> getFINPaymentDetailVList() {
        return (List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetailV>) get(PROPERTY_FINPAYMENTDETAILVLIST);
    }
 
    public void setFINPaymentDetailVList(
        List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetailV> fINPaymentDetailVList) {
        set(PROPERTY_FINPAYMENTDETAILVLIST, fINPaymentDetailVList);
    }
 
    @SuppressWarnings("unchecked")
    public List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetail> getFINPaymentDetailList() {
        return (List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetail>) get(PROPERTY_FINPAYMENTDETAILLIST);
    }
 
    public void setFINPaymentDetailList(
        List<org.openbravo.model.financialmgmt.payment.FIN_PaymentDetail> fINPaymentDetailList) {
        set(PROPERTY_FINPAYMENTDETAILLIST, fINPaymentDetailList);
    }
 
    @SuppressWarnings("unchecked")
    public List<PaymentExecutionHistoryV> getFinancialMgmtPaymentExecutionHistoryVList() {
        return (List<PaymentExecutionHistoryV>) get(PROPERTY_FINANCIALMGMTPAYMENTEXECUTIONHISTORYVLIST);
    }
 
    public void setFinancialMgmtPaymentExecutionHistoryVList(
        List<PaymentExecutionHistoryV> financialMgmtPaymentExecutionHistoryVList) {
        set(PROPERTY_FINANCIALMGMTPAYMENTEXECUTIONHISTORYVLIST,
            financialMgmtPaymentExecutionHistoryVList);
    }
 
    @SuppressWarnings("unchecked")
    public List<PaymentRunPayment> getFinancialMgmtPaymentRunPaymentList() {
        return (List<PaymentRunPayment>) get(PROPERTY_FINANCIALMGMTPAYMENTRUNPAYMENTLIST);
    }
 
    public void setFinancialMgmtPaymentRunPaymentList(
        List<PaymentRunPayment> financialMgmtPaymentRunPaymentList) {
        set(PROPERTY_FINANCIALMGMTPAYMENTRUNPAYMENTLIST,
            financialMgmtPaymentRunPaymentList);
    }
}

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

This page has been accessed 1,728 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.