DBA Data[Home] [Help]

PACKAGE: APPS.OZF_GL_INTERFACE_PVT

Source


1 PACKAGE OZF_GL_INTERFACE_PVT AS
2 /* $Header: ozfvglis.pls 120.1 2005/09/02 03:36:18 appldev ship $ */
3 
4 TYPE gl_interface_rec_type IS RECORD (
5     EVENT_TYPE_CODE         VARCHAR2(30)
6   , EVENT_STATUS_CODE       VARCHAR2(30)
7   , SOURCE_ID               NUMBER
8   , SOURCE_TABLE            VARCHAR2(30)
9   , ADJUSTMENT_TYPE         VARCHAR2(1)  := 'P'
10   , DR_CODE_COMBINATION_ID  NUMBER       := NULL
11   , CR_CODE_COMBINATION_ID  NUMBER       := NULL
12   , SKIP_ACCOUNT_GEN_FLAG   VARCHAR2(1)  := 'F'
13 );
14 
15 TYPE gl_interface_tbl_type is TABLE OF gl_interface_rec_type;
16 
17 TYPE amount_rec_type IS RECORD (
18     ACCOUNTED_CR        NUMBER
19    ,ACCOUNTED_DR        NUMBER
20    ,CURR_CODE_FC        VARCHAR2(15)
21    ,ENTERED_CR       NUMBER
22    ,ENTERED_DR       NUMBER
23    ,CURR_CODE_TC        VARCHAR2(15)
24    ,LINE_TYPE_CODE         VARCHAR2(30)
25    ,CODE_COMBINATION_ID    NUMBER
26    ,UTILIZATION_ID      NUMBER
27    ,LINE_UTIL_ID        NUMBER
28 );
29 
30 TYPE amount_tbl_type is TABLE OF amount_rec_type;
31 
32 ---------------------------------------------------------------------
33 TYPE CC_ID_REC is RECORD (
34                           amount              number,
35                           acctd_amount        number,
36                           currency_code       varchar2(15),
37                           code_combination_id number,
38                           utilization_id      number,
39                           line_util_id        number
40                          );
41 
42 TYPE CC_ID_TBL is TABLE of CC_ID_REC;
43 ---------------------------------------------------------------------
44 -- PROCEDURE
45 --    Get_GL_Account
46 --
47 -- PURPOSE
48 --    gets the GL Account codes for a account type
49 --       currently supported account types in OMO
50 --       1. EXPENSE_ACCOUNT
51 --       2. ACCRUAL_LIABILITY
52 --       3. VEN_CLEARING
53 --       4. REC_CLEARING
54 --       transaction tables
55 --       1. OZF_CLAIMS_ALL
56 --       2. OZF_FUNDS_UTILIZED_ALL_B
57 --
58 -- PARAMETERS
59 --    p_source_id   : transaction record pk
60 --    p_source_table: transaction table
61 --    p_account_type: GL account type code
62 --    x_cc_id_tbl   : table of code combination ids
63 --
64 -- NOTES
65 ---------------------------------------------------------------------
66 PROCEDURE Get_GL_Account(
67     p_api_version       IN  NUMBER
68    ,p_init_msg_list     IN  VARCHAR2 := FND_API.G_FALSE
69    ,p_commit            IN  VARCHAR2 := FND_API.G_FALSE
70    ,p_validation_level  IN  NUMBER   := FND_API.G_VALID_LEVEL_FULL
71 
72    ,x_return_status     OUT NOCOPY VARCHAR2
73    ,x_msg_data          OUT NOCOPY VARCHAR2
74    ,x_msg_count         OUT NOCOPY NUMBER
75 
76    ,p_source_id         IN  NUMBER
77    ,p_source_table      IN  VARCHAR2
78    ,p_account_type      IN  VARCHAR2
79    ,p_event_type        IN  VARCHAR2 DEFAULT NULL
80    ,x_cc_id_tbl         OUT NOCOPY CC_ID_TBL);
81 ---------------------------------------------------------------------
82 -- PROCEDURE
83 --    set_accounting_rules
84 --
85 -- PURPOSE
86 --    sets accounting rule records
87 --
88 -- PARAMETERS
89 --    p_gl_rec   : the new record to be inserted
90 --    x_accounting_event_rec  : returns the record for accounting event table
91 --    x_ae_header_rec         : returns the record for ae header table
92 --    x_ae_line_rec           : returns the record for ae line table
93 --
94 -- NOTES
95 ---------------------------------------------------------------------
96 PROCEDURE  Set_Accounting_Rules(
97     p_api_version       IN  NUMBER
98    ,p_init_msg_list     IN  VARCHAR2 := FND_API.G_FALSE
99    ,p_validation_level  IN  NUMBER   := FND_API.G_VALID_LEVEL_FULL
100 
101    ,x_msg_data          OUT NOCOPY VARCHAR2
102    ,x_msg_count         OUT NOCOPY NUMBER
103    ,x_return_status     OUT NOCOPY VARCHAR2
104 
105    ,p_gl_rec            IN  gl_interface_rec_type
106    ,p_acctng_entries    IN varchar2
107    ,x_accounting_event_rec  OUT NOCOPY OZF_acctng_events_PVT.acctng_event_rec_type
108    ,x_ae_header_rec     OUT NOCOPY OZF_ae_header_PVT.ae_header_rec_type
109    ,x_ae_line_tbl       OUT NOCOPY OZF_ae_line_PVT.ae_line_tbl_type );
110 ---------------------------------------------------------------------
111 -- PROCEDURE
112 --    Create_Gl_Entry
113 --
114 -- PURPOSE
115 --    Create a gl entry.
116 --
117 -- PARAMETERS
118 --    p_gl_rec   : the new record to be inserted
119 --    x_event_id  : return the claim_id of the new reason code
120 --
121 -- NOTES
122 --    1. object_version_number will be set to 1.
123 ---------------------------------------------------------------------
124 PROCEDURE  Create_Gl_Entry (
125     p_api_version            IN    NUMBER
126    ,p_init_msg_list          IN    VARCHAR2 := FND_API.G_FALSE
127    ,p_commit                 IN    VARCHAR2 := FND_API.G_FALSE
128    ,p_validation_level       IN    NUMBER   := FND_API.G_VALID_LEVEL_FULL
129 
130    ,x_return_status          OUT NOCOPY   VARCHAR2
131    ,x_msg_data               OUT NOCOPY   VARCHAR2
132    ,x_msg_count              OUT NOCOPY   NUMBER
133 
134    ,p_gl_rec                 IN    gl_interface_rec_type
135    ,x_event_id               OUT NOCOPY   NUMBER
136 );
137 ---------------------------------------------------------------------
138 ---------------------------------------------------------------------
139 -- PROCEDURE
140 --    Create_Acctng_Entries
141 
142 --
143 -- PURPOSE
144 --    Create accounting headers and lines
145 --
146 -- PARAMETERS
147 --    p_gl_rec   : the new record to be inserted
148 --    x_event_id  : return the claim_id of the new reason code
149 --
150 -- NOTES
151 --    1. object_version_number will be set to 1.
152 ---------------------------------------------------------------------
153 PROCEDURE  Create_Acctng_Entries (
154    p_api_version            IN    NUMBER
155   ,p_init_msg_list          IN    VARCHAR2 := FND_API.G_FALSE
156   ,p_commit                 IN    VARCHAR2 := FND_API.G_FALSE
157   ,p_validation_level       IN    NUMBER   := FND_API.G_VALID_LEVEL_FULL
158 
159   ,x_return_status          OUT NOCOPY   VARCHAR2
160   ,x_msg_data               OUT NOCOPY   VARCHAR2
161   ,x_msg_count              OUT NOCOPY   NUMBER
162 
163   ,p_event_id               IN    NUMBER
164   ,p_gl_rec                 IN    gl_interface_rec_type
165 );
166 ---------------------------------------------------------------------
167 
168 -- Start R12 Enhancements
169 
170 ---------------------------------------------------------------------
171 -- PROCEDURE
172 --    Revert_GL_Entry
173 --
174 -- PURPOSE
175 --    When promptional claims are cancelled, this API is called to
176 --      delete corresponding accounting entries. If the entries
177 --      are already interfaced to GL, entries in reverse will be
178 --      created to undo the posting.
179 --
180 -- PARAMETERS
181 --    p_claim_id : the claim that is cancelled
182 --
183 -- NOTES
184 ---------------------------------------------------------------------
185 PROCEDURE Revert_GL_Entry (
186     p_api_version         IN    NUMBER
187    ,p_init_msg_list       IN    VARCHAR2 := FND_API.G_FALSE
188    ,p_commit              IN    VARCHAR2 := FND_API.G_FALSE
189    ,p_validation_level    IN    NUMBER   := FND_API.G_VALID_LEVEL_FULL
190 
191    ,x_return_status       OUT NOCOPY   VARCHAR2
192    ,x_msg_data            OUT NOCOPY   VARCHAR2
193    ,x_msg_count           OUT NOCOPY   NUMBER
194 
195    ,p_claim_id            IN    NUMBER
196 );
197 ---------------------------------------------------------------------
198 
199 
200 ---------------------------------------------------------------------
201 -- PROCEDURE
202 --    Post_Accrual_To_GL
203 --
204 -- PURPOSE
205 --    For budget adjustment/utilization, the API will be called.
206 --
207 -- PARAMETERS
208 --   p_utilization_id           Funds utilization_id
209 --   p_utilization_type         'ACCRUAL','ACCRUAL_ADJUSTMENT','OFF_INVOICE'
210 --   p_adjustment_id            'P' for positive'N' for negative
211 --   p_dr_code_combination_id   Debit code combination id
212 --   p_cr_code_combination_id   Credit code combination id
213 --   p_skip_acct_gen_flag       'F' to call OZF Account Generator worflow or
214 --                                not on top of above two gl accounts passed.
215 --                                'T' to bypass OZF Account Generator worflow
216 --                                to derive account.
217 --
218 -- NOTES
219 ---------------------------------------------------------------------
220 PROCEDURE Post_Accrual_To_GL (
221     p_api_version         IN  NUMBER
222    ,p_init_msg_list       IN  VARCHAR2 := FND_API.G_FALSE
223    ,p_commit              IN  VARCHAR2 := FND_API.G_FALSE
224    ,p_validation_level    IN  NUMBER   := FND_API.G_VALID_LEVEL_FULL
225 
226    ,x_return_status       OUT NOCOPY   VARCHAR2
227    ,x_msg_data            OUT NOCOPY   VARCHAR2
228    ,x_msg_count           OUT NOCOPY   NUMBER
229 
230    ,p_utilization_id          IN  NUMBER
231    ,p_utilization_type        IN  VARCHAR2
232    ,p_adjustment_type         IN  VARCHAR2
233    ,p_dr_code_combination_id  IN  NUMBER   := NULL
234    ,p_cr_code_combination_id  IN  NUMBER   := NULL
235    ,p_skip_acct_gen_flag      IN  VARCHAR2 := 'F'
236 
237    ,x_event_id                OUT NOCOPY   NUMBER
238    );
239 
240 ---------------------------------------------------------------------
241 -- PROCEDURE
242 --    Post_Claim_To_GL
243 
244 --
245 -- PURPOSE
246 --    For Claim settlement to be posted to GL, use this API.
247 --
248 -- PARAMETERS
249 --   p_claim_id                   Claim_id
250 --   p_claim_class                'CLAIM''CHARGE''DEDUCTION''OVERPAYMENT'
251 --   p_settlement_method          'CREDIT_MEMO''DEBIT_MEMO''CHECK''AP_DEBIT'
252 --   x_clear_code_combination_id  Code combination id of AR or AP clearing account
253 --
254 -- NOTES
255 ---------------------------------------------------------------------
256 PROCEDURE Post_Claim_To_GL (
257     p_api_version         IN  NUMBER
258    ,p_init_msg_list       IN  VARCHAR2 := FND_API.G_FALSE
259    ,p_commit              IN  VARCHAR2 := FND_API.G_FALSE
260    ,p_validation_level    IN  NUMBER   := FND_API.G_VALID_LEVEL_FULL
261 
262    ,x_return_status       OUT NOCOPY   VARCHAR2
263    ,x_msg_data            OUT NOCOPY   VARCHAR2
264    ,x_msg_count           OUT NOCOPY   NUMBER
265 
266    ,p_claim_id            IN  NUMBER
267    ,p_claim_class         IN  VARCHAR2
268    ,p_settlement_method   IN  VARCHAR2
269 
270    ,x_event_id            OUT NOCOPY   NUMBER
271    ,x_clear_code_combination_id     OUT NOCOPY  NUMBER
272    );
273 
274 ---------------------------------------------------------------------
275 -- PROCEDURE
276 --    Defer_Claim_GL_Posting (Function)
277 --
278 -- PURPOSE
279 --    Function to be used by Claims to test if 'OZF: Claim
280 --     Settlement Workflow' should be called to defer GL posting
281 --
282 -- PARAMETERS
283 --    p_claim_id  : claim_id for which the check is done.
284 --
285 -- NOTES
286 ---------------------------------------------------------------------
287 FUNCTION Defer_Claim_GL_Posting (
288    p_claim_id          IN  NUMBER
289 ) RETURN BOOLEAN;
290 
291 -- End R12 Enhancements
292 
293 END OZF_GL_INTERFACE_PVT;