[Home] [Help]
PACKAGE: APPS.OZF_CLAIM_GRP
Source
1 PACKAGE OZF_CLAIM_GRP AS
2 /* $Header: ozfgclas.pls 120.3 2005/12/15 01:42:35 azahmed ship $ */
3 -- Start of Comments
4 -- Package name : OZF_CLAIM_GRP
5 -- Purpose :
6 -- History :
7 -- NOTE :
8 -- End of Comments
9
10 -- Default number of records fetch per call
11 G_DEFAULT_NUM_REC_FETCH NUMBER := 30;
12
13 G_DEBUG_MODE BOOLEAN := FALSE;
14
15 -- *******************************************************
16 -- Start of Comments
17 -- -------------------------------------------------------
18 -- Record name:DEDUCTION_REC_TYPE
19 -- -------------------------------------------------------
20 -- CLAIM_ID
21 -- OBJECT_VERSION_NUMBER --Bug:2781186
22 -- CLAIM_NUMBER
23 -- CLAIM_TYPE_ID
24 -- CLAIM_DATE
25 -- DUE_DATE
26 -- OWNER_ID
27 -- AMOUNT
28 -- CURRENCY_CODE
29 -- EXCHANGE_RATE_TYPE
30 -- EXCHANGE_RATE_DATE
31 -- EXCHANGE_RATE
32 -- SET_OF_BOOKS_ID
33 -- SOURCE_OBJECT_ID
34 -- SOURCE_OBJECT_CLASS
35 -- SOURCE_OBJECT_TYPE_ID
36 -- SOURCE_OBJECT_NUMBER
37 -- CUST_ACCOUNT_ID
38 -- CUST_BILLTO_ACCT_SITE_ID
39 -- CUST_SHIPTO_ACCT_SITE_ID
40 -- LOCATION_ID
41 -- REASON_CODE_ID
42 -- STATUS_CODE
43 -- SALES_REP_ID
44 -- COLLECTOR_ID
45 -- CONTACT_ID
46 -- BROKER_ID
47 -- CUSTOMER_REF_DATE
48 -- CUSTOMER_REF_NUMBER
49 -- RECEIPT_ID
50 -- RECEIPT_NUMBER
51 -- GL_DATE
52 -- COMMENTS
53 -- DEDUCTION_ATTRIBUTE_CATEGORY
54 -- DEDUCTION_ATTRIBUTE1
55 -- DEDUCTION_ATTRIBUTE2
56 -- DEDUCTION_ATTRIBUTE3
57 -- DEDUCTION_ATTRIBUTE4
58 -- DEDUCTION_ATTRIBUTE5
59 -- DEDUCTION_ATTRIBUTE6
60 -- DEDUCTION_ATTRIBUTE7
61 -- DEDUCTION_ATTRIBUTE8
62 -- DEDUCTION_ATTRIBUTE9
63 -- DEDUCTION_ATTRIBUTE10
64 -- DEDUCTION_ATTRIBUTE11
65 -- DEDUCTION_ATTRIBUTE12
66 -- DEDUCTION_ATTRIBUTE13
67 -- DEDUCTION_ATTRIBUTE14
68 -- DEDUCTION_ATTRIBUTE15
69 -- ORG_ID
70 -- CUSTOMER_REASON
71 -- APPLIED_DATE
72 -- APPLIED_ACTION_TYPE
73 -- AMOUNT_APPLIED
74 -- APPLIED_RECEIPT_ID
75 -- APPLIED_RECEIPT_NUMBER
76 --
77 -- Required:
78 -- Defaults:
79 -- Note:
80 --
81 -- End of Comments
82
83 TYPE DEDUCTION_REC_TYPE IS RECORD
84 (
85 CLAIM_ID NUMBER
86 ,OBJECT_VERSION_NUMBER NUMBER
87 ,CLAIM_NUMBER VARCHAR2(30)
88 ,CLAIM_TYPE_ID NUMBER
89 ,CLAIM_DATE DATE
90 ,DUE_DATE DATE
91 ,OWNER_ID NUMBER
92 ,AMOUNT NUMBER
93 ,AMOUNT_ADJUSTED NUMBER
94 ,AMOUNT_REMAINING NUMBER
95 ,AMOUNT_SETTLED NUMBER
96 ,CURRENCY_CODE VARCHAR2(15)
97 ,EXCHANGE_RATE_TYPE VARCHAR2(30)
98 ,EXCHANGE_RATE_DATE DATE
99 ,EXCHANGE_RATE NUMBER
100 ,SET_OF_BOOKS_ID NUMBER
101 ,SOURCE_OBJECT_ID NUMBER
102 ,SOURCE_OBJECT_CLASS VARCHAR2(15)
103 ,SOURCE_OBJECT_TYPE_ID NUMBER
104 ,SOURCE_OBJECT_NUMBER VARCHAR2(30)
105 ,CUST_ACCOUNT_ID NUMBER
106 ,SHIP_TO_CUST_ACCOUNT_ID NUMBER
107 ,CUST_BILLTO_ACCT_SITE_ID NUMBER
108 ,CUST_SHIPTO_ACCT_SITE_ID NUMBER
109 ,LOCATION_ID NUMBER
110 ,REASON_CODE_ID NUMBER
111 ,STATUS_CODE VARCHAR2(30)
112 ,USER_STATUS_ID NUMBER
113 ,SALES_REP_ID NUMBER
114 ,COLLECTOR_ID NUMBER
115 ,CONTACT_ID NUMBER
116 ,BROKER_ID NUMBER
117 ,CUSTOMER_REF_DATE DATE
118 ,CUSTOMER_REF_NUMBER VARCHAR2(30)
119 ,RECEIPT_ID NUMBER
120 ,RECEIPT_NUMBER VARCHAR2(30)
121 ,GL_DATE DATE
122 ,COMMENTS VARCHAR2(2000)
123 ,DEDUCTION_ATTRIBUTE_CATEGORY VARCHAR2(30)
124 ,DEDUCTION_ATTRIBUTE1 VARCHAR2(150)
125 ,DEDUCTION_ATTRIBUTE2 VARCHAR2(150)
126 ,DEDUCTION_ATTRIBUTE3 VARCHAR2(150)
127 ,DEDUCTION_ATTRIBUTE4 VARCHAR2(150)
128 ,DEDUCTION_ATTRIBUTE5 VARCHAR2(150)
129 ,DEDUCTION_ATTRIBUTE6 VARCHAR2(150)
130 ,DEDUCTION_ATTRIBUTE7 VARCHAR2(150)
131 ,DEDUCTION_ATTRIBUTE8 VARCHAR2(150)
132 ,DEDUCTION_ATTRIBUTE9 VARCHAR2(150)
133 ,DEDUCTION_ATTRIBUTE10 VARCHAR2(150)
134 ,DEDUCTION_ATTRIBUTE11 VARCHAR2(150)
135 ,DEDUCTION_ATTRIBUTE12 VARCHAR2(150)
136 ,DEDUCTION_ATTRIBUTE13 VARCHAR2(150)
137 ,DEDUCTION_ATTRIBUTE14 VARCHAR2(150)
138 ,DEDUCTION_ATTRIBUTE15 VARCHAR2(150)
139 ,ORG_ID NUMBER
140 ,CUSTOMER_REASON VARCHAR2(30)
141 ,APPLIED_DATE DATE
142 ,APPLIED_ACTION_TYPE VARCHAR2(1)
143 ,AMOUNT_APPLIED NUMBER
144 ,APPLIED_RECEIPT_ID NUMBER
145 ,APPLIED_RECEIPT_NUMBER VARCHAR2(30)
146 ,LEGAL_ENTITY_ID NUMBER
147 );
148
149
150 G_DEDUCTION_REC DEDUCTION_REC_TYPE;
151
152 TYPE DEDUCTION_TBL_TYPE IS TABLE OF DEDUCTION_REC_TYPE INDEX BY BINARY_INTEGER;
153 G_DEDUCTION_TBL DEDUCTION_TBL_TYPE;
154
155 TYPE CLAIM_NOTES_REC_TYPE IS RECORD
156 (
157 CLAIM_NOTES VARCHAR2(2000)
158 );
159
160 TYPE CLAIM_NOTES_TBL_TYPE IS TABLE OF CLAIM_NOTES_REC_TYPE
161 INDEX BY BINARY_INTEGER;
162
163 -- *******************************************************
164 -- Start of Comments
165 -- *******************************************************
166 -- API Name: Create_Deduction
167 -- Type : Public
168 -- Pre-Req :
169 -- Parameters:
170 -- IN
171 -- p_api_version_number IN NUMBER Required
172 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
173 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
174 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
175 -- p_deduction IN DEDUCTION_REC_TYPE Required Default = G_DEDUCTION_REC
176 --
177 -- OUT:
178 -- x_return_status OUT VARCHAR2
179 -- x_msg_count OUT NUMBER
180 -- x_msg_data OUT VARCHAR2
181 -- x_claim_id OUT NUMBER,
182 -- x_claim_number OUT VARCHAR2
183 --
184 -- Version : Current version 1.0
185 --
186 -- Note: This procedure checks information passed from AR to Trade Mgt Claim module
187 -- and then calls Creat_claim function in the private package to create a
188 -- claim record. It returns a claim_id and cliam_number as the result.
189 --
190 -- End of Comments
191 -- *******************************************************
192 PROCEDURE Create_Deduction(
193 p_api_version_number IN NUMBER,
194 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
195 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
196 p_commit IN VARCHAR2 := FND_API.G_FALSE,
197
198 x_return_status OUT NOCOPY VARCHAR2,
199 x_msg_count OUT NOCOPY NUMBER,
200 x_msg_data OUT NOCOPY VARCHAR2,
201
202 p_deduction IN DEDUCTION_REC_TYPE := G_DEDUCTION_REC,
203 x_claim_id OUT NOCOPY NUMBER,
204 x_claim_number OUT NOCOPY VARCHAR2
205 );
206
207
208 -- *******************************************************
209 -- Start of Comments
210 -- *******************************************************
211 -- API Name: Create_Deduction
212 -- Type : Public
213 -- Pre-Req :
214 -- Parameters:
215 -- IN
216 -- p_api_version_number IN NUMBER Required
217 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
218 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
219 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
220 -- P_Deduction IN DEDUCTION_REC_TYPE Required
221 --
222 -- OUT:
223 -- x_return_status OUT VARCHAR2
224 -- x_msg_count OUT NUMBER
225 -- x_msg_data OUT VARCHAR2
226 -- x_claim_id OUT NUMBER,
227 -- x_claim_number OUT VARCHAR2
228 -- x_claim_reason_code_id OUT NUMBER
229 -- x_claim_reason_name OUT NAME
230
231 -- Version : Current version 1.0
232 --
233 -- Note: This procedure checks information passed from AR to Claim module and then
234 -- calls Creat_claim function in the private package to create a claim record.
235 -- It returns a claim_id,cliam_number,reason_code_id,reason_name as the result.
236 --
237 -- End of Comments
238 -- *******************************************************
239 PROCEDURE Create_Deduction(
240 p_api_version_number IN NUMBER,
241 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
242 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
243 p_commit IN VARCHAR2 := FND_API.G_FALSE,
244
245 x_return_status OUT NOCOPY VARCHAR2,
246 x_msg_count OUT NOCOPY NUMBER,
247 x_msg_data OUT NOCOPY VARCHAR2,
248
249 p_deduction IN DEDUCTION_REC_TYPE := G_DEDUCTION_REC,
250 x_claim_id OUT NOCOPY NUMBER,
251 x_claim_number OUT NOCOPY VARCHAR2,
252 x_claim_reason_code_id OUT NOCOPY NUMBER,
253 x_claim_reason_name OUT NOCOPY VARCHAR2
254 );
255
256
257
258 -- *******************************************************
259 -- Start of Comments
260 -- *******************************************************
261 -- API Name: Update_Deduction
262 -- Type : Public
263 -- Pre-Req :
264 -- Parameters:
265 -- IN
266 -- p_api_version_number IN NUMBER Required
267 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
268 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
269 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
270 -- P_Deduction IN Deduction_Rec_Type Required
271 --
272 -- OUT:
273 -- x_return_status OUT VARCHAR2
274 -- x_msg_count OUT NUMBER
275 -- x_msg_data OUT VARCHAR2
276 -- x_object_version_number OUT NUMBER
277 --
278 -- Version : Current version 1.0
279 --
280 -- Note: This procedure update a deduction. It calls the Update_Deduction function in the private
281 -- package.
282 --
283 -- End of Comments
284 -- *******************************************************
285 PROCEDURE Update_Deduction(
286 p_api_version_number IN NUMBER,
287 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
288 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
289 p_commit IN VARCHAR2 := FND_API.G_FALSE,
290
291 x_return_status OUT NOCOPY VARCHAR2,
292 x_msg_count OUT NOCOPY NUMBER,
293 x_msg_data OUT NOCOPY VARCHAR2,
294
295 p_deduction IN DEDUCTION_REC_TYPE,
296 x_object_version_number OUT NOCOPY NUMBER
297 );
298
299
300 -- *******************************************************
301 -- Start of Comments
302 -- *******************************************************
303 -- API Name: Update_Deduction
304 -- Type : Public
305 -- Pre-Req :
306 -- Parameters:
307 -- IN
308 -- p_api_version_number IN NUMBER Required
309 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API_G_FALSE
310 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
311 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
312 -- P_Deduction IN DEDUCTION_REC_TYPE Required
313 --
314 -- OUT:
315 -- x_return_status OUT VARCHAR2
316 -- x_msg_count OUT NUMBER
317 -- x_msg_data OUT VARCHAR2
318 -- x_object_version_number OUT NUMBER
319 -- x_claim_reason_code_id OUT NUMBER
320 -- x_claim_reason_name OUT VARCHAR2
321 --
322 -- Version : Current version 1.0
323 --
324 -- Note: This procedure update a deduction. It calls the Update_Deduction function in the private
325 -- package.
326 --
327 -- End of Comments
328 -- *******************************************************
329 PROCEDURE Update_Deduction(
330 p_api_version_number IN NUMBER,
331 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
332 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
333 p_commit IN VARCHAR2 := FND_API.G_FALSE,
334
335 x_return_status OUT NOCOPY VARCHAR2,
336 x_msg_count OUT NOCOPY NUMBER,
337 x_msg_data OUT NOCOPY VARCHAR2,
338
339 p_deduction IN Deduction_Rec_Type,
340 x_object_version_number OUT NOCOPY NUMBER,
341 x_claim_reason_code_id OUT NOCOPY NUMBER,
342 x_claim_reason_name OUT NOCOPY VARCHAR2,
343 x_claim_id OUT NOCOPY NUMBER,
344 x_claim_number OUT NOCOPY VARCHAR2
345 );
346
347
348 -- *******************************************************
349 -- Start of Comments
350 -- *******************************************************
351 -- API Name: Check_Cancell_Deduction
352 -- Type : Public
353 -- Pre-Req :
354 -- Parameters:
355 -- IN
356 -- P_Claim_Id NUMBER Required
357 --
358 -- Version : Current version 1.0
359 --
360 -- Note: This function checks whether a claims can be cancelled or not.
361 --
362 -- End of Comments
363 -- *******************************************************
364 FUNCTION Check_Cancell_Deduction(
365 p_claim_id NUMBER
366 )
367 RETURN BOOLEAN;
368
369
370 -- *******************************************************
371 -- Start of Comments
372 -- *******************************************************
373 -- API Name: Check_Open_Claims
374 -- Type : Public
375 -- Pre-Req :
376 -- Parameters:
377 -- IN
378 -- p_object_source_id IN NUMBER
379 -- p_receipt_id IN NUMBER Required
380
381 -- Version : Current version 1.0
382 --
383 -- Note: This function checks whether a claim exists in TM in OPEN status.
384 --
385 -- End of Comments
386 -- *******************************************************
387 FUNCTION Check_Open_Claims(
388 p_customer_trx_id NUMBER,
389 p_receipt_id NUMBER
390 )
391 RETURN BOOLEAN;
392
393
394 -- ******************************************************
395 -- Start of Comments
396 -- *******************************************************
397 -- API Name: Get_Claim_Addtional_Info
398 -- Type : Public
399 -- Pre-Req :
400 -- Parameters:
401 -- IN :
402 -- p_source_object_id IN NUMBER Required
403 --
404 -- OUT:
405 -- x_application_ref_num
406 -- x_secondary_appl_ref_id
407 -- x_customer_referenc
408 --
409 -- Note: The procedure returns claim number, claim id, customer reference
410 -- for invoice related deduction.
411 --
412 -- Version : Current version 1.0
413 --
414 -- End of Comments
415 -- *******************************************************
416 PROCEDURE Get_Claim_Additional_Info(
417 p_customer_trx_id IN NUMBER,
418 x_application_ref_num OUT NOCOPY VARCHAR2,
419 x_secondary_appl_ref_id OUT NOCOPY NUMBER,
420 x_customer_reference OUT NOCOPY VARCHAR2
421 );
422
423 -- *******************************************************
424 -- Start of Comments
425 -- *******************************************************
426 -- API Name: Build_Note
427 -- Type : Public
428 -- Pre-Req :
429 -- Parameters:
430 -- IN
431 -- p_message_name IN VARCHAR2 Required
432 -- p_token_1 IN VARCHAR2 Optional Default:= null
433 -- p_token_2 IN VARCHAR2 Optional Default:= null
434 -- p_token_3 IN VARCHAR2 Optional Default:= null
435 -- p_token_4 IN VARCHAR2 Optional Default:= null
436 -- p_token_5 IN VARCHAR2 Optional Default:= null
437 -- p_token_6 IN VARCHAR2 Optional Default:= null
438
439 -- Version : Current version 1.0
440 --
441 -- Note: This function builds a message given the name of the message and tokens
442 -- bugfix 4869928
443 -- End of Comments
444 -- *******************************************************
445
446 FUNCTION Build_Note (
447 p_message_name IN VARCHAR2
448 , p_token_1 IN VARCHAR2:= NULL
449 , p_token_2 IN VARCHAR2:= NULL
450 , p_token_3 IN VARCHAR2:= NULL
451 , p_token_4 IN VARCHAR2:= NULL
452 , p_token_5 IN VARCHAR2:= NULL
453 , p_token_6 IN VARCHAR2:= NULL
454 )
455 RETURN VARCHAR2;
456
457
458 END OZF_CLAIM_GRP;