ERP 2.50:Developers Guide/Reference/Entity Model/InvoiceSchedule
InvoiceSchedule
The Invoice Schedule Tab defines the frequency for which batch invoices will be generated for a Business Partner.
To the database table (C_InvoiceSchedule) 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* | C_InvoiceSchedule_ID | Mandatory Max Length: 32 | java.lang.String | The Invoice Schedule identifies the frequency used when generating invoices. |
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. |
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. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
limitAmount | IsAmount | Mandatory | java.lang.Boolean | The Amount Limit checkbox indicates if invoices will be sent out if they are below the entered limit. |
amount | Amt | java.math.BigDecimal | Amount | |
invoiceFrequency | InvoiceFrequency | Mandatory Max Length: 60 | java.lang.String | The Invoice Frequency indicates the frequency of invoice generation for a Business Partner. |
dayOfTheWeek | InvoiceWeekDay | Max Length: 60 | java.lang.String | The Invoice Week Day indicates the day of the week to generate invoices. |
dayOfTheWeekCutoff | InvoiceWeekDayCutoff | Max Length: 60 | java.lang.String | The Invoice Week Day Cutoff indicates the last day of the week a shipment must be made to be included in the invoice schedule. |
invoiceOnEvenWeeks | EvenInvoiceWeek | java.lang.Boolean | The Invoice on Even Weeks checkbox indicates if biweekly invoices should be sent on even week numbers. | |
dayOfTheMonth | InvoiceDay | Min: 1 Max: 31 | java.lang.Long | The Invoice Day indicates the day of invoice generation. If twice monthly, the second time is 15 days after this day. |
invoiceCutOffDay | InvoiceDayCutoff | Min: 1 Max: 31 | java.lang.Long | The Invoice Day Cut Off indicates the last day for shipments to be included in the current invoice schedule. For example, if the invoice schedule is defined for the first day of the month, the cut off day may be the 25th of the month. An shipment on the 24th of May would be included in the invoices sent on June 1st but a shipment on the 26th would be included in the invoices sent on July 1st. |
default | IsDefault | Mandatory | java.lang.Boolean | The Default Checkbox indicates if this record will be used as a default value. |
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.invoice; 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.enterprise.Organization; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.math.BigDecimal; import java.util.Date; /** * Entity class for entity InvoiceSchedule (stored in table C_InvoiceSchedule). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class InvoiceSchedule extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "C_InvoiceSchedule"; public static final String InvoiceSchedule = "InvoiceSchedule"; 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_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_LIMITAMOUNT = "limitAmount"; public static final String PROPERTY_AMOUNT = "amount"; public static final String PROPERTY_INVOICEFREQUENCY = "invoiceFrequency"; public static final String PROPERTY_DAYOFTHEWEEK = "dayOfTheWeek"; public static final String PROPERTY_DAYOFTHEWEEKCUTOFF = "dayOfTheWeekCutoff"; public static final String PROPERTY_INVOICEONEVENWEEKS = "invoiceOnEvenWeeks"; public static final String PROPERTY_DAYOFTHEMONTH = "dayOfTheMonth"; public static final String PROPERTY_INVOICECUTOFFDAY = "invoiceCutOffDay"; public static final String PROPERTY_DEFAULT = "default"; public InvoiceSchedule() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_LIMITAMOUNT, false); setDefaultValue(PROPERTY_INVOICEONEVENWEEKS, false); setDefaultValue(PROPERTY_DAYOFTHEMONTH, (long) 1); setDefaultValue(PROPERTY_DEFAULT, false); } @Override public String getEntityName() { return InvoiceSchedule; } 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 getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public Boolean isLimitAmount() { return (Boolean) get(PROPERTY_LIMITAMOUNT); } public void setLimitAmount(Boolean limitAmount) { set(PROPERTY_LIMITAMOUNT, limitAmount); } public BigDecimal getAmount() { return (BigDecimal) get(PROPERTY_AMOUNT); } public void setAmount(BigDecimal amount) { set(PROPERTY_AMOUNT, amount); } public String getInvoiceFrequency() { return (String) get(PROPERTY_INVOICEFREQUENCY); } public void setInvoiceFrequency(String invoiceFrequency) { set(PROPERTY_INVOICEFREQUENCY, invoiceFrequency); } public String getDayOfTheWeek() { return (String) get(PROPERTY_DAYOFTHEWEEK); } public void setDayOfTheWeek(String dayOfTheWeek) { set(PROPERTY_DAYOFTHEWEEK, dayOfTheWeek); } public String getDayOfTheWeekCutoff() { return (String) get(PROPERTY_DAYOFTHEWEEKCUTOFF); } public void setDayOfTheWeekCutoff(String dayOfTheWeekCutoff) { set(PROPERTY_DAYOFTHEWEEKCUTOFF, dayOfTheWeekCutoff); } public Boolean isInvoiceOnEvenWeeks() { return (Boolean) get(PROPERTY_INVOICEONEVENWEEKS); } public void setInvoiceOnEvenWeeks(Boolean invoiceOnEvenWeeks) { set(PROPERTY_INVOICEONEVENWEEKS, invoiceOnEvenWeeks); } public Long getDayOfTheMonth() { return (Long) get(PROPERTY_DAYOFTHEMONTH); } public void setDayOfTheMonth(Long dayOfTheMonth) { set(PROPERTY_DAYOFTHEMONTH, dayOfTheMonth); } public Long getInvoiceCutOffDay() { return (Long) get(PROPERTY_INVOICECUTOFFDAY); } public void setInvoiceCutOffDay(Long invoiceCutOffDay) { set(PROPERTY_INVOICECUTOFFDAY, invoiceCutOffDay); } public Boolean isDefault() { return (Boolean) get(PROPERTY_DEFAULT); } public void setDefault(Boolean deflt) { set(PROPERTY_DEFAULT, deflt); } }