API Explorer

This API is used to convey the output of a payroll run

Worker payroll instructions are used to specify recurring general deductions, garnishments, and retirement plan deductions for a specified worker. The Worker Payroll Instructions v1 APIs are used to start or stop payroll instructions for a worker, or to change an instruction that was previously started. You can also view all of the payroll instructions for a worker. API metadata is available.

A Pay Statement describes the details of a payment made to a payee. These details include the net and gross payment amounts, deductions, earnings, and year-to-date payroll accuals. The Pay Statements APIs can be used to retrieve the list of a specified number of pay statements for an associate or to get details for a specific statement.

Pay data input is a one-time payroll change, such as a charity deduction, for a worker. The Pay Data Input v1 APIs are used to add, modify, or replace pay data input for a worker, or to view all of the pay data inputs appllied to a worker. API metadata is also available.

Pay distributions determine how a worker's pay is divided (e.g. 50% to savings, 25% to checking, $100 on a paycard, and the remainder in check). The Pay Distributions APIs can be used to change how a worker's pay is distributed, retrieve a single distribution or list all distributions, or to obtain API metadata.

Worker Tax Statements APIs support the viewing of worker Tax Statements (e.g. (in US) W-2, 1099), and the details of each tax statement.

Financial Accounts are accounts which hold monies of an account holder and have transactions which move monies in and out of the account. An example of a financial account is a prepaid account. These APIs support management of data against a financial account such as balances, transactions, card holders, money movement, etc…

Cardholder API Use Cases

• Search for cardholders - basic cardholder details - the search is not AOID based
  POST /events/payroll/v1/paycard/cardholder.read
  GET /payroll/v1/paycard/cardholders?$filter=[any selection criteria, but SPI]
• Get basic details of an individual cardholder such as demographic data, account ABA/DDA, account status, card status, etc.
  GET /payroll/v1/paycard/cardholders/{aoid}
• Get alternate funding status during self-enrollment (status or account ABA/DDA)
  GET /payroll/v1/paycard/cardholders/{aoid}?$select=cardholderAccount
• Get account data with transactions
  GET /payroll/v1/paycard/cardholders/{aoid}?$select= cardholderAccount&$expand=cardholderAccount/accountTransactions
• Get extended cardholder profile details (without transactions)
  GET /payroll/v1/paycard/cardholders/{aoid}?$expand=profileDetails

This API is for stand-alone clients who don't have access to HCM worker profile