ERP/2.50/Developers Guide/Reference/Entity Model/OrderHeaderV
OrderHeaderV
To the database table (C_Order_Header_V) 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 |
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. |
language | AD_Language | Max Length: 5 | java.lang.String | The Language identifies the language to use for display |
id*# | C_Order_ID | Mandatory Max Length: 32 | java.lang.String | Unique identifier and a reference to a Sales Order originating from the document sequence defined for this document type. |
salesTransaction | IsSOTrx | Mandatory | java.lang.Boolean | The Sales Transaction checkbox indicates if this item is a Sales Transaction. |
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. |
documentType | C_DocType_ID | Mandatory Max Length: 32 | java.lang.String | The Document Type determines document sequence and processing rules |
businessPartner# | C_BPartner_ID | Mandatory | BusinessPartner | A Business Partner is anyone with whom you transact. This can include a customer, vendor, employee or any combination of these. |
bPSearchKey | BPValue | Mandatory Max Length: 40 | java.lang.String | Search Key of Business Partner |
orgLocation | Org_Location_ID | Location | Organization Location/Address | |
taxID | TaxID | Mandatory Max Length: 20 | java.lang.String | The Tax ID field identifies the legal Identification number of this Entity. |
documentTypeName | DocumentType | Mandatory Max Length: 60 | java.lang.String | Document Type |
documentTypeNote | DocumentTypeNote | Max Length: 2000 | java.lang.String | Optional note of a document type |
salesRepresentative | SalesRep_ID | ADUser | Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative. | |
salesRepresentativeName | SalesRep_Name | Max Length: 60 | java.lang.String | |
orderDate | DateOrdered | Mandatory | java.util.Date | Indicates the Date an item was ordered. |
scheduledDeliveryDate | DatePromised | java.util.Date | Scheduled Delivery Date indicates the date, if any, that an order was promised by. | |
bPGreeting | BPGreeting | Max Length: 60 | java.lang.String | Greeting for Business Partner |
name | Name | Mandatory Max Length: 60 | java.lang.String | A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length. |
name2 | Name2 | Max Length: 60 | java.lang.String | Additional Name |
bPContactGreeting | BPContactGreeting | Max Length: 60 | java.lang.String | Greeting for Business Partner Contact |
position | Title | Max Length: 40 | java.lang.String | The Title indicates the name that an entity is referred to as. |
contactName | ContactName | Max Length: 60 | java.lang.String | Business Partner Contact Name |
locationAddress | C_Location_ID | Location | The Location / Address field defines the location of an entity. | |
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. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
orderReference | POReference | Max Length: 20 | java.lang.String | This can be used to input a reference for this specific transaction. For example, a Purchase Order number can be input on a Sales Order for easier reference. |
currency | C_Currency_ID | Mandatory | Currency | Indicates the currency to be used when processing this document. |
paymentTerm | PaymentTerm | Mandatory Max Length: 60 | java.lang.String | Payment Term |
paymentTermNote | PaymentTermNote | Max Length: 2000 | java.lang.String | Note of a Payment Term |
charge | C_Charge_ID | FinancialMgmtGLCharge | The Charge indicates a type of Charge (Handling, Shipping, Restocking) | |
chargeAmount | ChargeAmt | java.math.BigDecimal | The Charge Amount indicates the amount for an additional charge. | |
summedLineAmount | TotalLines | Mandatory | java.math.BigDecimal | The Total amount displays the total of all lines in document currency |
grandTotalAmount | GrandTotal | Mandatory | java.math.BigDecimal | The Grand Total displays the total amount including Tax and Freight in document currency |
priceList | M_PriceList_ID | Mandatory | PricingPriceList |
Price Lists are used to determine the pricing, margin and cost of items purchased or sold. |
priceIncludesTax | IsTaxIncluded | Mandatory | java.lang.Boolean | The Tax Included checkbox indicates if the prices include tax. This is also known as the gross price. |
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. | |
activity | C_Activity_ID | MaterialMgmtABCActivity | Activities indicate tasks that are performed and used to utilize Activity based Costing | |
shippingCompany | M_Shipper_ID | ShippingShippingCompany | The Shipper is any entity which will provide shipping to or shipping from an Organization. | |
deliveryTerms | DeliveryRule | Mandatory Max Length: 60 | java.lang.String | The Delivery Rule indicates when an order should be delivered. For example should the order be delivered when the entire order is complete, when a line is complete or as the products become available. |
deliveryMethod | DeliveryViaRule | Mandatory Max Length: 60 | java.lang.String | The Delivery Via indicates how the products should be delivered. For example, will the order be picked up or shipped. |
priority | PriorityRule | Mandatory Max Length: 60 | java.lang.String | The Priority indicates the importance (high, medium, low) of this document |
invoiceTerms | InvoiceRule | Mandatory Max Length: 60 | java.lang.String | The Invoice Rule defines how a Business Partner is invoiced and the frequency of invoicing. |
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.common.order; 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.Organization; import org.openbravo.model.common.geography.Location; import org.openbravo.model.financialmgmt.gl.GLCharge; import org.openbravo.model.marketing.Campaign; import org.openbravo.model.materialmgmt.cost.ABCActivity; import org.openbravo.model.pricing.pricelist.PriceList; import org.openbravo.model.project.Project; import org.openbravo.model.shipping.ShippingCompany; import java.lang.Boolean; import java.lang.String; import java.math.BigDecimal; import java.util.Date; /** * Entity class for entity OrderHeaderV (stored in table C_Order_Header_V). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class OrderHeaderV extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "C_Order_Header_V"; public static final String OrderHeaderV = "OrderHeaderV"; 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_LANGUAGE = "language"; public static final String PROPERTY_ID = "id"; public static final String PROPERTY_SALESTRANSACTION = "salesTransaction"; public static final String PROPERTY_DOCUMENTNO = "documentNo"; public static final String PROPERTY_DOCUMENTSTATUS = "documentStatus"; public static final String PROPERTY_DOCUMENTTYPE = "documentType"; public static final String PROPERTY_BUSINESSPARTNER = "businessPartner"; public static final String PROPERTY_BPSEARCHKEY = "bPSearchKey"; public static final String PROPERTY_ORGLOCATION = "orgLocation"; public static final String PROPERTY_TAXID = "taxID"; public static final String PROPERTY_DOCUMENTTYPENAME = "documentTypeName"; public static final String PROPERTY_DOCUMENTTYPENOTE = "documentTypeNote"; public static final String PROPERTY_SALESREPRESENTATIVE = "salesRepresentative"; public static final String PROPERTY_SALESREPRESENTATIVENAME = "salesRepresentativeName"; public static final String PROPERTY_ORDERDATE = "orderDate"; public static final String PROPERTY_SCHEDULEDDELIVERYDATE = "scheduledDeliveryDate"; public static final String PROPERTY_BPGREETING = "bPGreeting"; public static final String PROPERTY_NAME = "name"; public static final String PROPERTY_NAME2 = "name2"; public static final String PROPERTY_BPCONTACTGREETING = "bPContactGreeting"; public static final String PROPERTY_POSITION = "position"; public static final String PROPERTY_CONTACTNAME = "contactName"; public static final String PROPERTY_LOCATIONADDRESS = "locationAddress"; public static final String PROPERTY_REFERENCENO = "referenceNo"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_ORDERREFERENCE = "orderReference"; public static final String PROPERTY_CURRENCY = "currency"; public static final String PROPERTY_PAYMENTTERM = "paymentTerm"; public static final String PROPERTY_PAYMENTTERMNOTE = "paymentTermNote"; public static final String PROPERTY_CHARGE = "charge"; public static final String PROPERTY_CHARGEAMOUNT = "chargeAmount"; public static final String PROPERTY_SUMMEDLINEAMOUNT = "summedLineAmount"; public static final String PROPERTY_GRANDTOTALAMOUNT = "grandTotalAmount"; public static final String PROPERTY_PRICELIST = "priceList"; public static final String PROPERTY_PRICEINCLUDESTAX = "priceIncludesTax"; public static final String PROPERTY_SALESCAMPAIGN = "salesCampaign"; public static final String PROPERTY_PROJECT = "project"; public static final String PROPERTY_ACTIVITY = "activity"; public static final String PROPERTY_SHIPPINGCOMPANY = "shippingCompany"; public static final String PROPERTY_DELIVERYTERMS = "deliveryTerms"; public static final String PROPERTY_DELIVERYMETHOD = "deliveryMethod"; public static final String PROPERTY_PRIORITY = "priority"; public static final String PROPERTY_INVOICETERMS = "invoiceTerms"; public OrderHeaderV() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_SALESTRANSACTION, false); setDefaultValue(PROPERTY_PRICEINCLUDESTAX, false); } @Override public String getEntityName() { return OrderHeaderV; } 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 getLanguage() { return (String) get(PROPERTY_LANGUAGE); } public void setLanguage(String language) { set(PROPERTY_LANGUAGE, language); } public String getId() { return (String) get(PROPERTY_ID); } public void setId(String id) { set(PROPERTY_ID, id); } public Boolean isSalesTransaction() { return (Boolean) get(PROPERTY_SALESTRANSACTION); } public void setSalesTransaction(Boolean salesTransaction) { set(PROPERTY_SALESTRANSACTION, salesTransaction); } 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 getDocumentType() { return (String) get(PROPERTY_DOCUMENTTYPE); } public void setDocumentType(String documentType) { set(PROPERTY_DOCUMENTTYPE, documentType); } public BusinessPartner getBusinessPartner() { return (BusinessPartner) get(PROPERTY_BUSINESSPARTNER); } public void setBusinessPartner(BusinessPartner businessPartner) { set(PROPERTY_BUSINESSPARTNER, businessPartner); } public String getBPSearchKey() { return (String) get(PROPERTY_BPSEARCHKEY); } public void setBPSearchKey(String bPSearchKey) { set(PROPERTY_BPSEARCHKEY, bPSearchKey); } public Location getOrgLocation() { return (Location) get(PROPERTY_ORGLOCATION); } public void setOrgLocation(Location orgLocation) { set(PROPERTY_ORGLOCATION, orgLocation); } public String getTaxID() { return (String) get(PROPERTY_TAXID); } public void setTaxID(String taxID) { set(PROPERTY_TAXID, taxID); } public String getDocumentTypeName() { return (String) get(PROPERTY_DOCUMENTTYPENAME); } public void setDocumentTypeName(String documentTypeName) { set(PROPERTY_DOCUMENTTYPENAME, documentTypeName); } public String getDocumentTypeNote() { return (String) get(PROPERTY_DOCUMENTTYPENOTE); } public void setDocumentTypeNote(String documentTypeNote) { set(PROPERTY_DOCUMENTTYPENOTE, documentTypeNote); } public User getSalesRepresentative() { return (User) get(PROPERTY_SALESREPRESENTATIVE); } public void setSalesRepresentative(User salesRepresentative) { set(PROPERTY_SALESREPRESENTATIVE, salesRepresentative); } public String getSalesRepresentativeName() { return (String) get(PROPERTY_SALESREPRESENTATIVENAME); } public void setSalesRepresentativeName(String salesRepresentativeName) { set(PROPERTY_SALESREPRESENTATIVENAME, salesRepresentativeName); } public Date getOrderDate() { return (Date) get(PROPERTY_ORDERDATE); } public void setOrderDate(Date orderDate) { set(PROPERTY_ORDERDATE, orderDate); } public Date getScheduledDeliveryDate() { return (Date) get(PROPERTY_SCHEDULEDDELIVERYDATE); } public void setScheduledDeliveryDate(Date scheduledDeliveryDate) { set(PROPERTY_SCHEDULEDDELIVERYDATE, scheduledDeliveryDate); } public String getBPGreeting() { return (String) get(PROPERTY_BPGREETING); } public void setBPGreeting(String bPGreeting) { set(PROPERTY_BPGREETING, bPGreeting); } public String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getName2() { return (String) get(PROPERTY_NAME2); } public void setName2(String name2) { set(PROPERTY_NAME2, name2); } public String getBPContactGreeting() { return (String) get(PROPERTY_BPCONTACTGREETING); } public void setBPContactGreeting(String bPContactGreeting) { set(PROPERTY_BPCONTACTGREETING, bPContactGreeting); } public String getPosition() { return (String) get(PROPERTY_POSITION); } public void setPosition(String position) { set(PROPERTY_POSITION, position); } public String getContactName() { return (String) get(PROPERTY_CONTACTNAME); } public void setContactName(String contactName) { set(PROPERTY_CONTACTNAME, contactName); } public Location getLocationAddress() { return (Location) get(PROPERTY_LOCATIONADDRESS); } public void setLocationAddress(Location locationAddress) { set(PROPERTY_LOCATIONADDRESS, locationAddress); } public String getReferenceNo() { return (String) get(PROPERTY_REFERENCENO); } public void setReferenceNo(String referenceNo) { set(PROPERTY_REFERENCENO, referenceNo); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getOrderReference() { return (String) get(PROPERTY_ORDERREFERENCE); } public void setOrderReference(String orderReference) { set(PROPERTY_ORDERREFERENCE, orderReference); } public Currency getCurrency() { return (Currency) get(PROPERTY_CURRENCY); } public void setCurrency(Currency currency) { set(PROPERTY_CURRENCY, currency); } public String getPaymentTerm() { return (String) get(PROPERTY_PAYMENTTERM); } public void setPaymentTerm(String paymentTerm) { set(PROPERTY_PAYMENTTERM, paymentTerm); } public String getPaymentTermNote() { return (String) get(PROPERTY_PAYMENTTERMNOTE); } public void setPaymentTermNote(String paymentTermNote) { set(PROPERTY_PAYMENTTERMNOTE, paymentTermNote); } public GLCharge getCharge() { return (GLCharge) get(PROPERTY_CHARGE); } public void setCharge(GLCharge charge) { set(PROPERTY_CHARGE, charge); } public BigDecimal getChargeAmount() { return (BigDecimal) get(PROPERTY_CHARGEAMOUNT); } public void setChargeAmount(BigDecimal chargeAmount) { set(PROPERTY_CHARGEAMOUNT, chargeAmount); } public BigDecimal getSummedLineAmount() { return (BigDecimal) get(PROPERTY_SUMMEDLINEAMOUNT); } public void setSummedLineAmount(BigDecimal summedLineAmount) { set(PROPERTY_SUMMEDLINEAMOUNT, summedLineAmount); } public BigDecimal getGrandTotalAmount() { return (BigDecimal) get(PROPERTY_GRANDTOTALAMOUNT); } public void setGrandTotalAmount(BigDecimal grandTotalAmount) { set(PROPERTY_GRANDTOTALAMOUNT, grandTotalAmount); } public PriceList getPriceList() { return (PriceList) get(PROPERTY_PRICELIST); } public void setPriceList(PriceList priceList) { set(PROPERTY_PRICELIST, priceList); } public Boolean isPriceIncludesTax() { return (Boolean) get(PROPERTY_PRICEINCLUDESTAX); } public void setPriceIncludesTax(Boolean priceIncludesTax) { set(PROPERTY_PRICEINCLUDESTAX, priceIncludesTax); } 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 ABCActivity getActivity() { return (ABCActivity) get(PROPERTY_ACTIVITY); } public void setActivity(ABCActivity activity) { set(PROPERTY_ACTIVITY, activity); } public ShippingCompany getShippingCompany() { return (ShippingCompany) get(PROPERTY_SHIPPINGCOMPANY); } public void setShippingCompany(ShippingCompany shippingCompany) { set(PROPERTY_SHIPPINGCOMPANY, shippingCompany); } public String getDeliveryTerms() { return (String) get(PROPERTY_DELIVERYTERMS); } public void setDeliveryTerms(String deliveryTerms) { set(PROPERTY_DELIVERYTERMS, deliveryTerms); } public String getDeliveryMethod() { return (String) get(PROPERTY_DELIVERYMETHOD); } public void setDeliveryMethod(String deliveryMethod) { set(PROPERTY_DELIVERYMETHOD, deliveryMethod); } public String getPriority() { return (String) get(PROPERTY_PRIORITY); } public void setPriority(String priority) { set(PROPERTY_PRIORITY, priority); } public String getInvoiceTerms() { return (String) get(PROPERTY_INVOICETERMS); } public void setInvoiceTerms(String invoiceTerms) { set(PROPERTY_INVOICETERMS, invoiceTerms); } }