This page (revision-22) was last changed on 26-Nov-2021 10:22 by mmcfarland

This page was created on 26-Nov-2021 10:22 by jmyers

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
22 26-Nov-2021 10:22 6 KB mmcfarland to previous
21 26-Nov-2021 10:22 6 KB jescott to previous | to last

Page References

Incoming links Outgoing links
ADP_TAXATION_INTERFACE
ADP_TAXATION_INTERFACE

Version management

Difference between version and

At line 11 changed 2 lines
*[ADP_TAX_TYPE]\\Tax type indicates whether the amount is considered a deduction, contribution, subject amount or a taxable amount. These will be sent as a set to ADP for processing so it is important to setup three different pay components for each tax code sent to ADP.
*[ADP_TAX_CODE]\\These tax codes are determined between organizations and ADP and must be mapped in the ADP system to ensure that the amounts collected are applied to the correct tax accounts.
*[X_ADP_TAX_TYPE]
At line 14 changed 10 lines
When setting up the tax codes, use the following code pattern:
*The first two characters of the tax code lexicon’s saved value will tell the interface what level of taxation it is and how it should be processed by the interface. The following is the list of allowed codes (in the first two characters):
**FD – This indicates that it is a federal code. The interface will replace the FD with just an F to pass the code along to ADP. (For example, “FD MEDEE” will change to “F MEDEE” before being sent ADP)
**ST – This indicates that it is a specific state tax and the two-character code will be replaced by the two-character code of the state in which the tax applies. (For example, for the state of Arizona the code “ST SIT” would change to “AZ SIT” before being sent to ADP.)
**CT – This indicates that it is a city tax and the specific tax code will be retrieved from [IDGV] based on the jurisdiction determined from [IPPH].
**CN – This indicates that this is a county tax and the specific code for it will be retrieved from [IDGV] based on the jurisdiction listed on [IPPH].
**HT – This indicates that this is a head tax.
**SD – This indicates that this is a school district tax that will be determined from [IDGV] for this employee.
**XX – This is a special code that indicates that the code is an “exempt” code. The interface will remove the “XX” part of the code and then use the remainder of the code without any modifications. For example the code “XX665577” will be changed to “665577” and passed directly to ADP without any further modifications.
*The remaining characters of the tax code indicate the taxation type (e.g. FIT, SIT, etc.) as agreed to between your organization and ADP.
Fixed Lexicon
Tax type indicates whether the amount is considered a Deduction (or Contribution), a subject amount or a taxable amount. These will be sent as a set to ADP for processing so it is important to setup 3 different pay components for each tax code sent to ADP.
DED Deduction
GRS Gross
PRE Pre-taxable
TBL Taxable
At line 25 changed 2 lines
!IPPC
The ADP interface requires four components for each tax code including: Gross, Deduction, Subject and Taxable wages. The Gross amount is retrieved from an element in the payroll called “GROSS” but the remaining three components are setup as separate pay components in [IPPC].
X_ADP_TAX_CODE User Defined Lexicon
These tax codes are decided between ADP and the client and must be mapped in the ADP system to ensure that the amounts collected are applied to the correct tax accounts.
At line 28 changed 4 lines
There are three “External Interface Items” on the [IPPC Information|IPPC#InformationTab] tab. These fields need to be defined in order to set up a code to be transferred to ADP for this taxation interface.
;[ADP Tax Code|ADP_TAX_CODE]:This field holds the tax code that this pay component represents. These tax codes are determined between organizations and ADP and must be mapped in the ADP system to ensure that the amounts collected are applied to the correct tax accounts.
;[ADP Tax Type|ADP_TAX_TYPE]:Tax type indicates whether the amount is considered a deduction, contribution, subject amount or a taxable amount. These will be sent as a set to ADP for processing so it is important to set up three different pay components for each tax code sent to ADP.
;[ADP Tax Resident|ADP_TAX_RESIDENT]:If this toggle is checked, the tax is a resident (not work) tax. If it is listed as a resident tax then the system will use the “home” jurisdiction on the [IPPH] header to determine how to apply the tax otherwise it will use the “work” jurisdiction.
Tax codes follow a code pattern to be setup, in two parts
At line 33 changed 2 lines
!IPPE
In order to transfer the correct amounts to ADP, a number of elements are required by the tax interface. These are defined in [IPPE].
• The first two characters of the tax code lexicon’s Saved Value tell the interface what level of taxation it is and how it should be processed by the interface.
• The remaining characters of the tax code indicate the taxation type (e.g. FIT, SIT, etc.) as agreed to between yourself an ADP
At line 36 changed 5 lines
#ADP_TAX_GROSS: This is the amount of Gross wages for inclusion in this interface. It can be a compound element.
#ADP_TAX_HRS_WORKED: This element will contain an amount equal to the eligible taxable hours worked for the employee during the pay period.
#ADP_TAX_RETIRE: This element holds the retirement earnings for the employee during the pay period.
#ADP_TAX_MOV_3RD
#ADP_TAX_ALLOW
This is the list of allowed codes (in the first two characters):
• FD – This indicates that it is a federal code. The interface will replace the FD with just an F to pass the code along to ADP.
o For example “FD MEDEE” will change to “F MEDEE” to send to ADP.
• ST – This indicates that it is a specific state tax and the two-character code will be replaced by the two-character code of the state in which the tax applies.
o For example, for the state of Arizona the code “ST SIT” would change to “AZ SIT” before being passed along to ADP.
• CT – This indicates that it is a city tax and the specific tax code will be retrieved from the IDGV screen based on the jurisdiction determined from the IPPH screen.
• CN – This indicates that this is a county tax and the specific code for it will be retrieved from the IDGV screen based on the jurisdiction listed on the IPPH screen.
• HT – This indicates that this is a head tax.
• SD – This indicates that this is a school district tax that will be determined from the IDGV screen for this employee.
• XX – This is a special code that indicates that the code is an “exempt” code. The interface will remove the “XX” part of the code and then use the remainder as the code without any modifications. For example the code “XX665577” will be changed to “665577” and passed directly to ADP without any further modifications.
At line 42 changed 2 lines
!IDGV
On [IDGV], users must ensure that tax jurisdiction information and registration IDs for each type of tax that you are sending to ADP have been defined.
IPPC
At line 45 changed one line
Users must fill in the ADP Tax Code on this form to reflect the tax code associated to this particular registration.
The ADP interface requires 4 components for each tax code including: Gross, Deduction, Subject and Taxable wages. The Gross amount is retrieved from an element in the payroll called “GROSS” but the remaining 3 components are setup as separate pay components in the IPPC screen.
Attached to the IPPC screen is a new area called “External Interface Items” and in this tab there are 3 items needed to setup a code to be transferred to ADP for this taxation interface.
At line 47 changed 2 lines
!IPVP
[IPVP] shows the pay runs that have been processed by the [UPADPTXP] update process. If a user is beginning to use this functionality after a large number of pays have already been closed in the application, you may want to use SQL to set the value of this toggle so these past pays are not processed.
ADP TAX CODE – the first is the tax code that this pay component represents. These tax codes are decided between ADP and the client and must be mapped in the ADP system to ensure that the amounts collected are applied to the correct tax accounts.
ADP TAX TYPE – the tax type indicates whether the amount is considered a Deduction (or Contribution), a subject amount or a taxable amount. These will be sent as a set to ADP for processing so it is important to setup 3 different pay components for each tax code sent to ADP.
ADP TAX RESIDENT – this indicates whether the tax is a resident tax or a work tax. If it is listed as a resident tax then the system will use the “home” jurisdiction on the IPPH header to determine how to apply the tax otherwise it will use the “work” jurisdiction.
IPPE
To transfer the correct amounts to ADP a number of elements are required by the tax interface. These are defined in IPPE
(a) ADP_TAX_GROSS_WAGES
This is the amount of Gross wages for inclusion in this interface. It may be a compound element that
(b) ADP_TAX_HOURS_WORKED
This element will contain an amount equal to the eligible taxable hours worked for the employee during the pay period.
(c) ADP_TAX_RETIRE_AMOUNT
This element holds the retirement earnings for the employee during the pay period.
(d) ADP_TAX_SICK_AMOUNT
(e) ADP_TAX_MOVING_AMOUNT
(f) ADP_TAX_ALLOWANCES_AMOUNT
IDGV
You must ensure that you have defined tax jurisdiction information, and registration IDs for each type of tax that you are sending to ADP.
You must fill in the ADP Tax Code on this screen to reflect the tax code associated to this particular registration
At line 50 removed one line
There are two interface programs for executing; one for the Periodic Interface and one for the Quarterly Interface.
At line 52 changed 2 lines
!UPADPTXP – Periodic Interface
This program processes all pay headers ([IPPH]) in each pay run for the selected payroll where the Pay Run stage is “Closed” or “Journalized” and the ADP SUBMITTED toggle in [IPVP] is not checked.
IPVP
This screen shows the pay runs that have been processed by the UPADPTXP update process. If you are beginning to use this functionality after you have a large number of pays already closed in the application, you may want to use SQL to set the value of this toggle so that these past pays are not processed
Executing the Interface Programs
There are two interface programs – one for the Periodic Interface and one for the Quarterly Interface
At line 55 changed one line
There is no mechanism for selecting individual pay runs within a payroll; all pay runs that are not yet processed will be picked up.
UPADPTXP – Periodic Interface
At line 57 changed one line
If you run this program with the "Trial Run" field set to NO, the Pay Run toggle will be checked at the end of the processing. Running it with the "Trial Mode" set to YES, or not defined, the Pay Run toggle will not be checked, and users can reprocess the pay runs over and over again.
This program processes all Pay headers (IPPH) in each pay run for the selected payroll where the Pay Run stage is “Closed” or “Journalized” and the ADP SUBMITTED toggle is not checked, in IPVP.
At line 59 changed one line
The directory defined is a database server-centric directory that must be accessible by the data base server processes.
At line 61 changed one line
This process will also update the table [P2K_PR_ADP_TAX_INTERFACES] with the summarized data. This is used for subsequent reporting by the [UPADPTXQ] (Quarterly Interface) process, and can be viewed with [VPADPI].
There is no mechanism for selecting individual pay runs within a payroll – all pay run s that are not yet processed will be picked up.
At line 63 changed 2 lines
!UPADPTXQ – Quarterly Interface
The [UPADPTXQ] program will process and produce a quarterly taxation file for ADP, for the selected ADP Tax Company (defined in [IPPR]).
If you run this program in “Trial Run = No” mode, then the Pay Run toggle will be checked at the end of the processing. Running it with “Trial Mode = Yes” or not specified will not check the toggle, and you may reprocess the payruns over and over again.
At line 95 added 8 lines
The directory specified is a database server-centric directory, that must be accessible by the data base server processes.
This process will also update the table P2K_PR_ADP_TAX_INTERFACES with the summarized data. This is used for subsequent reporting by the UPADPTXQ (Quarterly Interface) process, and can be viewed with the VPADPI screen.
UPADPTXQ – Quarterly Interface
This program will process and produce a quarterly taxation file for ADP, for the ADP Tax Company (defined in IPPR) as selected.
At line 68 changed one line
%%information Note: This process will report and summarize the data as previously run on [UPADPTXP] interface runs. If a users does not have a complete quarter’s worth of data processed by [UPADPTXP], then this file will not reflect the correct values.%%
Note that this process will report and summarize the data as previously run on UPADPTXP interface runs. If you do not have a complete quarter’s worth of data processed by UPADPTXP, then this file will not reflect the correct values.
At line 70 changed 2 lines
!VPADPI - Viewing ADP Interface Data
[VPADPI] is a view-only form that displays the extensive data created by the [UPADPTXP] process.
VADPI - Viewing ADP Interface Data
This screen is a view-only screen that presents the data created by the UPADPTXP process. The data is extensive and this screen is non performant.
This page (revision-22) was last changed on 26-Nov-2021 10:22 by mmcfarlandTop