1 PACKAGE hr_nz_tax_api AS
2 /* $Header: hrnzwrtx.pkh 120.4 2005/10/31 03:19:48 rpalli noship $ */
3 /*#
4 * This package contains tax related APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Tax for New Zealand
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< maintain_tax_info >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API maintains the Tax information for an employee.
17 *
18 * The API updates the tax element details by using the core
19 * update_element_entry.
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 element "PAYE Information" and the corresponding links should be active
26 * as of the date.
27 *
28 * <p><b>Post Success</b><br>
29 * The API successfully updates the tax element entry with the details.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not update the entry and raises an error.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_assignment_id Identifies the assignment for which you update the
37 * tax info.
38 * @param p_effective_date Determines when the DateTrack operation takes
39 * effect.
40 * @param p_mode Indicates which DateTrack mode to use when updating the
41 * record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
42 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
43 * depend on the dates of previous record changes and the effective date of
44 * this change.
45 * @param p_business_group_id Indicates the Business group in New Zealand where
46 * the employee is present.
47 * @param p_cost_allocation_keyflex_id Indicates the Code combination id of the
48 * segment combination which is used in the costing of element entry.
49 * @param p_updating_action_id Updating action id.
50 * @param p_updating_action_type Updating action type.
51 * @param p_original_entry_id Original entry id.
52 * @param p_creator_type Source of element entry, eg.Form, MIX process etc.
53 * @param p_comment_id Comment identifier.
54 * @param p_creator_id Creator id.
55 * @param p_reason Reason attached to element entry. Validated via lookup
56 * @param p_subpriority Subpriority used to process the element entry.
57 * @param p_date_earned Date earned.
58 * @param p_personal_payment_method_id Personal payment type attached to the
59 * element entry, eg. Cash.
60 * @param p_attribute_category This context value determines which flexfield
61 * structure to use with the descriptive flexfield segments.
62 * @param p_attribute1 Descriptive flexfield segment.
63 * @param p_attribute2 Descriptive flexfield segment.
64 * @param p_attribute3 Descriptive flexfield segment.
65 * @param p_attribute4 Descriptive flexfield segment.
66 * @param p_attribute5 Descriptive flexfield segment.
67 * @param p_attribute6 Descriptive flexfield segment.
68 * @param p_attribute7 Descriptive flexfield segment.
69 * @param p_attribute8 Descriptive flexfield segment.
70 * @param p_attribute9 Descriptive flexfield segment.
71 * @param p_attribute10 Descriptive flexfield segment.
72 * @param p_attribute11 Descriptive flexfield segment.
73 * @param p_attribute12 Descriptive flexfield segment.
74 * @param p_attribute13 Descriptive flexfield segment.
75 * @param p_attribute14 Descriptive flexfield segment.
76 * @param p_attribute15 Descriptive flexfield segment.
77 * @param p_attribute16 Descriptive flexfield segment.
78 * @param p_attribute17 Descriptive flexfield segment.
79 * @param p_attribute18 Descriptive flexfield segment.
80 * @param p_attribute19 Descriptive flexfield segment.
81 * @param p_attribute20 Descriptive flexfield segment.
82 * @param p_tax_code Indicates the Special Tax Code.
83 * @param p_special_tax_code Indicates the Special Tax Rate for the employee.
84 * @param p_paye_special_rate Indicates the Paye Special Tax Rate.
85 * @param p_acc_special_rate Indicates the Acc Special Tax Rate input of the
86 * element.
87 * @param p_student_loan_rate Indicates the loan rate of the Student.
88 * @param p_all_extra_emol_at_high_rate Indicates the All Extra Emol At High
89 * Rate.
90 * @param p_effective_start_date If p_validate is false, then set to the
91 * effective start date on the updated tax information element row which now
92 * exists as of the effective date. If p_validate is true, then set to null.
93 * @param p_effective_end_date If p_validate is false, then set to the
94 * effective end date on the updated tax information row which now exists as of
95 * the effective date. If p_validate is true, then set to null.
96 * @param p_update_warning Always set to delete warning if applicable.
97 * @rep:displayname Maintain Tax Information for New Zealand
98 * @rep:category BUSINESS_ENTITY PAY_EMP_TAX_INFO
99 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
100 * @rep:scope public
101 * @rep:lifecycle active
102 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
103 */
104 --
105 -- {End Of Comments}
106 --
107 PROCEDURE maintain_tax_info
108 (p_validate IN BOOLEAN
109 ,p_assignment_id IN NUMBER
110 ,p_effective_date IN DATE
111 ,p_mode IN VARCHAR2
112 ,p_business_group_id IN NUMBER
113 ,p_cost_allocation_keyflex_id IN NUMBER DEFAULT hr_api.g_number
114 ,p_updating_action_id IN NUMBER DEFAULT hr_api.g_number
115 ,p_updating_action_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
116 ,p_original_entry_id IN NUMBER DEFAULT hr_api.g_number
117 ,p_creator_type IN VARCHAR2 DEFAULT hr_api.g_varchar2
118 ,p_comment_id IN NUMBER DEFAULT hr_api.g_number
119 ,p_creator_id IN NUMBER DEFAULT hr_api.g_number
120 ,p_reason IN VARCHAR2 DEFAULT hr_api.g_varchar2
121 ,p_subpriority IN NUMBER DEFAULT hr_api.g_number
122 ,p_date_earned IN DATE DEFAULT hr_api.g_date
123 ,p_personal_payment_method_id IN NUMBER DEFAULT hr_api.g_number
124 ,p_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2
125 ,p_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2
126 ,p_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2
127 ,p_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2
128 ,p_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2
129 ,p_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2
130 ,p_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2
131 ,p_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2
132 ,p_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2
133 ,p_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2
134 ,p_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2
135 ,p_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2
136 ,p_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2
137 ,p_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2
138 ,p_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2
139 ,p_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2
140 ,p_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2
141 ,p_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2
142 ,p_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2
143 ,p_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2
144 ,p_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2
145 ,p_tax_code IN VARCHAR2 DEFAULT 'ND'
146 ,p_special_tax_code IN VARCHAR2 DEFAULT 'N'
147 ,p_paye_special_rate IN NUMBER DEFAULT hr_api.g_number
148 ,p_acc_special_rate IN NUMBER DEFAULT hr_api.g_number
149 ,p_student_loan_rate IN NUMBER DEFAULT hr_api.g_number
150 ,p_all_extra_emol_at_high_rate IN VARCHAR2 DEFAULT 'N'
151 ,p_effective_start_date OUT NOCOPY DATE
152 ,p_effective_end_date OUT NOCOPY DATE
153 ,p_update_warning OUT NOCOPY BOOLEAN
154 );
155
156 END hr_nz_tax_api;
[Home] [Help]