PrismHR API Guides

1. Create Employee

Metadata:

• employeeStatusCode: Indicates the employee's status (e.g., active, on leave, terminated).

• workLocationCode: Code representing the employee's work location.

• payMethod: Payment method; 'S' for salaried, 'H' for hourly.

• payRate: Employee's pay rate (format: ###.####).

• standardHours: Standard working hours (format: ###.##).

• benefitsGroup: Assigned benefits group.

• payGroup: Assigned pay group.

• payPeriod: Pay period basis; options include:

  • H: Hourly
  • W: Weekly
  • B: Bi-Weekly
  • S: Semi-Monthly
  • M: Monthly
  • Y: Yearly

  Note: IfpayMethod is 'H', then payPeriod must be 'H'.

Unified Model Fields in Knit:

• employmentType: Employee type code (e.g., full-time, part-time).
• employment.designation: Job code representing the employee's position.

2. Terminate Employee

Metadata:

• termStatusCode: Termination status code (as defined by the service provider).
• reasonCode: Code indicating the reason for termination (as defined by the service provider).
• turnOffACH: Boolean indicating if further ACH transactions should be stopped.
• forceApproval: Boolean flag to enforce approval before termination.
• lastDayWorked: Date of last workday (format: YYYY-MM-DD).
• providerNotifiedOn: Date when the provider was notified (format: YYYY-MM-DD).

3. Update Employee Compensation

Metadata:

• reasonCode: Reason for the pay rate change.
• payRate: New pay rate (double; precision: ##.####).
• payPeriod: Pay period (must be valid).
• standardHours: Standard hours for pay calculation (double; precision: ##.##).

4. Create Leave Request

Metadata:

• leaveStatus: Code representing the leave status.
• reasonCode: Code describing the reason for the leave (as defined by the service provider).

5. Enroll Employee in Deduction

Unified Model Fields in Knit:

• deductionId: Identifier for the deduction.
• startDate: Date when the deduction becomes effective (format: YYYY-MM-DD).

Metadata:

• planId: Identifier for the benefit plan.
• effectiveDate: Date when the plan becomes effective (format: YYYY-MM-DD).

6. Update Employee

Honored Fields for Update:

• firstName
• lastName
• workEmail
• personalEmails (only one)

7. Employee Payroll API

Parameters:

• startDate: Start date of the payroll period.
• endDate: End date of the payroll period.

For detailed information, refer to the PrismHR API Documentation.