homebuild

API Explorer

Payroll Resources (ordered by popularity)
The Payroll domain includes information related to employee earnings and taxes. This includes elements from a typical pay statement, such as gross earnings, net earnings, federal / state income taxes and more.
payroll

Payroll Outputs v1

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

Worker Payroll Instructions v1

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.
View APIs
payroll

Pay Statements v1

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.
View APIs
payroll

Pay Data Input v1

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.
View APIs
payroll

Pay Distributions v2

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.
View APIs
payroll

Paycard Enrollments v2

Employee Self-Enrollment

The following services are required to complete the employee self-enrollment process:

  1. Organization Locations (Core->Organization Locations->Paycard Locations)
  2. Disclosures (Core->Disclosures->Paycard Disclosures)
  3. Accept Paycard Disclosures (Core->Disclosures->Accept Paycard Disclosures)
  4. Verify Associate Paycard Eligibility (Payroll->Paycard Enrollment->Verify Associate Eligibility)
  5. Validate Paycard Address (Payroll->Paycard Enrollment->Validate Address)
  6. Submit Enrollment (Payroll->Paycard Enrollment->Enroll in Paycard)
  7. Verify Enrollment Status (Payroll->Paycard Enrollment->Enrollment Status)

Practitioner Enrollment

The following services are required to complete the practitioner enrollment process:

  1. Organization Locations (Core->Organization Locations->Paycard Locations)
  2. Paycard Funding Accounts (Payroll->Paycard Funding Accounts->Funding Account List)
  3. Validate Paycard Address (Payroll->Paycard Enrollment->Validate Address)
  4. Validate Paycard Account (Payroll->Paycard Enrollment->Validate Paycard Account)
  5. Submit Enrollment (Payroll->Paycard Enrollment->Enroll in Paycard)
  6. Verify Enrollment Status (Payroll->Paycard Enrollment->Enrollment Status)
View APIs
payroll

Tax Statements v1

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.
View APIs
payroll

Cardholders v1

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
View APIs
payroll

Payroll Worker Profiles v1

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