Use Case: Getting the Details of a Payroll

GET

/payroll/v2/payroll-output

payrollOutput-default-200.response.json

GET

/payroll/v2/employment-verification/payroll-output

This Uniform Resource Identifier (URI) is for an Equifax Canada client.

empVerification-default-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-summary/earnings

payrollOutput-earnings-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-summary/statutory-deductions

payrollOutput-statutoryDeductions-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-summary/non-statutory-deductions

payrollOutput-NonstatutoryDeductions-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-summary/reportable-earnings-and-benefits

payrollOutput-reportableEarningsANDbenefits-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-allocations/earnings

payrollOutput-Allocationearnings-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-allocations/statutory-deductions

payrollOutput-Allocation-statutoryDeductions-200.response.json

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-allocations/non-statutory-deductions

payrollOutput-Allocation-NonStatutoryDeductions-200.response

GET

/payroll/v2/payroll-output/{output-id}/associate-payment-allocations/reportable-earnings-and-benefits

payrollOutput-Allocation-reportableEarningsANDbenefits-200.res

The role the user is playing during the transaction. Possible values are as follows:

• employee
• manager
• practitioner
• administrator
• supervisor

When coming from Myself capabilities rolecode=employee the roleCode header will be passed in all calls.

When coming from Team capabilities, the roleCode=manager.

When coming from Practitioner capabilities, the roleCode=practitioner.

The API will only accept the rolecode of practitioner or employee.

Specifies the identifier for the service consumer application.

Identifies if the API consumer is an external application or internal to ADP.

Specifies the payroll output level.

Valid entries are as follows:

• blank - List of basic information on matching payroll runs.
• payroll - Payroll Summary totals for a specific payroll run.
• pay - Payment Summary at the employee and associate level for a specific payroll run. 
• acc - Payment summary with accumulation totals at the associate and employee level. 
• acc-all - Accumulation for all employees and associates even if they have no activity during this payroll run.
• Details - Associate Payment details for a specific payroll. 
• run - Returns detail level information for CheckMate runs.

Number of records to be skipped when generating output.

When the level is blank it indicates the number of payroll runs to skip, for all other levels indicates number of associates to be skipped.

default

/payroll/v2/payroll-output?level=default&$filter=payrollGroupCode/codeValue eq 938

filter-defaultLevel-payrollGroupCode-200-response.json

default

/payroll/v2/payroll-output?level=default&$filter=payrollRegionCode/codeValue eq RTE2

filter-defaultLevel-payrollRegionCode-200-response.json

default

/payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/ payrollWeekNumber eq 16

filter-defaultLevel-payrollWeekNumber-200-response.json

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=default

filter-defaultLevel-ItemID-200-response.json

/payroll/v2/payroll-output?level=default&$filter=payrollProcessingJobID eq 902d3a45-2053-4276-9ff5-c1b533b4ad2b

filter-defaultLevel-payrollProcessingJobID-200-response.json

/payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/ scheduleEntryID eq 20191113084715--NMvW1CvRoUycyBEOxy8CyyMarN3ClX4un7widin5II=

filter-defaultLevel-ScheduleEntryID-200-response.json

/payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/ payrollYear eq 2019

filter-defaultLevel-payrollYear-200-response.json

/payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/ payrollRunNumber eq 1

filter-defaultLevel-payrollRunNumber-200-response.json

/payroll/v2/payroll-output?level=default&$filter=associatePayments/ associateOID eq G3588JKQ33NJMXFY

filter-defaultLevel-associateID-200-response.json

payroll

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=payroll

filter-payrollLevel-200-response.json

pay

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=pay

filter-payLevel-200-response.json

details

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=details

filter-detailsLevel-200-response.json

payDetails

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=payDetails

filter-payDetailsLevel-200-response.json

acc

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=acc

filter-accLevel-200-response.json

acc-all

/payroll/v2/payroll-output?$filter=itemID eq nrgEjSqb3bKDrxnBTkd6Qg==&level=acc-all

filter-acc-allLevel-200-response.json

(default, no level= parameter specified)

Payroll Run List

List of payroll runs with default level information for the requested client.

The default level provides a list of payroll runs for the requested client. Each occurrence of a payroll within this list includes default level information, such as basic payroll run parameters, status, and schedule reference information.

Default level data can be called either by Year or from a Beginning Date by using the payrollHistDate filter with the format YYYMMDD:
/payroll/v1/payroll-output?$filter=payrollGroupCode/codeValue eq RR1&payrollHistDate=20181228&level=default
Default level data will not include any data elements occurring prior to region activation data of payroll output (typically 10/2017).
Data returned includes the following Default Level Information for each payroll in the list:

• Processing Job ID
• AutoPay Region Code
• Group Code (AutoPay Company Code)
  Schedule Reference Information includes Schedule ID, Schedule Entry ID (prefaced by the run date/time), and the payroll's Year, Week, and Run Number.

payroll

Payroll Summary

For the selected payroll, there is the following:

• Default level information 
• Payroll summary totals

The payroll level provides the default level information for the selected payroll, followed by payroll summary totals across all associates in that payroll.

Returned data includes the following Default Level Information for each payroll in the list:

