1 PACKAGE pay_us_tax_bals_adj_api AS
2 /* $Header: pytbaapi.pkh 120.1.12000000.1 2007/01/18 01:49:38 appldev noship $ */
3 /*#
4 * This package contains US Tax Balance Adjustments API.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Tax Balance Adjustment for United States
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------< create_tax_balance_adjustment >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * Validations specific to US Payroll is done throug this API subsequent to
17 * which adjustment records are created.
18 *
19 * Tax adjustments are made for an assignment within a jurisdiction if taxes
20 * exist for that jurisdiction.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * An assignment record must exist in that Business Group.
27 *
28 * <p><b>Post Success</b><br>
29 * Balance adjustment records are created for that assignment.
30 *
31 * <p><b>Post Failure</b><br>
32 * If the validations fail the process errors out.
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_adjustment_date {@rep:casecolumn
37 * PAY_PAYROLL_ACTIONS.EFFECTIVE_DATE}
38 * @param p_business_group_name Business Group Name.
39 * @param p_assignment_number Assignment Number for the assignment.
40 * @param p_tax_unit_id {@rep:casecolumn PAY_ASSIGNMENT_ACTIONS.TAX_UNIT_ID}
41 * @param p_consolidation_set {@rep:casecolumn
42 * PAY_CONSOLIDATION_SETS.CONSOLIDATION_SET_ID}
43 * @param p_earning_element_type {@rep:casecolumn PAY_BALANCE_TYPES.TAX_TYPE}
44 * @param p_gross_amount Gross Amount entered for adjustments.
45 * @param p_net_amount Net Amount entered for adjustment.
46 * @param p_fit FIT Adjustment Amount
47 * @param p_fit_third Flag to indicate if FIT was withheld by third party.
48 * @param p_ss SS Adjustment Amount
49 * @param p_medicare Medicare Adjustment Amount
50 * @param p_sit SIT Adjustment Amonut
51 * @param p_sui SUI Adjustment Amount
52 * @param p_sdi SDI Adjustment Amount
53 * @param p_county County Adjustment Amount
54 * @param p_city City Adjustment Amount
55 * @param p_city_name {@rep:casecolumn PAY_US_CITY_NAMES.CITY_NAME}
56 * @param p_state_abbrev {@rep:casecolumn PAY_US_STATES.STATE_ABBREV}
57 * @param p_county_name {@rep:casecolumn PAY_US_COUNTIES.COUNTY_NAME}
58 * @param p_zip_code {@rep:casecolumn PER_ADDRESSES.POSTAL_CODE}
59 * @param p_balance_adj_costing_flag Flag to indicate if adjustment action gets
60 * costed.
61 * @param p_balance_adj_prepay_flag Flag to indicate if adjustment action gets
62 * prepaid.
63 * @param p_futa_er FUTA Employer Adjustment Amount
64 * @param p_sui_er SUI Employer Adjustment Amount
65 * @param p_sdi_er SDI Employer Adjustment Amount
66 * @param p_sch_dist_wh_ee School district withheld adjustment amount.
67 * @param p_sch_dist_jur Jurisdiction Code for school district.
68 * @param p_payroll_action_id Payroll action id of the record created in
69 * pay_payroll_actions.
70 * @param p_create_warning Indicates warning if hr_utility.check_warning is set
71 * to true.
72 * @rep:displayname Create Tax Balance Adjustment
73 * @rep:category BUSINESS_ENTITY PAY_BALANCE_ADJUSTMENT
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 PROCEDURE create_tax_balance_adjustment(
82 --
83 -- Common parameters
84 --
85 p_validate IN BOOLEAN DEFAULT FALSE,
86 p_adjustment_date IN DATE,
87 p_business_group_name IN VARCHAR2,
88 p_assignment_number IN VARCHAR2,
89 p_tax_unit_id IN VARCHAR2,
90 p_consolidation_set IN VARCHAR2,
91 --
92 -- Earnings
93 --
94 p_earning_element_type IN VARCHAR2 DEFAULT null,
95 p_gross_amount IN NUMBER DEFAULT 0,
96 p_net_amount IN NUMBER DEFAULT 0,
97 --
98 -- Taxes withheld
99 --
100 p_FIT IN NUMBER DEFAULT 0,
101 p_FIT_THIRD IN VARCHAR2 DEFAULT null,
102 p_SS IN NUMBER DEFAULT 0,
103 p_Medicare IN NUMBER DEFAULT 0,
104 p_SIT IN NUMBER DEFAULT 0,
105 p_SUI IN NUMBER DEFAULT 0,
106 p_SDI IN NUMBER DEFAULT 0,
107 p_County IN NUMBER DEFAULT 0,
108 p_City IN NUMBER DEFAULT 0,
109 --
110 -- Location parameters
111 --
112 p_city_name IN VARCHAR2 DEFAULT null,
113 p_state_abbrev IN VARCHAR2 DEFAULT null,
114 p_county_name IN VARCHAR2 DEFAULT null,
115 p_zip_code IN VARCHAR2 DEFAULT null,
116 p_balance_adj_costing_flag IN VARCHAR2 DEFAULT null,
117 p_balance_adj_prepay_flag IN VARCHAR2 DEFAULT 'N',
118 p_futa_er IN NUMBER DEFAULT 0,
119 p_sui_er IN NUMBER DEFAULT 0,
120 p_sdi_er IN NUMBER DEFAULT 0,
121 p_sch_dist_wh_ee IN NUMBER DEFAULT 0,
122 p_sch_dist_jur IN VARCHAR2 DEFAULT null,
123 --
124 p_payroll_action_id OUT NOCOPY NUMBER,
125 p_create_warning OUT NOCOPY BOOLEAN
126 )
127 ;
128
129 END pay_us_tax_bals_adj_api;
[Home] [Help]