Download the PHP package myoutdesk/prismapi without Composer
On this page you can find all versions of the php package myoutdesk/prismapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package prismapi
PrismHR API
A temporary repo for PrismHR API. The following is a guide.
Initial Requirements
The following information:
PEO ID
Get this from the system parameters page (back office -> System -> Change -> System Parameters
)Web Service User
System -> Change -> System Parameters -> Action Menu -> "Web Service Users". These credentials will be used when calling the API.ClientID (Company Id)
This is needed from the frontend. Can be found on the My Company dashboard. All employees must be under this company.
Authenticating
Getting All Employees
Getting One Or More Employees
Creating Payroll Batch
A payroll batch is needed to upload timesheets. Use the findOrCreatePayrollBatch to do this. A list of employees MUST be set.
Creating MyTimeIn Payroll Import Definition
In order to upload timesheets, a payroll import definition must be specified via the backend menu System
- Change
- Pay Import Definition
. The following must be set:
Definition ID:
MyTimeIn
Description:
MyTimeIn Import
File Format:
Delimited
Delimiter:
Comma
Import Field Definitions Configure the import field definitions like so:
Field # or Start,End POS | Field Name | Conversion Mask |
---|---|---|
1 | $EMPID = Employee ID | |
2 | $DATE = Date Worked Or Period End Date | |
3 | $HOURSPOS | |
4 | $CODEPOS |
MyTimeIn will communicate with Prism using REG or OT in for the CODE column.
The company used to configure MyTimeIn must have access to this pay import definition
Uploading Timesheets
Uploading timesheets has a particular flow to it in order to function. The following must be done, in order:
Building CSV Data
Built out data to send to Prism with: EMPID, DATE (MM/DD/YYYY), HRS, "REG" or "OT" in CSV format. A CSV helper is bundled to assist with this process:
Make a Payroll Batch
Upload Timesheets Into Batch
Approve Upload
Once the timesheets response is error free, then you can approve the upload.
After Approval
After approving the upload of the batch, the entries will appear under Payroll
-Action
-Time Sheet Entry
in PrismHR for an approval from the end user.