DBA Data[Home] [Help]

PACKAGE: APPS.IBY_PAYMENT_FORMAT_VAL_PVT

Source


1 PACKAGE IBY_PAYMENT_FORMAT_VAL_PVT AS
2 /* $Header: ibyfvvls.pls 120.9.12000000.1 2007/01/18 06:06:12 appldev ship $ */
3 /*
4 
5 PROCEDURE	: SCHEDULE_NUMBER
6 
7 This procedure is responsible for validating Schedule Number
8 
9 */
10  	PROCEDURE SCHEDULE_NUMBER
11 	(
12 		p_format_name IN VARCHAR2,
13 		p_pinstr_id IN NUMBER,
14 		p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
15 	        p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
16 	        x_error_code  OUT NOCOPY NUMBER,
17 	        x_error_mesg  OUT NOCOPY VARCHAR2
18 	);
19 
20 -------------------------------------------------------------------------------------------------------------------------------------------
21 /*
22 
23 PROCEDURE 	: SUPPLIER_TYPE
24 
25 This procedure is responsible for Validating Supplier Type .
26 
27 If Format Name Is In ('FVTPCCD','FVTIACHP','FVSPCCD', 'FVSPCCDP', 'FVTICTX' ,'FVBLCCDP')  ONLY NON-EMPLOYEES ARE ALLOWED.
28 
29 If Format Name Is In ('FVTPPPD','FVTPPPDP','FVSPPPDP','FVSPPPD', 'FVBLPPDP','FVBLSLTR') ONLY EMPLYEES ARE ALLOWED
30 If Format Name Is In ('FVTIACHB','FVBLNCR','FVSPNCR') EITHER ALL EMPLOYEES OR ALL NON EMPLOYEES ARE ALLOWED.
31 \
32 */
33     PROCEDURE SUPPLIER_TYPE
34 	(
35 	 	p_format_name 		IN VARCHAR2,
36 	   	p_instruction_id 	IN NUMBER,
37 	   	p_docErrorTab 		IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
38 	   	p_docErrorRec 		IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
39        		x_error_code  		OUT NOCOPY NUMBER,
40        		x_error_mesg  		OUT NOCOPY VARCHAR2
41 	);
42 
43 -------------------------------------------------------------------------------------------------------------------------------------------
44 /*
45 
46 PROCEDURE 	: TREASURY_SYMBOLS_PROCESS
47 
48 This procedure is responsible to insert the treasury symbol into the table FV_TP_TS_AMT_DATA along with the amount.
49 This table will later be used for the maximum treasury symbol validations.
50 
51 */
52 	PROCEDURE TREASURY_SYMBOLS_PROCESS
53 	(
54 	       p_format_name IN VARCHAR2,
55                p_instruction_id   IN   NUMBER,
56                p_payment_id  IN NUMBER,
57 	       p_invoice_id IN NUMBER,
58 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
59 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
60 	       x_error_code  OUT NOCOPY NUMBER,
61  	       x_error_mesg  OUT NOCOPY VARCHAR2
62 	);
63 
64 -------------------------------------------------------------------------------------------------------------------------------------------
65 /*
66 
67 PROCEDURE	:  MAX_TREASURY_SYMBOLS
68 
69 This procedure is responsible to validate for maximum number of treasury symbols in a payment batch.
70 
71 */
72 	PROCEDURE MAX_TREASURY_SYMBOLS
73 	(
74 	       p_format_name IN VARCHAR2,
75 	       p_instruction_id IN NUMBER,
76 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
77 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
78 	       x_error_code  OUT NOCOPY NUMBER,
79 	       x_error_mesg  OUT NOCOPY VARCHAR2
80 	);
81 
82 -------------------------------------------------------------------------------------------------------------------------------------------
83 /*
84 
85 PROCEDURE	: AGENCY_ADDRESS
86 
87 This procedure is respnosible for Validation of Agency Address.
88 
89 Agency Address should not be NULL.
90 
91 */
92 	PROCEDURE AGENCY_ADDRESS
93 	(
94 	       p_format_name IN VARCHAR2,
95 	       p_org_id IN NUMBER,
96 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
97 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
98 	       x_error_code  OUT NOCOPY NUMBER,
99 	       x_error_mesg  OUT NOCOPY VARCHAR2
100 	);
101 
102 -------------------------------------------------------------------------------------------------------------------------------------------
103 /*
104 
105 PROCEDURE	: PAYEE_ADDRESS
106 
107 This procedure is responsible for Validation of Payee Address
108 
109 Payee Address should not be NULL.
110 
111 */
112 	PROCEDURE PAYEE_ADDRESS
113 	(
114        	       p_format_name IN VARCHAR2,
115 	       p_payment_id IN NUMBER,
116 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
117 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
118 	       x_error_code  OUT NOCOPY NUMBER,
119 	       x_error_mesg  OUT NOCOPY VARCHAR2
120 	);
121 
122 -------------------------------------------------------------------------------------------------------------------------------------------
123 /*
124 
125 PROCEDURE	: MAX_PAYMENT_AMT
126 
127 This procedure is responsible for Validation of Payment Amount Exceeding the limit of 9,999,999.99
128 
129 */
130 	PROCEDURE MAX_PAYMENT_AMT
131 	(
132        	       p_format_name IN VARCHAR2,
133 	       p_instruction_id IN NUMBER,
134 	       p_payment_amount IN NUMBER,
135 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
136 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
137 	       x_error_code  OUT NOCOPY NUMBER,
138 	       x_error_mesg  OUT NOCOPY VARCHAR2
139 	);
140 
141 -------------------------------------------------------------------------------------------------------------------------------------------
142 /*
143 
144 PROCEDURE	: MAX_PAYMENT_AMT_2
145 
146 This procedure is responsible for Validation of Payment Amount Exceeding the limit of 999,999.99
147 
148 */
149 	PROCEDURE MAX_PAYMENT_AMT_2
150 	(
151        	       p_format_name IN VARCHAR2,
152 	       p_instruction_id IN NUMBER,
153 	       p_payment_amount IN NUMBER,
154 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
155 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
156 	       x_error_code  OUT NOCOPY NUMBER,
157 	       x_error_mesg  OUT NOCOPY VARCHAR2
158 	);
159 
160 -------------------------------------------------------------------------------------------------------------------------------------------
161 /*
162 
163 PROCEDURE	: PAY_TAX_BENEFIT
164 
165 This procedure is responsible such that Payments should pertain to Tax / Benefit only.
166 
167 */
168 	PROCEDURE PAY_TAX_BENEFIT
169 	(
170            p_format_name IN VARCHAR2,
171            p_payment_id  IN NUMBER,
172            p_invoice_id  IN NUMBER,
173 	   p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
174 	   p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
175 	   x_error_code  OUT NOCOPY NUMBER,
176 	   x_error_mesg  OUT NOCOPY VARCHAR2
177 	);
178 
179 -------------------------------------------------------------------------------------------------------------------------------------------
180 /*
181 
182 PROCEDURE	: PAY_SALARY_TRAVEL
183 
184 This procedure is responsible such that Payments should pertain to Salary / Travel only.
185 
186 */
187 	PROCEDURE PAY_SALARY_TRAVEL
188 	(
189 	       p_format_name IN VARCHAR2,
190 	       p_reason_code IN VARCHAR2,
191 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
192 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
193 	       x_error_code  OUT NOCOPY NUMBER,
194 	       x_error_mesg  OUT NOCOPY VARCHAR2
195 	);
196 
197 -------------------------------------------------------------------------------------------------------------------------------------------
198 /*
199 
200 PROCEDURE	: PAYEE_SSN
201 
202 This procedure is responsible for Validation of Payee Social Security Number.
203 
204 Payee Social Security Number should not be NULL.
205 
206 */
207 	PROCEDURE PAYEE_SSN
208 	(
209        	       p_format_name IN VARCHAR2,
210                p_ssn_tin IN VARCHAR2,
211                p_payee_party_id   IN  VARCHAR2,
212 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
213 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
214 	       x_error_code  OUT NOCOPY NUMBER,
215 	       x_error_mesg  OUT NOCOPY VARCHAR2
216 	);
217 
218 -------------------------------------------------------------------------------------------------------------------------------------------
219 /*
220 
221 PROCEDURE	: TAS_VALIDATION
222 
223 This procedure is responsible for validation of Treasury account symbol (TAS) in Payment record .
224 
225 TAS should me of minimum 7 characters and  can only be "0-9", "A-Z", ".", "(", ")", or "/"'.
226 
227 */
228 	PROCEDURE TAS_VALIDATION
229 	(
230 	       p_format_name IN VARCHAR2,
231 	       p_treasury_symbol IN VARCHAR2,
232 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
233 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
234 	       x_error_code  OUT NOCOPY NUMBER,
235 	       x_error_mesg  OUT NOCOPY VARCHAR2
236 	);
237 
238 -------------------------------------------------------------------------------------------------------------------------------------------
239 /*
240 
241 PROCEDURE	: AGENCY_LOCATION_CODE
242 
243 This procedure is responisble for Validation of Agency Location Code.
244 
245 Agency Location Code should not be NULL.
246 
247 */
248 	PROCEDURE AGENCY_LOCATION_CODE
249 	(
250 	       p_format_name 		IN VARCHAR2,
251                p_agency_location_code 	IN ce_bank_accounts.agency_location_code%TYPE,
252                p_bank_account_name	IN ce_bank_accounts.bank_account_name%TYPE,
253 	       p_docErrorTab 		IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
254 	       p_docErrorRec 		IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
255 	       x_error_code  		OUT NOCOPY NUMBER,
256 	       x_error_mesg  		OUT NOCOPY VARCHAR2
257 	);
258 
259 -------------------------------------------------------------------------------------------------------------------------------------------
260 /*
261 
262 PROCEDURE	: RTN_NUMBER
263 
264 This procedure is responsible for validation of RTN Number.
265 
266 It must a nine-digit numeric-only field.  Prohibit fewer or more than nine characters, allow for only numeric characters,
267 and prohibit the entry of all zeroes in this field. The ninth digit is the Check Digit which is validated using the Modulus formula.
268 
269 */
270 	PROCEDURE RTN_NUMBER
271 	(
272        	       p_format_name IN VARCHAR2,
273 	       p_rtn_number IN VARCHAR2,
274 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
275 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
276 	       x_error_code  OUT NOCOPY NUMBER,
277 	       x_error_mesg  OUT NOCOPY VARCHAR2
278 	);
279 
280 -------------------------------------------------------------------------------------------------------------------------------------------
281 /*
282 
283 PROCEDURE	: PAY_ALONE_OPTION
284 
285 This procedure is responsible for validation of Pay ALone.
286 
287 "Pay Alone" for each invoice should not be 'NO' or NULL.
288 
289 
290 */
291 	PROCEDURE PAY_ALONE_OPTION
292 	(
293 	       p_format_name IN VARCHAR2,
294 	       p_invoice_id IN NUMBER,
295 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
296 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
297 	       x_error_code  OUT NOCOPY NUMBER,
298 	       x_error_mesg  OUT NOCOPY VARCHAR2
299 	);
300 
301 -------------------------------------------------------------------------------------------------------------------------------------------
302 /*
303 
304 PROCEDURE	: DEPOSITER_ACC_NUM
305 
306 This procedure is responsible for Validation of Depositor Account number.
307 
308 Account number should not be NULL.
309 
310 */
311 	PROCEDURE DEPOSITER_ACC_NUM
312 	(
313 	       p_format_name IN VARCHAR2,
314 	       p_dep_account_no IN iby_ext_bank_accounts.bank_account_num%TYPE,
315 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
316 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
317 	       x_error_code  OUT NOCOPY NUMBER,
318 	       x_error_mesg  OUT NOCOPY VARCHAR2
319 	);
320 
321 -------------------------------------------------------------------------------------------------------------------------------------------
322 /*
323 
324 PROCEDURE	: ACCOUNT_TYPE
325 
326 This procedure is responsible for Validation of Account type.
327 
328 Valid values for bank account type are "C" - Checking account; "S" - Savings account.
329 
330 */
331 	PROCEDURE ACCOUNT_TYPE
332 	(
333        	       p_format_name IN VARCHAR2,
334 	       p_bank_account_type IN iby_ext_bank_accounts.bank_account_type%TYPE,
335                p_bank_account_name IN iby_ext_bank_accounts.bank_account_name%TYPE,
336                p_invoice_id        IN NUMBER,
337 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
338 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
339 	       x_error_code  OUT NOCOPY NUMBER,
340 	       x_error_mesg  OUT NOCOPY VARCHAR2
341 	);
342 
343 -------------------------------------------------------------------------------------------------------------------------------------------
344 /*
345 
346 PROCEDURE	: RFC_ID
347 
348 This procedure is responsible for validation of RFC_ID
349 
350 RFC_ID should not be NULL.
351 
352 */
353 	PROCEDURE RFC_ID
354 	(
355        	       p_format_name 		IN VARCHAR2,
356 	       p_payment_id 		IN NUMBER,
357 	       p_docErrorTab 		IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
358 	       p_docErrorRec 		IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
359 	       x_error_code  		OUT NOCOPY NUMBER,
360 	       x_error_mesg  		OUT NOCOPY VARCHAR2
361 	);
362 
363 -------------------------------------------------------------------------------------------------------------------------------------------
364 /*
365 
366 PROCEDURE	: MANDATORY_PPD_PPDP_REASON_CODE
367 
368 This procedure is responsible for validation of following formats
369 
370 Bulk Data PPDP Payment Format Report
371 
372 ECS PPD Vendor Payment Format Program
373 
374 ECS PPDP Vendor Payment Format Program
375 
376 SPS PPD Vendor Payment Format Program
377 
378 SPS PPDP Vendor Payment Format Program
379 
380 to have a payment with a specified Federal payment reason.
381 
382 */
383 	PROCEDURE MANDATORY_PPD_PPDP_REASON_CODE
384 	(
385        	       p_format_name IN VARCHAR2,
386 	       p_reason_code IN VARCHAR2,
387 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
388 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
389 	       x_error_code  OUT NOCOPY NUMBER,
390 	       x_error_mesg  OUT NOCOPY VARCHAR2
391 	);
392 
393 -------------------------------------------------------------------------------------------------------------------------------------------
394         PROCEDURE LOG_ERROR_MESSAGES
395         (
396             p_level   IN NUMBER,
397             p_module  IN VARCHAR2,
398             p_message IN VARCHAR2
399         );
400 ---------------------------------------------------------------------------------------------------------------------------------
401 PROCEDURE EXTERNAL_BANK_ACCOUNT_ID
402 	(
403            p_format_name 		IN VARCHAR2,
404   	   p_external_bank_account_id 	IN NUMBER,
405 	   p_docErrorTab 		IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
406 	   p_docErrorRec 		IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
407 	   x_error_code  		OUT NOCOPY NUMBER,
408 	   x_error_mesg  		OUT NOCOPY VARCHAR2
409 	);
410 -----------------------------------------------------------------------------------------------------------------------------
411  PROCEDURE FEDERAL_ID_NUMBER
412 	(
413        	       p_format_name IN VARCHAR2,
414                p_pay_instruction_id IN NUMBER,
415 	       p_docErrorTab IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
416 	       p_docErrorRec IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
417 	       x_error_code  OUT NOCOPY NUMBER,
418 	       x_error_mesg  OUT NOCOPY VARCHAR2
419 	);
420 
421 -----------------------------------------------------------------------------------------------------------------------------
422 PROCEDURE AGENCY_ID_ABBREVIATION
423 	(
424            p_format_name 	IN VARCHAR2,
425 	   p_instruction_id 	IN NUMBER,
426 	   p_docErrorTab 	IN  OUT NOCOPY IBY_VALIDATIONSETS_PUB.docErrorTabType,
427 	   p_docErrorRec 	IN  OUT NOCOPY IBY_TRANSACTION_ERRORS%ROWTYPE,
428 	   x_error_code  	OUT NOCOPY NUMBER,
429 	   x_error_mesg  	OUT NOCOPY VARCHAR2
430 	);
431 
432 
433 
434 END IBY_PAYMENT_FORMAT_VAL_PVT;
435