1 PACKAGE hr_de_soc_ins_cle_api AUTHID CURRENT_USER AS
2 /* $Header: hrcleapi.pkh 120.1 2005/10/02 02:00:02 aroussel $ */
3 /*#
4 * This package contains APIs to maintain social insurnace contributions for
5 * Germany.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Social Insurance Contribution
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_soc_ins_contributions >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a social insurance contribution record for Germany.
18 *
19 * A social insurance contribution record is held against an organization.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The organization must exist in the business group
26 *
27 * <p><b>Post Success</b><br>
28 * The social insurance contribution record is successfully inserted into the
29 * database
30 *
31 * <p><b>Post Failure</b><br>
32 * The social insurance contribution record is not inserted into the database
33 * and an error is raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_organization_id A valid organization in the business group
38 * @param p_normal_percentage The normal percentage
39 * @param p_normal_amount The normal amount
40 * @param p_increased_percentage The increased percentage
41 * @param p_increased_amount The increased amount
42 * @param p_reduced_percentage The reduced percentage
43 * @param p_reduced_amount The reduced amount
44 * @param p_effective_start_date If p_validate is false, then set to the
45 * earliest effective start date for the created social insurance contribution.
46 * If p_validate is true, then set to null.
47 * @param p_effective_end_date If p_validate is false, then set to the
48 * effective end date for the created social insurance contribution. If
49 * p_validate is true, then set to null.
50 * @param p_attribute_category This context value determines which flexfield
51 * structure to use with the descriptive flexfield segments.
52 * @param p_attribute1 Descriptive flexfield segment.
53 * @param p_attribute2 Descriptive flexfield segment.
54 * @param p_attribute3 Descriptive flexfield segment.
55 * @param p_attribute4 Descriptive flexfield segment.
56 * @param p_attribute5 Descriptive flexfield segment.
57 * @param p_attribute6 Descriptive flexfield segment.
58 * @param p_attribute7 Descriptive flexfield segment.
59 * @param p_attribute8 Descriptive flexfield segment.
60 * @param p_attribute9 Descriptive flexfield segment.
61 * @param p_attribute10 Descriptive flexfield segment.
62 * @param p_attribute11 Descriptive flexfield segment.
63 * @param p_attribute12 Descriptive flexfield segment.
64 * @param p_attribute13 Descriptive flexfield segment.
65 * @param p_attribute14 Descriptive flexfield segment.
66 * @param p_attribute15 Descriptive flexfield segment.
67 * @param p_attribute16 Descriptive flexfield segment.
68 * @param p_attribute17 Descriptive flexfield segment.
69 * @param p_attribute18 Descriptive flexfield segment.
70 * @param p_attribute19 Descriptive flexfield segment.
71 * @param p_attribute20 Descriptive flexfield segment.
72 * @param p_attribute21 Descriptive flexfield segment.
73 * @param p_attribute22 Descriptive flexfield segment.
74 * @param p_attribute23 Descriptive flexfield segment.
75 * @param p_attribute24 Descriptive flexfield segment.
76 * @param p_attribute25 Descriptive flexfield segment.
77 * @param p_attribute26 Descriptive flexfield segment.
78 * @param p_attribute27 Descriptive flexfield segment.
79 * @param p_attribute28 Descriptive flexfield segment.
80 * @param p_attribute29 Descriptive flexfield segment.
81 * @param p_attribute30 Descriptive flexfield segment.
82 * @param p_effective_date Determines when the DateTrack operation comes into
83 * force.
84 * @param p_object_version_number If p_validate is false, then set to the
85 * version number of the created social insurance contribution. If p_validate
86 * is true, then the value will be null.
87 * @param p_soc_ins_contr_lvls_id The unique identifier of the social insurance
88 * contribution record.
89 * @param p_flat_tax_limit_per_month The flat tax limit per month
90 * @param p_flat_tax_limit_per_year The flat tax limit per year
91 * @param p_min_increased_contribution The minimum increased contribution
92 * @param p_max_increased_contribution The maximum increased contribution
93 * @param p_month1 The first month. Valid values exist in the 'MONTH_CODE'
94 * lookup type.
95 * @param p_month1_min_contribution The minimum contribution for month 1
96 * @param p_month1_max_contribution The maximum contribution for month 1
97 * @param p_month2 The second month. Valid values exist in the 'MONTH_CODE'
98 * lookup type.
99 * @param p_month2_min_contribution The minimum contribution for month 2
100 * @param p_month2_max_contribution The maximum contribution for month 2
101 * @param p_employee_contribution The employee contribution amount
102 * @param p_contribution_level_type The contribution level type.
103 * @rep:displayname Create Social Insurance Contribution for Germany
104 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
105 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
106 * @rep:scope public
107 * @rep:lifecycle active
108 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
109 */
110 --
111 -- {End Of Comments}
112 --
113 procedure create_soc_ins_contributions
114 (
115 p_validate IN boolean default false
116 , p_organization_id IN number default null
117 , p_normal_percentage IN number default null
118 , p_normal_amount IN number default null
119 , p_increased_percentage IN number default null
120 , p_increased_amount IN number default null
121 , p_reduced_percentage IN number default null
122 , p_reduced_amount IN number default null
123 , p_effective_start_date IN OUT NOCOPY date
124 , p_effective_end_date IN OUT NOCOPY date
125 , p_attribute_category IN varchar2 default null
126 , p_attribute1 IN varchar2 default null
127 , p_attribute2 IN varchar2 default null
128 , p_attribute3 IN varchar2 default null
129 , p_attribute4 IN varchar2 default null
130 , p_attribute5 IN varchar2 default null
131 , p_attribute6 IN varchar2 default null
132 , p_attribute7 IN varchar2 default null
133 , p_attribute8 IN varchar2 default null
134 , p_attribute9 IN varchar2 default null
135 , p_attribute10 IN varchar2 default null
136 , p_attribute11 IN varchar2 default null
137 , p_attribute12 IN varchar2 default null
138 , p_attribute13 IN varchar2 default null
139 , p_attribute14 IN varchar2 default null
140 , p_attribute15 IN varchar2 default null
141 , p_attribute16 IN varchar2 default null
142 , p_attribute17 IN varchar2 default null
143 , p_attribute18 IN varchar2 default null
144 , p_attribute19 IN varchar2 default null
145 , p_attribute20 IN varchar2 default null
146 , p_attribute21 IN varchar2 default null
147 , p_attribute22 IN varchar2 default null
148 , p_attribute23 IN varchar2 default null
149 , p_attribute24 IN varchar2 default null
150 , p_attribute25 IN varchar2 default null
151 , p_attribute26 IN varchar2 default null
152 , p_attribute27 IN varchar2 default null
153 , p_attribute28 IN varchar2 default null
154 , p_attribute29 IN varchar2 default null
155 , p_attribute30 IN varchar2 default null
156 , p_effective_date IN date
157 , p_object_version_number OUT NOCOPY number
158 , p_soc_ins_contr_lvls_id OUT NOCOPY number
159 , p_flat_tax_limit_per_month IN number default null
160 , p_flat_tax_limit_per_year IN number default null
161 , p_min_increased_contribution IN number default null
162 , p_max_increased_contribution IN number default null
163 , p_month1 IN varchar2 default null
164 , p_month1_min_contribution IN number default null
165 , p_month1_max_contribution IN number default null
166 , p_month2 IN varchar2 default null
167 , p_month2_min_contribution IN number default null
168 , p_month2_max_contribution IN number default null
169 , p_employee_contribution IN number default null
170 , p_contribution_level_type IN varchar2 default null
171 );
172 --
173 -- ----------------------------------------------------------------------------
174 -- |-----------------------< update_soc_ins_contributions >-------------------|
175 -- ----------------------------------------------------------------------------
176 --
177 -- {Start Of Comments}
178 /*#
179 * This API updates social insurance contribution record for Germany.
180 *
181 *
182 * <p><b>Licensing</b><br>
183 * This API is licensed for use with Human Resources.
184 *
185 * <p><b>Prerequisites</b><br>
186 * The social insurance contribution record must exist.
187 *
188 * <p><b>Post Success</b><br>
192 * The API does not update the organization link and raises an error.
189 * The organization link is successfully updated in the database.
190 *
191 * <p><b>Post Failure</b><br>
193 * @param p_validate If true, then validation alone will be performed and the
194 * database will remain unchanged. If false and all validation checks pass,
195 * then the database will be modified.
196 * @param p_organization_id A valid organization in the business group
197 * @param p_normal_percentage The normal percentage
198 * @param p_normal_amount The normal amount
199 * @param p_increased_percentage The increased percentage
200 * @param p_increased_amount The increased amount
201 * @param p_reduced_percentage The reduced percentage
202 * @param p_reduced_amount The reduced amount
203 * @param p_effective_start_date If p_validate is false, then set to the
204 * effective start date on the updated social insurance row which now exists as
205 * of the effective date. If p_validate is true, then set to null.
206 * @param p_effective_end_date If p_validate is false, then set to the
207 * effective end date on the updated social insurance row which now exists as
208 * of the effective date. If p_validate is true, then set to null.
209 * @param p_attribute_category This context value determines which flexfield
210 * structure to use with the descriptive flexfield segments.
211 * @param p_attribute1 Descriptive flexfield segment.
212 * @param p_attribute2 Descriptive flexfield segment.
213 * @param p_attribute3 Descriptive flexfield segment.
214 * @param p_attribute4 Descriptive flexfield segment.
215 * @param p_attribute5 Descriptive flexfield segment.
216 * @param p_attribute6 Descriptive flexfield segment.
217 * @param p_attribute7 Descriptive flexfield segment.
218 * @param p_attribute8 Descriptive flexfield segment.
219 * @param p_attribute9 Descriptive flexfield segment.
220 * @param p_attribute10 Descriptive flexfield segment.
221 * @param p_attribute11 Descriptive flexfield segment.
222 * @param p_attribute12 Descriptive flexfield segment.
223 * @param p_attribute13 Descriptive flexfield segment.
224 * @param p_attribute14 Descriptive flexfield segment.
225 * @param p_attribute15 Descriptive flexfield segment.
226 * @param p_attribute16 Descriptive flexfield segment.
227 * @param p_attribute17 Descriptive flexfield segment.
228 * @param p_attribute18 Descriptive flexfield segment.
229 * @param p_attribute19 Descriptive flexfield segment.
230 * @param p_attribute20 Descriptive flexfield segment.
231 * @param p_attribute21 Descriptive flexfield segment.
232 * @param p_attribute22 Descriptive flexfield segment.
233 * @param p_attribute23 Descriptive flexfield segment.
234 * @param p_attribute24 Descriptive flexfield segment.
235 * @param p_attribute25 Descriptive flexfield segment.
236 * @param p_attribute26 Descriptive flexfield segment.
237 * @param p_attribute27 Descriptive flexfield segment.
238 * @param p_attribute28 Descriptive flexfield segment.
239 * @param p_attribute29 Descriptive flexfield segment.
240 * @param p_attribute30 Descriptive flexfield segment.
241 * @param p_effective_date Determines when the DateTrack operation comes into
242 * force.
243 * @param p_object_version_number Pass in the current version number of the
244 * social insurance contribution to be updated. When the API completes if
245 * p_validate is false, will be set to the new version number of the updated
246 * social insurance contribution. If p_validate is true will be set to the same
247 * value which was passed in.
248 * @param p_soc_ins_contr_lvls_id The unique identifier of the social insurance
249 * contribution record.
250 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
251 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
252 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
253 * depend on the dates of previous record changes and the effective date of
254 * this change.
255 * @param p_flat_tax_limit_per_month The flat tax limit per month
256 * @param p_flat_tax_limit_per_year The flat tax limit per year
257 * @param p_min_increased_contribution The minimum increased contribution
258 * @param p_max_increased_contribution The maximum increased contribution
259 * @param p_month1 The first month. Valid values exist in the 'MONTH_CODE'
260 * lookup type.
261 * @param p_month1_min_contribution The minimum contribution for month 1
262 * @param p_month1_max_contribution The maximum contribution for month 1
263 * @param p_month2 The second month. Valid values exist in the 'MONTH_CODE'
264 * lookup type.
265 * @param p_month2_min_contribution The minimum contribution for month 2
266 * @param p_month2_max_contribution The maximum contribution for month 2
267 * @param p_employee_contribution The employee contribution amount
268 * @param p_contribution_level_type The contribution level type.
269 * @rep:displayname Update Social Insurance Contribution for Germany
270 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
271 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
272 * @rep:scope public
273 * @rep:lifecycle active
274 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
275 */
276 --
277 -- {End Of Comments}
278 --
279 procedure update_soc_ins_contributions
280 (
281 p_validate IN boolean default false
282 , p_organization_id IN number default hr_api.g_number
283 , p_normal_percentage IN number default hr_api.g_number
284 , p_normal_amount IN number default hr_api.g_number
285 , p_increased_percentage IN number default hr_api.g_number
286 , p_increased_amount IN number default hr_api.g_number
287 , p_reduced_percentage IN number default hr_api.g_number
288 , p_reduced_amount IN number default hr_api.g_number
289 , p_effective_start_date IN OUT NOCOPY date
293 , p_attribute2 IN varchar2 default hr_api.g_varchar2
290 , p_effective_end_date IN OUT NOCOPY date
291 , p_attribute_category IN varchar2 default hr_api.g_varchar2
292 , p_attribute1 IN varchar2 default hr_api.g_varchar2
294 , p_attribute3 IN varchar2 default hr_api.g_varchar2
295 , p_attribute4 IN varchar2 default hr_api.g_varchar2
296 , p_attribute5 IN varchar2 default hr_api.g_varchar2
297 , p_attribute6 IN varchar2 default hr_api.g_varchar2
298 , p_attribute7 IN varchar2 default hr_api.g_varchar2
299 , p_attribute8 IN varchar2 default hr_api.g_varchar2
300 , p_attribute9 IN varchar2 default hr_api.g_varchar2
301 , p_attribute10 IN varchar2 default hr_api.g_varchar2
302 , p_attribute11 IN varchar2 default hr_api.g_varchar2
303 , p_attribute12 IN varchar2 default hr_api.g_varchar2
304 , p_attribute13 IN varchar2 default hr_api.g_varchar2
305 , p_attribute14 IN varchar2 default hr_api.g_varchar2
306 , p_attribute15 IN varchar2 default hr_api.g_varchar2
307 , p_attribute16 IN varchar2 default hr_api.g_varchar2
308 , p_attribute17 IN varchar2 default hr_api.g_varchar2
309 , p_attribute18 IN varchar2 default hr_api.g_varchar2
310 , p_attribute19 IN varchar2 default hr_api.g_varchar2
311 , p_attribute20 IN varchar2 default hr_api.g_varchar2
312 , p_attribute21 IN varchar2 default hr_api.g_varchar2
313 , p_attribute22 IN varchar2 default hr_api.g_varchar2
314 , p_attribute23 IN varchar2 default hr_api.g_varchar2
315 , p_attribute24 IN varchar2 default hr_api.g_varchar2
316 , p_attribute25 IN varchar2 default hr_api.g_varchar2
317 , p_attribute26 IN varchar2 default hr_api.g_varchar2
318 , p_attribute27 IN varchar2 default hr_api.g_varchar2
319 , p_attribute28 IN varchar2 default hr_api.g_varchar2
320 , p_attribute29 IN varchar2 default hr_api.g_varchar2
321 , p_attribute30 IN varchar2 default hr_api.g_varchar2
322 , p_effective_date IN date
323 , p_object_version_number IN OUT NOCOPY number
324 , p_soc_ins_contr_lvls_id IN number
325 , p_datetrack_mode IN varchar2
326 , p_flat_tax_limit_per_month IN number default hr_api.g_number
327 , p_flat_tax_limit_per_year IN number default hr_api.g_number
328 , p_min_increased_contribution IN number default hr_api.g_number
329 , p_max_increased_contribution IN number default hr_api.g_number
330 , p_month1 IN varchar2 default hr_api.g_varchar2
331 , p_month1_min_contribution IN number default hr_api.g_number
332 , p_month1_max_contribution IN number default hr_api.g_number
333 , p_month2 IN varchar2 default hr_api.g_varchar2
334 , p_month2_min_contribution IN number default hr_api.g_number
335 , p_month2_max_contribution IN number default hr_api.g_number
336 , p_employee_contribution IN number default hr_api.g_number
337 , p_contribution_level_type IN varchar2 default hr_api.g_varchar2
338 );
339 --
340 -- ----------------------------------------------------------------------------
341 -- |-----------------------< delete_soc_ins_contributions >-------------------|
342 -- ----------------------------------------------------------------------------
343 --
344 -- {Start Of Comments}
345 /*#
346 * This API deletes a social insurance contribution record for Germany.
347 *
348 *
349 * <p><b>Licensing</b><br>
350 * This API is licensed for use with Human Resources.
351 *
352 * <p><b>Prerequisites</b><br>
353 * The social insurance record to be deleted must exist.
354 *
355 * <p><b>Post Success</b><br>
356 * The social insurance link is successfully deleted from the database.
357 *
358 * <p><b>Post Failure</b><br>
359 * The API does not delete the social insurance contribution row and raises an
360 * error.
361 * @param p_validate If true, then validation alone will be performed and the
362 * database will remain unchanged. If false and all validation checks pass,
363 * then the database will be modified.
364 * @param p_soc_ins_contr_lvls_id Identifier of the record to be deleted.
365 * @param p_effective_start_date If p_validate is false, then set to the
366 * effective start date for the deleted social insurance row which now exists
367 * as of the effective date. If p_validate is true or all row instances have
368 * been deleted then set to null.
369 * @param p_effective_end_date If p_validate is false, then set to the
370 * effective end date for the deleted social insurance row which now exists as
371 * of the effective date. If p_validate is true or all row instances have been
372 * deleted then set to null.
373 * @param p_object_version_number Current version number of the social
374 * insurance record to be deleted.
375 * @param p_effective_date Determines when the DateTrack operation comes into
376 * force.
377 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
378 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
379 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
380 * on the dates of previous record changes and the effective date of this
381 * change.
382 * @rep:displayname Delete Social Insurance Contribution for Germany
383 * @rep:category BUSINESS_ENTITY HR_SOC_INS_CONTRIBUTIONS
384 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
385 * @rep:scope public
386 * @rep:lifecycle active
387 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
388 */
389 --
390 -- {End Of Comments}
391 --
392 procedure delete_soc_ins_contributions
393 (
397 ,p_effective_end_date out nocopy date
394 p_validate in boolean default false
395 ,p_soc_ins_contr_lvls_id in number
396 ,p_effective_start_date out nocopy date
398 ,p_object_version_number in out nocopy number
399 ,p_effective_date in date
400 ,p_datetrack_mode in varchar2
401 );
402 --
403 -- ----------------------------------------------------------------------------
404 -- |----------------------------------< lck >---------------------------------|
405 -- ----------------------------------------------------------------------------
406 -- {Start Of Comments}
407 --
408 -- Description:
409 --
410 -- Prerequisites:
411 --
412 --
413 -- In Parameters:
414 -- Name Reqd Type Description
415 -- p_soc_ins_contr_lvls_id Yes number PK of record
416 -- p_object_version_number Yes number OVN of record
417 -- p_effective_date Yes date Session Date.
418 -- p_datetrack_mode Yes varchar2 Datetrack mode.
419 --
420 -- Post Success:
421 --
422 -- Name Type Description
423 -- p_validation_start_date Yes Derived Effective Start Date.
424 -- p_validation_end_date Yes Derived Effective End Date.
425 --
426 -- Post Failure:
427 --
428 -- Access Status:
429 -- Public.
430 --
431 -- {End Of Comments}
432 --
433 procedure lck
434 (
435 p_soc_ins_contr_lvls_id in number
436 ,p_object_version_number in number
437 ,p_effective_date in date
438 ,p_datetrack_mode in varchar2
439 ,p_validation_start_date out nocopy date
440 ,p_validation_end_date out nocopy date
441 );
442 --
443 end hr_de_soc_ins_cle_api;
[Home] [Help]