Results for “pay_ca_emp_tax_inf”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PAY_CA_EMP_TAX_INF is a Canadian localized payroll PL/SQL package owned by APPS within the Oracle E-Business Suite 12.1.1 and 12.2.2 environments. Its principal business function is the derivation and maintenance of employee-level provincial and federal tax information used by the Oracle Payroll engine during the calculation of Canadian statutory deductions. The package encapsulates the logic required to determine the province of residence and the province of work for a given assignment, to instantiate default tax records on behalf of newly hired or newly transferred employees, and to purge tax rules that are no longer applicable. By centralizing this logic at the database tier, the package ensures that downstream payroll processes — particularly the Canadian Payroll Tax calculation — operate against consistent, effective-dated tax records held in the PAY_CA_EMP_FED_TAX_INFO_F and PAY_CA_EMP_PROV_TAX_INFO_F entities.

Key Procedures and Functions

ETRM documents twenty-three procedures and functions within this package. Among the most significant are the following:

• GET_PROVINCE_CODE — Returns the residence and work province codes and names for a specified assignment and session date, with flags to indicate whether provincial information is required.
• CREATE_DEFAULT_TAX_RECORD — Creates a default employee tax record for an assignment using the supplied business group, legislation code, and work province, returning the effective start and end dates plus a return code and message.
• DELETE_FED_TAX_RULE — Coordination routine that invokes the federal and provincial tax information APIs to end-date tax rules in PAY_CA_EMP_FED_TAX_INFO_F and PAY_CA_EMP_PROV_TAX_INFO_F.
• MAINTAIN_CA_EMPLOYEE_TAXES — Retrieves assignment identifiers for a given period of service and drives the delete_fed_tax_rule logic for each.
• DELETE_TAX_RECORD — Removes an existing tax record in compliance with datetrack semantics.
• GET_TAX_DETAIL_NUM, GET_TAX_DETAIL_CHAR, GET_TAX_DETAIL_DATE, GET_TAX_DETAIL_DFS — Typed accessors that return federal tax detail values (numeric, character, date, and descriptive-flexfield variants) for a given assignment context.
• GET_PROV_TAX_DETAIL_NUM, GET_PROV_TAX_DETAIL_CHAR, GET_PROV_TAX_DETAIL_DFS — Provincial equivalents of the federal accessors, returning numeric, character, and descriptive-flexfield detail values. The user's search term get_prov_tax_detail_char corresponds to this provincial character-returning accessor.
• GET_BASIC_EXEMPTION, GET_MIN_ASG_START_DATE, GET_ADDRESS, GET_SALARY_BASIS, GET_BASE_SALARY, GET_SUMMARY_INFO — Supporting helpers that supply the exemption amounts, assignment baseline dates, employee address, and salary basis/base salary inputs consumed during tax computation.
• CHECK_AGE_UNDER18_OR_OVER70, CHECK_AGE_UNDER18 — Age-verification predicates used in provincial tax determination.

Tables Accessed

The package reads and writes through APPS synonyms across the payroll, HR, and per-address schemas. The principal tax-holding tables are PAY_CA_EMP_FED_TAX_INFO_F and PAY_CA_EMP_PROV_TAX_INFO_F. Supporting payroll structures include PAY_ASSIGNMENT_ACTIONS, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F, PAY_PAYROLL_ACTIONS, PAY_RUN_RESULTS, and PER_PAY_BASES. HR data is sourced from PER_ALL_ASSIGNMENTS_F, HR_LOCATIONS_ALL, HR_ORGANIZATION_INFORMATION, PER_ADDRESSES, and PAY_CA_LEGISLATION_INFO, which supplies Canadian legislative configuration.

Usage Notes

PAY_CA_EMP_TAX_INF is invoked primarily by the Canadian payroll tax calculation engine and by the assignment-level tax Information forms, though it is also referenced by six other packages in the application. Custom extensions that need to retrieve a provincial tax detail value should call the appropriate typed accessor rather than querying PAY_CA_EMP_PROV_TAX_INFO_F directly, thereby preserving datetrack and legislative filtering. Because the procedures are effective-dated, callers should pass a meaningful session or effective date, and they should observe the returned effective start and end dates and return codes when creating or removing tax records. The source header indicates the package was last updated at version 120.2.12010000.4, which is the patch level present in 12.1.1 and remains valid under 12.2.2.