Payroll Transactions

This solution describes how your application can retrieve employee payroll information from Attendance on Demand.

Basic Information

Use Cases

Attendance on Demand has identified use case scenarios for integrating payroll transactions with other systems.

Consult the table below to find the use case that aligns with your business needs, click the entry for a detailed explanation.

Use Case 1 - Employees Pay Information for the Previous Pay Period

Gather payroll information for each individual employee for the previous pay period by date and pay type designation.

Preconditions

  • Access to Read Employee Pay Data must be granted already
  • Authentication to URI must be in place

API Usages

Read getActiveEmployeesList

  • Returns a list of all active employees

Read extractEmployeeDailySummsByIDNum

Returns an array of Pay Information for the specified employee by date and pay designation

Exception Scenarios

  • Condition: Invalid Employee ID
  • Response Code:Unable to Locate Employee with Identifier
  • How to Handle: Verify that the employee ID passed as a parameter exists

Use Case 2 - Exporting Payroll Information Utilizing Vendor Ops

Gather payroll information based on a pre-configured vendor op

Preconditions

Access to run/execute Vendor Ops

API Usage

Read [getSystemVendorOpsBasic]

  • Returns a list of the Vendor Ops available to the user. This data can be modified prior to executing the Vendor Op

Read executeVendorOperation | Executes vendor operation previously defined in client’s database |

  • These files are returned in hex data format. They will need to be converted to byte format using any standard Hex-to-Byte conversion routine

Exception Scenarios

  • Condition: Invalid Dates used as Parameters
  • Response Code: HyperQuery name does not exist
  • How to Handle: yyyy-mm-dd is required. [Invalid argument to date encode]
  • Verify date is valid and in correct format