SystemService

This table lists the methods in the system service of the PrismHR Services API.

Method Description

SystemService.getACHFileList

Retrieves a list of ACH files that can be downloaded using SystemService.streamACHData.

SystemService.getARTransactionReport

Retrieves a report containing detailed information about client invoices, payments, and outstanding balances for a specific date range.

SystemService.getData Retrieves system data based on schema and class configurations set up on the Web Service User form. Please see the API documentation website and the Swagger annotations for details about using this method properly.

SystemService.getEmployeeHireType

Retrieves the type of hire that should occur for a given Social Security number, last name, and date of birth of a prospective hire.

SystemService.getEmployerDetails Retrieves data for all employers in the system, or for a specified employer ID.

SystemService.getInvoiceData

Retrieves detailed information about a single invoice or all invoices for a given payroll batch.

SystemService.getPayee

Retrieves information associated with the System > Change > Payee form.

SystemService.getPaymentsPending

Retrieves payroll batches in Payment Pending status (either Wire Transfer Pending – WT.PEND, or Payment Pending – PAYPEND).

SystemService.getPositivePayCheckStub

Retrieves a list of Positive Pay check stub IDs, along with lists of bank account IDs associated with each check stub.

SystemService.getPositivePayFileList

Retrieves details about positive pay files that the system can regenerate.

SystemService.getUnbilledBenefitAdjustments

Retrieves benefit adjustments that have not yet been billed. This is an asynchronous method; see its implementation notes for more information.

SystemService.inactivatePrismUser

Inactivates one or more PrismHR users. Use the checksum from PrismSecurityService.getUserDetails.

SystemService.markReceivedPayments

Moves a specified payroll batch from Wire Transfer Pending status (WT.PEND) to Wire Transfer Received (INITCOMP).

SystemService.positivePayDownload

Generates a positive pay download file for one or more bank accounts.

SystemService.recreatePositivePay

Regenerates one of the positive pay files returned by SystemService.getPositivePayFileList.

SystemService.stopProcess

Stops an asynchronous API process (for example, SystemService.getData).

SystemService.streamACHData

Securely streams ACH file data for a specified file name.