PayrollService

Method	Description
PayrollService.calculateManualCheck	Calculates the taxes for the provided manual check, generates a voucher that the system includes in the client's next payroll batch, and returns the calculated check amounts. The payroll registers are updated when the payroll processor posts the batch. If calculationOnly is set to false, the check will not be saved to the payroll system. To delete a manual check prior to payroll batch processing, use the PayrollService.deleteManualCheck API operation; once manual checks have been initialized in a batch, they may not be deleted.
PayrollService.calculateNetToGross	Computes the gross amount that, after taxes and deductions, results in the amount of the check specified in targetNetPay.
PayrollService.checkInitializationStatus	Retrieve the current status of a payroll batch initialization.
PayrollService.createPayrollBatches	Create a new manual or special payroll batch.
PayrollService.createPayrollNotes	Create a Payroll Note for the specified client.
PayrollService.createPayrollSchedule	Create a new payroll schedule.
PayrollService.deleteManualCheck	Deletes an unprocessed manual check entry.
PayrollService.downloadPayrollReports	Asynchronous endpoint to download various payroll reports. For example: Gross-To-Net Report, Payroll Allocation Report. Downloads for a specified client for payroll batches which are either in the AP.PEND or COMP state.
PayrollService.getApprovalSummary	Retrieve a summary of an initialized payroll batch that is pending approval.
PayrollService.getBatchInfo	Retrieve Payroll Control information for specified payroll batch.
PayrollService.getBatchListByDate	Retrieve a list of payroll batches whose pay dates or pay periods fall within a specified date range. The method returns some basic information about the batch, and you can filter it by pay group.
PayrollService.getBatchListForApproval	Retrieve a list of batches for a specified client that are ready for client approval.
PayrollService.getBatchListForInitialization	Return a list of batches for a specific client that are ready for initialization.
PayrollService.getBatchPayments	Return all pre-calculated payments to be paid during a specific payroll batch. These payments include bonuses, sales commissions, and expense reimbursements.
PayrollService.getBatchStatus	Returns the status of one or more of a client's payroll batches.
PayrollService.getBillingCodeTotalsForBatch	Retrieve a list of billing codes and the total billing amount for the specified client and payroll batch.
PayrollService.getBillingCodeTotalsWithCosts	Return a list of billing codes, the total billing amount, and the total billing costs for the specified client and payroll batch.
PayrollService.getBillingCodeToalsWithCostsByPayGroup	Retrieve billing code totals for a specified payroll batch, broken out by pay group.
PayrollService.getBillingRuleUnbundled	Retrieve unbundled billing rule information.
PayrollService.getBillingVouchers	Retrieve billing vouchers for specified client and pay dates.
PayrollService.getBillingVouchersByBatch	Retrieve billing vouchers by payroll batch.
PayrollService.getBulkYearToDateValues	Retrieve total year-to-date payroll data, optionally filtered for a particular client or employee (up to a year's worth of year-to-date payroll data, beginning from a specified asOfDate). Alternatively, retrieve data from a single specified voucher.
PayrollService.getClientsWithVouchers	Retrieve a list of clients with at least one payroll voucher for the specified date range.
PayrollService.getEmployee401KContributionsByDate	Retrieve employee 401(k) contributions associated with vouchers within a specified date range (5000 vouchers maximum).
PayrollService.getEmployeeForBatch	Retrieve a list of employee IDs for specified client and payroll batch.
PayrollService.getEmployeeOverrideRates	Return employee override rate information.
PayrollService.getEmployeePayrollSummary	Return a voucher-by-voucher summary of payroll data for a particular client, employee, and year.
PayrollService.getExternalPtoBalance	Retrieve PTO data that was imported into the system by setExternalPtoBalance. You can retrieve up to three past data objects. For more information about these features, see Recording and Retrieving External PTO Balances with the API and Recording External PTO Balances on Check Pay Stubs.
PayrollService.getManualChecks	Return manual check information.
PayrollService.getPayrollAllocationRpt	Asynchronous endpoint. Generates a CSV file containing Payroll Allocation Report data, for download.
PayrollService.getPayrollApproval	Retrieve payroll approval information for a specific batch.
PayrollService.getPayrollBatchWithOptions	Retrieve information about a payroll batch, including data from its Payroll Control > Options configuration.
PayrollService.getPayrollNotes	Retrieve Payroll Notes for specified client.
PayrollService.getPayrollSchedule	Retrieve details of specified payroll schedule.
PayrollService.getPayrollScheduleCodes	Retrieve list of schedule codes and their descriptions.
PayrollService.getPayrollSummary	Retrieve a list of completed payroll batches for a given client for selected batch types for a selected calendar year.
PayrollService.getPayrollVoucherById	Retrieve employee payroll voucher for specified client and voucher.
PayrollService.getPayrollVoucherForBatch	Retrieve employee payroll vouchers for specified client and payroll batch.
PayrollService.getPayrollVouchers	Retrieve employee payroll vouchers for specified client and pay dates.
PayrollService.getPayrollVouchersForEmployee	Retrieve payroll vouchers for specified employee, client, and date range.
PayrollService.getProcessSchedule	Retrieve details of the specified processing schedule.
PayrollService.getProcessScheduleCodes	Retrieve a list of process schedule codes and their descriptions.
PayrollService.getScheduledPayments	Returns an employee's scheduled payment information.
PayrollService.getStandardHours	Retrieve standard hours objects for the client including pay group, pay period, and number of hours.
PayrollService.getYearToDateValues	Retrieve period-to-date (year, quarter, and month) payroll values.
PayrollService.initializePrismBatch	Attempt to initialize a payroll batch.
PayrollService.payGroupScheduleReport	Retrieve pay schedule information for a specified client, pay group, and date range.
PayrollService.payrollFinalization	Asynchronous endpoint. Finalize (post) a payroll batch.
PayrollService.reprintCheckStub	Retrieve an employee's check stub.
PayrollService.setBillingRuleUnbundled	Update unbundled billing rule for a client.
PayrollService.setEmployeeOverrideRates	Update employee override rate information. Use the checksum value from the `PayrollService.getEmployeeOverrideRates` method to update an employee's record.
PayrollService.setExternalPtoBalance	Imports PTO balance data from an external system in JSON format (up to 20 entries per employee). External PTO is associated with a particular client and payroll batch. For more information about these features, see Recording and Retrieving External PTO Balances with the API and Recording External PTO Balances on Check Pay Stubs.
PayrollService.setPayrollApproval	Approve or deny a payroll.
PayrollService.setPayrollNotes	Create, update, or delete a payroll note for the specified client.
PayrollService.setScheduledPayments	Creates or updates scheduled payments for an employee.
PayrollService.updatePayrollBatchWithOptions	Updates the data in a payroll batch, including the Payroll Control > Options settings. You cannot use this method to update posted batches: you must reset the batch status to Time Sheet Entry.
PayrollService.updatePayrollSchedule	Update details for the specified payroll schedule.

PayrollService.calculateManualCheck

Calculates the taxes for the provided manual check, generates a voucher that the system includes in the client's next payroll batch, and returns the calculated check amounts. The payroll registers are updated when the payroll processor posts the batch. If calculationOnly is set to false, the check will not be saved to the payroll system.

To delete a manual check prior to payroll batch processing, use the PayrollService.deleteManualCheck API operation; once manual checks have been initialized in a batch, they may not be deleted.

PayrollService.calculateNetToGross

Computes the gross amount that, after taxes and deductions, results in the amount of the check specified in targetNetPay.

PayrollService.checkInitializationStatus

Retrieve the current status of a payroll batch initialization.

PayrollService.createPayrollBatches

Create a new manual or special payroll batch.

PayrollService.createPayrollNotes

Create a Payroll Note for the specified client.

PayrollService.createPayrollSchedule

Create a new payroll schedule.

PayrollService.deleteManualCheck

Deletes an unprocessed manual check entry.

PayrollService.downloadPayrollReports

Asynchronous endpoint to download various payroll reports. For example: Gross-To-Net Report, Payroll Allocation Report. Downloads for a specified client for payroll batches which are either in the AP.PEND or COMP state.

PayrollService.getApprovalSummary

Retrieve a summary of an initialized payroll batch that is pending approval.

PayrollService.getBatchInfo

Retrieve Payroll Control information for specified payroll batch.

PayrollService.getBatchListByDate

Retrieve a list of payroll batches whose pay dates or pay periods fall within a specified date range. The method returns some basic information about the batch, and you can filter it by pay group.

PayrollService.getBatchListForApproval

Retrieve a list of batches for a specified client that are ready for client approval.

PayrollService.getBatchListForInitialization

Return a list of batches for a specific client that are ready for initialization.

PayrollService.getBatchPayments

Return all pre-calculated payments to be paid during a specific payroll batch. These payments include bonuses, sales commissions, and expense reimbursements.

PayrollService.getBatchStatus

Returns the status of one or more of a client's payroll batches.

PayrollService.getBillingCodeTotalsForBatch

Retrieve a list of billing codes and the total billing amount for the specified client and payroll batch.

PayrollService.getBillingCodeTotalsWithCosts

Return a list of billing codes, the total billing amount, and the total billing costs for the specified client and payroll batch.

PayrollService.getBillingCodeToalsWithCostsByPayGroup

Retrieve billing code totals for a specified payroll batch, broken out by pay group.

PayrollService.getBillingRuleUnbundled

Retrieve unbundled billing rule information.

PayrollService.getBillingVouchers

Retrieve billing vouchers for specified client and pay dates.

PayrollService.getBillingVouchersByBatch

Retrieve billing vouchers by payroll batch.

PayrollService.getBulkYearToDateValues

Retrieve total year-to-date payroll data, optionally filtered for a particular client or employee (up to a year's worth of year-to-date payroll data, beginning from a specified asOfDate). Alternatively, retrieve data from a single specified voucher.

PayrollService.getClientsWithVouchers

Retrieve a list of clients with at least one payroll voucher for the specified date range.

PayrollService.getEmployee401KContributionsByDate

Retrieve employee 401(k) contributions associated with vouchers within a specified date range (5000 vouchers maximum).

PayrollService.getEmployeeForBatch

Retrieve a list of employee IDs for specified client and payroll batch.

PayrollService.getEmployeeOverrideRates

Return employee override rate information.

PayrollService.getEmployeePayrollSummary

Return a voucher-by-voucher summary of payroll data for a particular client, employee, and year.

PayrollService.getExternalPtoBalance

Retrieve PTO data that was imported into the system by setExternalPtoBalance. You can retrieve up to three past data objects. For more information about these features, see Recording and Retrieving External PTO Balances with the API and Recording External PTO Balances on Check Pay Stubs.

PayrollService.getManualChecks

Return manual check information.

PayrollService.getPayrollAllocationRpt

Asynchronous endpoint. Generates a CSV file containing Payroll Allocation Report data, for download.

PayrollService.getPayrollApproval

Retrieve payroll approval information for a specific batch.

PayrollService.getPayrollBatchWithOptions

Retrieve information about a payroll batch, including data from its Payroll Control > Options configuration.

PayrollService.getPayrollNotes

Retrieve Payroll Notes for specified client.

PayrollService.getPayrollSchedule

Retrieve details of specified payroll schedule.

PayrollService.getPayrollScheduleCodes

Retrieve list of schedule codes and their descriptions.

PayrollService.getPayrollSummary

Retrieve a list of completed payroll batches for a given client for selected batch types for a selected calendar year.

PayrollService.getPayrollVoucherById

Retrieve employee payroll voucher for specified client and voucher.

PayrollService.getPayrollVoucherForBatch

Retrieve employee payroll vouchers for specified client and payroll batch.

PayrollService.getPayrollVouchers

Retrieve employee payroll vouchers for specified client and pay dates.

PayrollService.getPayrollVouchersForEmployee

Retrieve payroll vouchers for specified employee, client, and date range.

PayrollService.getProcessSchedule

Retrieve details of the specified processing schedule.

PayrollService.getProcessScheduleCodes

Retrieve a list of process schedule codes and their descriptions.

PayrollService.getScheduledPayments

Returns an employee's scheduled payment information.

PayrollService.getStandardHours

Retrieve standard hours objects for the client including pay group, pay period, and number of hours.

PayrollService.getYearToDateValues

Retrieve period-to-date (year, quarter, and month) payroll values.

PayrollService.initializePrismBatch

Attempt to initialize a payroll batch.

PayrollService.payGroupScheduleReport

Retrieve pay schedule information for a specified client, pay group, and date range.

PayrollService.payrollFinalization

Asynchronous endpoint. Finalize (post) a payroll batch.

PayrollService.reprintCheckStub

Retrieve an employee's check stub.

PayrollService.setBillingRuleUnbundled

Update unbundled billing rule for a client.

PayrollService.setEmployeeOverrideRates

Update employee override rate information. Use the checksum value from the PayrollService.getEmployeeOverrideRates method to update an employee's record.

PayrollService.setExternalPtoBalance

Imports PTO balance data from an external system in JSON format (up to 20 entries per employee). External PTO is associated with a particular client and payroll batch. For more information about these features, see Recording and Retrieving External PTO Balances with the API and Recording External PTO Balances on Check Pay Stubs.

PayrollService.setPayrollApproval

Approve or deny a payroll.

PayrollService.setPayrollNotes

Create, update, or delete a payroll note for the specified client.

PayrollService.setScheduledPayments

Creates or updates scheduled payments for an employee.

PayrollService.updatePayrollBatchWithOptions

Updates the data in a payroll batch, including the Payroll Control > Options settings. You cannot use this method to update posted batches: you must reset the batch status to Time Sheet Entry.

PayrollService.updatePayrollSchedule

Update details for the specified payroll schedule.