PayPeriod Resource
TimeLogs Module
| Endpoints | URI | Access Control | Description |
|---|---|---|---|
| trimLogs | GET /api/PayPeriod/trimLogs |
Endpoint level permissions | |
| save | POST /api/PayPeriod/save |
Admin or Module WRITE | Checks that all pay period logs are submitted, then compiles all into a JSON PayPeriod object and saves it as a record @param $data = [ 'period_start' => 'YYYY-MM-DD' (string) ] |
| csv | GET /api/PayPeriod/csv |
Endpoint level permissions | |
GET /api/PayPeriod/pdf |
Endpoint level permissions | ||
| delete | POST /api/PayPeriod/delete |
Admin or Module WRITE | |
| summary | GET /api/PayPeriod/summary |
Endpoint level permissions | |
| find | GET /api/PayPeriod/find |
Admin or Module READ | |
| get | GET /api/PayPeriod/get |
Admin or Module READ |
| Property | Type | Description |
|---|---|---|
id |
number | |
start |
date | |
end |
date | |
total_reg_hrs |
number | |
total_ot_hrs |
number | |
total_labour_paid |
number | |
total_per_diem_paid |
number | |
total_mileage_paid |
number | |
period_json |
string | |
user_list_json |
string | |
created_by |
number | |
system_generated |
boolean | |
generation_completed_at |
datetime | |
processed |
boolean | |
created_at |
datetime | |
updated_at |
datetime | |
updated_by |
number | |
slug |
string |
| Setting | |
|---|---|
Pagination Limit (when page parameter is set) |
None |
| Default Sort Order |
end ASC |
| Related Resource | Key | Relationship to PayPeriod | Property |
|---|---|---|---|
| User | created_by |
Belongs To | User |
| PayPeriodUserReport | period_id |
Owns Many | PayPeriodUserReport |