001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.module.ar;
017    
018    /**
019     * Business Object Property Constants for KFS-AR.
020     */
021    public class ArPropertyConstants {
022    
023        // CustomerInvoiceDocument
024        public static class CustomerInvoiceDocumentFields {
025            public static final String DOCUMENT_NUMBER = "documentNumber";
026            public static final String PAYMENT_CHART_OF_ACCOUNTS_CODE = "paymentChartOfAccountsCode";
027            public static final String PAYMENT_FINANCIAL_OBJECT_CODE = "paymentFinancialObjectCode";
028            public static final String PAYMENT_FINANCIAL_SUB_OBJECT_CODE = "paymentFinancialSubObjectCode";
029            public static final String PAYMENT_ACCOUNT_NUMBER = "paymentAccountNumber";
030            public static final String PAYMENT_SUB_ACCOUNT_NUMBER = "paymentSubAccountNumber";
031            public static final String PAYMENT_PROJECT_CODE = "paymentProjectCode";
032    
033            public static final String PAYMENT_CHART_OF_ACCOUNTS = "paymentChartOfAccounts";
034            public static final String PAYMENT_FINANCIAL_OBJECT = "paymentFinancialObject";
035            public static final String PAYMENT_FINANCIAL_SUB_OBJECT = "paymentFinancialSubObject";
036            public static final String PAYMENT_ACCOUNT = "paymentAccount";
037            public static final String PAYMENT_SUB_ACCOUNT = "paymentSubAccount";
038            public static final String PAYMENT_PROJECT = "paymentProject";
039    
040            public static final String CUSTOMER_INVOICE_DETAILS = "accountingLines";
041            public static final String INVOICE_ITEM_CODE = "invoiceItemCode";
042            public static final String UNIT_OF_MEASURE_CODE = "invoiceItemUnitOfMeasureCode";
043    
044            public static final String CUSTOMER = "customer";
045            public static final String CUSTOMER_NUMBER = "accountsReceivableDocumentHeader.customerNumber";
046    
047            public static final String INVOICE_DUE_DATE = "invoiceDueDate";
048            public static final String BILLING_DATE = "billingDate";
049            public static final String SOURCE_TOTAL = "sourceTotal";
050            public static final String AGE = "age";
051            public static final String BILLED_BY_ORGANIZATION = "billedByOrganization";
052            public static final String BILLED_BY_ORGANIZATION_CODE = "billedByOrganizationCode";
053    
054            public static final String BILL_BY_CHART_OF_ACCOUNT = "billByChartOfAccount";
055            public static final String BILL_BY_CHART_OF_ACCOUNT_CODE = "billByChartOfAccountCode";
056    
057            public static final String INVOICE_ITEM_UNIT_PRICE = "invoiceItemUnitPrice";
058            public static final String INVOICE_ITEM_QUANTITY = "invoiceItemQuantity";
059            public static final String INVOICE_ITEM_SERVICE_DATE = "invoiceItemServiceDate";
060            public static final String INVOICE_ITEM_DESCRIPTION = "invoiceItemDescription";
061            public static final String INVOICE_ITEM_TAXABLE_INDICATOR = "taxableIndicator";
062    
063            public static final String PROCESSING_CHART_OF_ACCOUNT_CODE = "accountsReceivableDocumentHeader.processingChartOfAccountCode";
064    
065            public static final String SHIP_TO_ADDRESS_IDENTIFIER = "customerShipToAddressIdentifier";
066            public static final String BILL_TO_ADDRESS_IDENTIFIER = "customerBillToAddressIdentifier";
067            public static final String OPEN_AMOUNT = "openAmount";
068    
069            public static final String INVOICE_DOCUMENT_RECURRENCE_BEGIN_DATE = "customerInvoiceRecurrenceDetails.documentRecurrenceBeginDate";
070            public static final String INVOICE_DOCUMENT_RECURRENCE_END_DATE = "customerInvoiceRecurrenceDetails.documentRecurrenceEndDate";
071            public static final String INVOICE_DOCUMENT_RECURRENCE_TOTAL_RECURRENCE_NUMBER = "customerInvoiceRecurrenceDetails.documentTotalRecurrenceNumber";
072            public static final String INVOICE_DOCUMENT_RECURRENCE_INTERVAL_CODE = "customerInvoiceRecurrenceDetails.documentRecurrenceIntervalCode";
073            public static final String INVOICE_DOCUMENT_RECURRENCE_INITIATOR = "customerInvoiceRecurrenceDetails.documentInitiatorUser.principalName";
074            public static final String INVOICE_DOCUMENT_RECURRENCE = "customerInvoiceRecurrenceDetails";
075            public static final String INVOICE_DOCUMENT_RECURRENCE_ACTIVE = "customerInvoiceRecurrenceDetails.active";
076        }
077        
078        // InvoiceRecurrence
079        public static final class InvoiceRecurrenceFields {
080            public static final String RECURRING_INVOICE_NUMBER = "invoiceNumber";
081            public static final String INVOICE_RECURRENCE_BEGIN_DATE = "documentRecurrenceBeginDate";
082            public static final String INVOICE_RECURRENCE_END_DATE = "documentRecurrenceEndDate";
083            public static final String INVOICE_RECURRENCE_TOTAL_RECURRENCE_NUMBER = "documentTotalRecurrenceNumber";
084            public static final String INVOICE_RECURRENCE_INITIATOR_USER_ID = "documentInitiatorUserIdentifier";
085        }
086        
087        // OrganizationAccountingDefaults
088        public static class OrganizationAccountingDefaultFields {
089            
090            public static final String LATE_CHARGE_OBJECT_CODE = "organizationLateChargeObjectCode";
091            public static final String INVOICE_CHART_OF_ACCOUNTS_CODE = "defaultInvoiceChartOfAccountsCode";
092            public static final String PAYMENT_CHART_OF_ACCOUNTS_CODE = "defaultPaymentChartOfAccountsCode";
093            public static final String PAYMENT_ACCOUNT_NUMBER = "defaultPaymentAccountNumber";
094            public static final String PAYMENT_FINANCIAL_OBJECT_CODE = "defaultPaymentFinancialObjectCode";
095            
096            public static final String WRITEOFF_FINANCIAL_OBJECT_CODE = "writeoffFinancialObjectCode";
097            public static final String WRITEOFF_CHART_OF_ACCOUNTS_CODE = "writeoffChartOfAccountsCode";
098            public static final String WRITEOFF_ACCOUNT_NUMBER = "writeoffAccountNumber";
099        }
100    
101        // CustomerType
102        public static class CustomerTypeFields {
103            public static final String CUSTOMER_TYPE_DESC = "customerTypeDescription";
104        }
105        
106        // Customer
107        public static class CustomerFields {
108            public static final String CUSTOMER_TAB_GENERAL_INFORMATION = "customerGeneralInformation";
109            public static final String CUSTOMER_TAB_ADDRESSES = "customerAddresses";
110            public static final String CUSTOMER_TAB_ADDRESSES_ADD_NEW_ADDRESS = "add.customerAddresses";
111            public static final String CUSTOMER_ADDRESS_TYPE_CODE = "customerAddressTypeCode";
112            public static final String CUSTOMER_ADDRESS_IDENTIFIER = "customerAddressIdentifier";
113            public static final String CUSTOMER_NUMBER = "customerNumber";
114            public static final String CUSTOMER_NAME = "customerName";
115            public static final String CUSTOMER_ADDRESS_STATE_CODE = "customerStateCode";
116            public static final String CUSTOMER_ADDRESS_ZIP_CODE = "customerZipCode";
117            public static final String CUSTOMER_ADDRESS_INTERNATIONAL_PROVINCE_NAME = "customerAddressInternationalProvinceName";
118            public static final String CUSTOMER_ADDRESS_INTERNATIONAL_MAIL_CODE = "customerInternationalMailCode";
119            public static final String CUSTOMER_SOCIAL_SECURITY_NUMBER = "customerSocialSecurityNumberIdentifier";
120            public static final String CUSTOMER_ADDRESS_END_DATE = "customerAddressEndDate";
121        }
122    
123        // CustomerCreditMemoDocument
124        public static class CustomerCreditMemoDocumentFields {
125            public static final String CREDIT_MEMO_ITEM_QUANTITY = "creditMemoItemQuantity";
126            public static final String CREDIT_MEMO_ITEM_TOTAL_AMOUNT = "creditMemoItemTotalAmount";
127            public static final String CREDIT_MEMO_DOCUMENT_REF_INVOICE_NUMBER = "financialDocumentReferenceInvoiceNumber";
128        }
129    
130        // CashControlDocument
131        public static class CashControlDocumentFields {
132            public static final String FINANCIAL_DOCUMENT_LINE_AMOUNT = "financialDocumentLineAmount";
133            public static final String REFERENCE_FINANCIAL_DOC_NBR = "referenceFinancialDocumentNumber";
134            public static final String APPLICATION_DOC_STATUS = "status";
135            public static final String ORGANIZATION_DOC_NBR = "organizationDocumentNumber";
136            public static final String CUSTOMER_PAYMENT_MEDIUM_CODE = "customerPaymentMediumCode";
137            public static final String CUSTOMER_NUMBER = "customerNumber";
138            public static final String BANK_CODE = "document.bankCode";
139        }
140    
141        // CashControlDetail
142        public static class CashControlDetailFields {
143            public static final String CASH_CONTROL_DETAILS_TAB = "document.cashControlDetails";
144            public static final String REFERENCE_FINANCIAL_DOC_NBR = "referenceFinancialDocumentNumber";
145        }
146        
147        // CustomerInvoiceWriteoffDocument
148        public static class CustomerInvoiceWriteoffDocumentFields {
149            public static final String CUSTOMER_INVOICE_DETAILS_FOR_WRITEOFF = "customerInvoiceDetailsForWriteoff";
150            public static final String CUSTOMER_INVOICE_WRITEOFF_EXPLANATION ="documentHeader.explanation";
151        }
152        
153        // CustomerInvoiceWriteoffLookupResult
154        public static class CustomerInvoiceWriteoffLookupResultFields {
155            public static final String CUSTOMER_NUMBER = "customerNumber";
156            public static final String CUSTOMER_NAME = "customerName";
157            public static final String CUSTOMER_TYPE_CODE = "customerTypeCode";
158            public static final String CUSTOMER_INVOICE_NUMBER = "customerInvoiceNumber";
159            public static final String AGE = "age";
160            public static final String CUSTOMER_NOTE = "customerNote";
161        }
162    
163        // CustomerAgingReport
164        public static class CustomerAgingReportFields {        
165            public static final String REPORT_RUN_DATE = "reportRunDate";
166            public static final String REPORT_OPTION= "reportOption";
167            public static final String PROCESSING_OR_BILLING_CHART_CODE = "processingOrBillingChartCode";
168            public static final String ACCOUNT_CHART_CODE = "accountChartCode";
169        }
170    
171        // OrganizationOptions
172        public static class OrganizationOptionsFields {
173            public static final String CHART_OF_ACCOUNTS_CODE = "chartOfAccountsCode";
174            public static final String ORGANIZATION_CODE = "organizationCode";
175            public static final String PROCESSING_CHART_OF_ACCOUNTS_CODE = "processingChartOfAccountCode";
176            public static final String PROCESSING_ORGANIZATION_CODE = "processingOrganizationCode";
177            public static final String ORGANIZATION_CHECK_PAYABLE_TO_NAME = "organizationCheckPayableToName";
178            public static final String ORGANIZATION_REMIT_TO_ADDRESS_SECTION_ID = "Edit Organization Options";
179            public static final String ORGANIZATION_REMIT_TO_ADDRESS_NAME = "organizationRemitToAddressName";
180            public static final String ORGANIZATION_REMIT_TO_LINE1_STREET_ADDRESS = "organizationRemitToLine1StreetAddress";
181            public static final String ORGANIZATION_REMIT_TO_LINE2_STREET_ADDRESS = "organizationRemitToLine2StreetAddress";
182            public static final String ORGANIZATION_REMIT_TO_CITY_NAME = "organizationRemitToCityName";
183            public static final String ORGANIZATION_REMIT_TO_STATE_CODE = "organizationRemitToStateCode";
184            public static final String ORGANIZATION_REMIT_TO_ZIP_CODE = "organizationRemitToZipCode";
185            public static final String ORGANIZATION_POSTAL_ZIP_CODE = "organizationPostalZipCode";
186        }
187        
188        //  SystemInformation (aka ProcessingOrg)
189        public static class SystemInformationFields {
190            public static final String PROCESSING_CHART_OF_ACCOUNTS_CODE = "processingChartOfAccountCode";
191            public static final String PROCESSING_ORGANIZATION_CODE = "processingOrganizationCode";
192            public static final String LOCKBOX_NUMBER = "lockboxNumber";
193            public static final String ORGANIZATION_REMIT_TO_STATE_CODE = "organizationRemitToStateCode";
194            public static final String ORGANIZATION_REMIT_TO_ZIP_CODE = "organizationRemitToZipCode";
195        }
196        
197        // CustomerInvoiceItemCodes
198        public static class CustomerInvoiceItemCodes {
199            public static final String CHART_OF_ACCOUNTS_CODE = "chartOfAccountsCode";
200            public static final String ORGANIZATION_CODE = "organizationCode";
201        }
202        
203        // PaymentApplicationDocument
204        public static class PaymentApplicationDocumentFields {
205            public static final String AMOUNT_TO_BE_APPLIED = "customerInvoiceDetail[0].amountToBeApplied";
206            public static final String AMOUNT_TO_BE_APPLIED_LINE_N = "customerInvoiceDetail[{0}].amountToBeApplied";
207            public static final String NON_INVOICED_LINE_AMOUNT = "nonInvoicedAddLine.financialDocumentLineAmount";
208            public static final String NON_INVOICED_LINE_CHART = "nonInvoicedAddLine.chartOfAccountCode";
209            public static final String NON_INVOICED_LINE_ACCOUNT = "nonInvoicedAddLine.accountNumber";
210            public static final String NON_INVOICED_LINE_SUBACCOUNT = "nonInvoicedAddLine.subAccountNumber";
211            public static final String NON_INVOICED_LINE_OBJECT = "nonInvoicedAddLine.financialObjectCode";
212            public static final String NON_INVOICED_LINE_SUBOBJECT = "nonInvoicedAddLine.financialSubObjectCode";
213            public static final String NON_INVOICED_LINE_PROJECT = "nonInvoicedAddLine.projectCode";
214            public static final String UNAPPLIED_CUSTOMER_NUMBER = "document.nonAppliedHolding.customerNumber";
215            public static final String UNAPPLIED_AMOUNT = "document.nonAppliedHolding.financialDocumentLineAmount";
216            public static final String DELETE_NON_INVOICED_LINE_PREFIX = "methodToCall.deleteNonArLine.line";
217            public static final String ENTERED_INVOICE_CUSTOMER_NUMBER = "selectedCustomerNumber";
218            public static final String ENTERED_INVOICE_NUMBER = "enteredInvoiceDocumentNumber";
219        }
220    
221    }