• Default Level Information 
• Earnings Summary 
• Reportable Earnings and Benefits Summary
• Reimbursements Summary
• Statutory Deductions Summary
• Non-Statutory Deductions Summary 
• Memos Summary
• Payments Distribution Summary
• Payroll Adjustments
• Third Party Payments

Schema location: /payrollOutput/payrollSummary/

pay

Associate Payment Summary

For the selected payroll default level information and payment information for each pay and each associate. This includes the following:

• High level payment information
• Payment summary
• Payment distributions

The pay level provides the default level information for the selected payroll, followed by a summary of the associate payment information for the associates that had activity in the selected payroll.

Returned data includes the following items for each associate:

• Default Level Information 
• Associate's AOID (Associate Object Identifier) 
• Payment Information (this is an array of pays for each AutoPay file number within the AOID)
• Pay Date, Period Start Date, Period End Date
• Payment Amount (also known as Take Home Pay)
• Payment Summary 
• Earnings (array)
• Reportable Earnings and Benefits (array)
• Reimbursements (array) 
• Statutory Deductions (array)
• Non-Statutory Deductions (array) 
• Memos (array) 
• Payment Distributions
• Payment Document ID (such as a voucher or check) 
• Check Amount 
• Direct Deposits (array)

Schema location: /payrollOutput/associatePayments

details

Associate Payment Detail

For the selected payroll, default level information and payment information for each pay and each associate. This includes the following:

• High level payment information
• Payment details

The details level provides the default level information for the selected payroll, followed by the details of the associate payment information for the associates that had activity in the selected payroll.

Returned data includes the following items for each associate:

• Default Level Information 
• Associate's AOID
• Payment Details (this is an array of pays for each AutoPay file number within the AOID)
• Pay Date, Period Start Date, Period End Date
• Payment Amount (also known as Take Home Pay)
• Payment Allocations 
• Pay Allocation ID
• Earnings (array) 
• Reportable Earnings and Benefits (array) 
• Reimbursements (array)
• Statutory Deductions (array) 
• Non-Statutory Deductions (array)
• Memos (array)

Schema location: /payrollOutput/associatePayments

payDetails

Associate Payment Summary and Details

For the selected payroll, default level information and payment information for each pay and each associate. This includes the following:

• High level payment information
• Payment summary
• Payment distributions
• Payment details

The payDetails level provides the default level information for the selected payroll, followed by a summary of the associate payment information for the associates having activity in the selected payroll and details of the associate payment information.

Returned data includes the following items for each associate:

• Default Level Information 
• Associate's AOID 
• Payment Information (this is an array of pays for each AutoPay file number within the AOID)
• Pay Date, Period Start Date, Period End Date
• Payment Amount (also known as Take Home Pay)
• Payment Summary 
• Earnings (array)
• Reportable Earnings and Benefits (array)
• Reimbursements (array) 
• Statutory Deductions (array)
• Non-Statutory Deductions (array) 
• Memos (array) 
• Payment Distributions
• Payment Document ID (such as voucher or check) 
• Check Amount 
• Direct Deposits (array)
• Payment Details (this is an array of pays for each AutoPay file number within the AOID)
• Pay Date, Period Start Date, Period End Date
• Payment Amount (also known as Take Home Pay)
• Payment Allocations 
• Pay Allocation ID
• Earnings (array)
• Reportable Earnings and Benefits (array)
• Reimbursements (array)
• Statutory Deductions (array)
• Non-Statutory Deductions (array)
• Memos (array)

acc

Associate Payment Summary with YTD & Other Accumulations

For the selected payroll ...

Default level information and payment information for each pay and each associate.

This includes the following:

• High level payment information
• Payment summary
• Payment distributions 
• Payroll accumulations for associates who had activity

The acc level provides the same information as the pay level, with the addition of payroll accumulations information for the following:

• Gross, Earnings
• Reportable Earnings and Benefits Reimbursements
• Statutory Deductions
• Non-Statutory Deductions
• Memos 

The accumulations information for each AutoPay file number will be included within the last pay number in which that accumulation was impacted. If a specific accumulation was not impacted during this payroll, it will be included within pay number 0 (zero).

Note: Accumulations information will only be provided for associates who had activity in the selected payroll.

acc-all

Associate Payment Summary with YTD & Other Accumulations(all associates)

For the selected payroll ...

Default level information and payment information for each pay and each associate.

This includes the following:

• High level payment information
• Payment summary
• Payment distributions 
• Payroll accumulations for all associates in the company

The acc-all level is the same as the acc level, except that payroll accumulations information will be included for all associates in the company.

For unpaid/inactive employees in the acc-all response, any untaken deduction amounts or benefit accrual amounts will be included for each employee will be added to the response. The payment date will be available for all employees. The payment start and end dates will be available only for employees who are paid in the payroll.

For the selected payroll:

• corrected errors allowing activity to progress to preview complete
• crossfoot errors

For error level, all errors as would be listed on the error correction green screen which indicate errors corrected on input to allow the payroll activity to progress.

Crossfoot errors (negative pay) are also included.

Note: Counts of error messages are listed in the confirmMessage section on the payroll (payroll summary) level.

For the selected payroll:

• listing of all dropped pay file numbers and associated messages

For the selected payroll isting of all lien numbers and lien change codes.