Timesheet/Client.php

Show:

inherited

Classes
- \Service_Timesheet_Client

Table of Contents

Client timesheet service file

Author: Dave Cutler
Copyright: 2011 SOS Staffing Inc.
Package: Service
Subpackage: Timesheet

\Service_Timesheet_Client
jump to top

Package: Service\Timesheet

Client timesheet

Parent(s): \Service_Timesheet
Api
Author: Dave Cutler
Copyright: 2011 SOS Staffing Inc.

Constants

Type	Name	Value
string	TIMESHEET_URL Timesheet web url	'https://secure.sosemploymentgroup.com/timesheet/'
string	TIMESHEET_ROLE SSO role for timesheet access	'WEB_TIME'
integer	VISIBLE Bitwise value for visible elements	1
integer	ASSOCIATE Bitwise value for elements created by associates	2
integer	CLIENT Bitwise value for elements created by clients	4
integer	STAFF Bitwise value for elements created by staff	8
integer	INCOMPLETE Bitwise value for incomplete timesheets	0
integer	ASSOCIATE_SUBMITTED Bitwise value for submitted timesheets	1
integer	CLIENT_NOTIFIED Bitwise value for submitted timesheets where the client has been notified	2
integer	CLIENT_REVIEWED Bitwise value for client reviewed timesheets	4
integer	CLIENT_APPROVED Bitwise value for client approved timesheets	8
integer	STAFF_EXPORTED Bitwise value for timesheets exported to SOAR	16
integer	STAFF_INACTIVE Bitwise value for inactive timesheets (typically paper-completed)	32
integer	STAFF_EXPORT_HOLD Bitwise value for when a timesheet is between sending the export data to SOAR and receiving a response	64
integer	INVOICING_NOTIFIED Bitwise value for when the invoicing department has been notified that the timesheet was exported	128
integer	RETURN_ID Bitwise value for returning timesheet ID	0
integer	RETURN_DETAILS Bitwise value for returning timesheet details	1
integer	RETURN_ENTRIES Bitwise value for returning timesheet entries	2
integer	SHOW_WEEKS Number of valid weeks to provide per assignment	3
integer	REG_WK_HRS Total regular-time hours per week	40
integer	AK_OT_START Hours after which Alaska starts calculating overtime	8
integer	CA_OT_START Hours after which California starts calculating overtime	8
integer	CA_DT_START Hours after which California starts calculating double time	12
integer	OR_OT_START Hours after which Oregon starts calculating overtime	10
integer	PAGINATION_COUNT Number of results returned per page	20
integer	MINIMUM_PAGINATION_COUNT Minimum number of results returned per page	10

Methods

_getListTotal

Returns a count of timesheets by WHERE statement

calculateTotals

Calculates timesheet totals per day and as a whole

Link: https://webservices.sosstaffing.com/timesheet/calculateTotals
Parameters:

entries

List of entries being calculated

state

Assignment state

weekly_pay

(Optional) The weekly pay total

assignment_mileage

(Optional) The per-mile reimbursement amount

Request:

<?xml version="1.0" encoding="UTF-8"?>
   <request>
    <state>[ST]</state>
    <weekly_pay>[#.##]</weekly_pay>
    <assignment_mileage>[#.##]</assignment_mileage>
    <entries>
     <entry>
      <date>[YYYY-MM-DD]</date>
      <type>[type]</type>
      <time_in>[HH:MM]</time_in>
      <time_out>[HH:MM]</time_out>
      <explanation>[explanation]</explanation>
      <unit_number>[#]</unit_number>
      <treatment_number>[#]</treatment_number>
      <expense>[#.##]</expense>
     </entry>
     <entry>
      <...>
     </entry>
    </entries>
   </request>

Response:

<?xml version="1.0" encoding="UTF-8"?>
   <result>
    <responseHeader>
     <status>ok</status>
     <requestTimeMs>[##]</requestTimeMs>
     <params>
      <state>[ST]</state>
      <weekly_pay>[#.##]</weekly_pay>
      <assignment_mileage>[#.##]</assignment_mileage>
      <entries>
       <entry>
        <date>[YYYY-MM-DD]</date>
        <type>[type]</type>
        <time_in>[HH:MM]</time_in>
        <time_out>[HH:MM]</time_out>
        <explanation>[explanation]</explanation>
        <unit_number>[#]</unit_number>
        <treatment_number>[#]</treatment_number>
        <expense>[#.##]</expense>
       </entry>
       <entry>
        <...>
       </entry>
      </entries>
     </params>
    </responseHeader>
    <response>
     <totals>
      <expense_total>[#.##]</expense_total>
      <taxable_meals>[#.##]</taxable_meals>
      <regular_time>[#.##]</regular_time>
      <over_time>[#.##]</over_time>
      <double_time>[#.##]</double_time>
      <days>
       <day>
        <date>[YYYY-MM-DD]</date>
        <expense_total>[#.##]</expense_total>
        <total_time>[#.##]</total_time>
        <regular_time>[#.##]</regular_time>
        <over_time>[#.##]</over_time>
        <double_time>[#.##]</double_time>
        <hours>[#]</hours>
        <minutes>[#]</minutes>
       </day>
       <day>
        <...>
       </day>
      </days>
     </totals>
    </response>
   </result>

countTimesheets

Returns a count of all timesheets for the approver, optionally limited by status

getAllConstants

Returns all constants for the current service

getConstant

Returns a specific constant for the current service by name

getCustomerFields

Returns a list of timesheet entry types allowed by customer

getLocation

Returns location information from a customer number

getTimesheet

Will load an approver-accessible timesheet by an ID or assignment/week ending date. This method will only return timesheets that can by reviewed by the current user.

Link: https://webservices.sosstaffing.com/timesheet_client/getTimesheet?token=[token]
Parameters:

token

A JOSSO session ID

timesheet_id

ID of timesheet to load (Supercedes assignment_id and week_ending)

assignment_id

Assignment ID on timesheet to load (Requires week_ending, soslogin_id)

week_ending

Week ending on timesheet to load (Requires assignment_id, soslogin_id)

soslogin_id

SOS Login ID (person ID) on timesheet to load (Requires assignment_id, week_ending)

return

Amount of information to return. Can be id, full, details, entries

Request:

<?xml version="1.0" encoding="UTF-8"?>
   <request>
    <timesheet_id>[##]</timesheet_id>
    <assignment_id>[##]</assignment_id>
    <week_ending>[YYYY-MM-DD]</week_ending>
    <soslogin_id>[#####]</soslogin_id>
    <return>[id|full|entries|details]</return>
   </request>

Response:

<?xml version="1.0" encoding="UTF-8"?>
   <result>
    <responseHeader>
     <status>ok</status>
     <requestTimeMs>##</requestTimeMs>
     <token>[token]</token>
     <params>
      <timesheet_id>[id]</timesheet_id>
      <assignment_id>[##]</assignment_id>
      <week_ending>[YYYY-MM-DD]</week_ending>
      <soslogin_id>[#####]</soslogin_id>
      <return>[return]</return>
     </params>
    </responseHeader>
    <response>
     <timesheet>

      <!-- Always returned, only node returned for "id" -->
      <timesheet_id>[timesheet_id]</timesheet_id>

      <!-- Returned for "full" or "details" -->
      <week_ending>[YYYY-MM-DD]</week_ending>
      <soslogin_id>[soslogin_id]</soslogin_id>
      <employee_id>[employee_id]</employee_id>
      <branch_id>[branch_id]</branch_id>
      <timecard_lrn>[timecard_lrn]</timecard_lrn>
      <assignment_id>[assignment_id]</assignment_id>
      <assignment_title>[assignment_title]</assignment_title>
      <assignment_address>[assignment_address]</assignment_address>
      <assignment_state>[ST]</assignment_state>
      <assignment_mileage>[#.##]</assignment_mileage>
      <taxable_meals>[#.##]</taxable_meals>
      <expense_total>[#.##]</expense_total>
      <regular_time>[#.##]</regular_time>
      <over_time>[#.##]</over_time>
      <double_time>[#.##]</double_time>
      <employee_signed_date>[YYYY-MM-DD]</employee_signed_date>
      <approval_date>[YYYY-MM-DD]</approval_date>
      <approval_name>[approval_name]</approval_name>
      <flags>[##]</flags>
      <supervisor_email>[supervisor_email]</supervisor_email>
      <supervisor_name>[supervisor_name]</supervisor_name>
      <customer_number>[customer_number]</customer_number>
      <comment_id>[##]</comment_id>
      <comment>[comment]</comment>
      <timesheet_values_id>[timesheet_values_id]</timesheet_values_id>
      <parent_timesheet_values_id>[parent_timesheet_values_id]</parent_timesheet_values_id>
      <created_date>[YYYY-MM-DD HH:ii:ss]</created_date>
      <status>[status]</status>
      <full_name>[full_name]</full_name>
      <first_name>[first_name]</first_name>
      <last_name>[last_name]</last_name>
      <area>[area]</area>
      <area_number>[area_number]</area_number>
      <apply_cash_advance>[apply_cash_advance]</apply_cash_advance>
      <pay>[pay]</pay>
      <gin_number>[gin_number]</gin_number>
      <cost_center>[###]</cost_center>
      <cost_center_number>[cost_center_number]</cost_center_number>
      <rec_pay_for_min_hours>[rec_pay_for_min_hours]</rec_pay_for_min_hours>
      <weekly_pay>[weekly_pay]</weekly_pay>
      <location>
       <customer_number>[customer_number]</customer_number>
       <branch>[###]</branch>
       <department>[department]</department>
       <sub_department>[###]</sub_department>
       <cust5>[#####]</cust5>
       <name>[name]</name>
       <week_ending>[week_ending]</week_ending>
      </location>
      <is_extended>[0|1]</is_extended>

      <!-- Returned for "full" or "entries" -->
      <days>
       <day>
        <date>[YYYY-MM-DD]</date>
        <expense_total>[#.##]</expense_total>
        <total_time>[#.##]</total_time>
        <regular_time>[#.##]</regular_time>
        <over_time>[#.##]</over_time>
        <double_time>[#.##]</double_time>
        <hours>[##]</hours>
        <minutes>[##]</minutes>
        <entries>
         <entry>
          <timesheet_entry_id>[timesheet_entry_id]</timesheet_entry_id>
          <parent_timesheet_entry_id>[parent_timesheet_entry_id]</parent_timesheet_entry_id>
          <timesheet_id>[timesheet_id]</timesheet_id>
          <created>[YYYY-MM-DD HH:ii:ss]</created>
          <modified>[YYYY-MM-DD HH:ii:ss]</modified>
          <date>[YYYY-MM-DD]</date>
          <status>[#]</status>
          <type>[type]</type>
          <time_in>[##:##]</time_in>
          <time_out>[##:##]</time_out>
          <total_time>[#.##]</total_time>
          <explanation>[explanation]</explanation>
          <unit_number>[unit_number]</unit_number>
          <treatment_number>[treatment_number]</treatment_number>
          <expense>[#.##]</expense>
         </entry>
         <entry>
          <...>
         </entry>
        </entries>
       </day>
       <day>
        <...>
       </day>
      </days>

     </timesheet>
    </response>
   </result>

listTimesheets

Lists all timesheets that can be approved by the approver

printTimesheets

Returns a PDF representation of the selected timesheets

reviewTimesheet

Submits an approver review for a timesheet

saveDetails

Saves details to an existing timesheet

Link: https://webservices.sosstaffing.com/timesheet_client/saveTimesheet?token=[token]
Parameters:

token

A JOSSO session ID

details

The timesheet details to save

Request:

<?xml version="1.0" encoding="UTF-8"?>
  <request>
   <details>
    <timesheet_id>[timesheet_id]</timesheet_id>
    <state>[ST]</state>
    <weekly_pay>[#.##]</weekly_pay>
    <assignment_id>[#####]</assignment_id>
    <week_ending>[YYYY-MM-DD]</week_ending>
    <employee_id>[#####]</employee_id>
    <full_name>[full_name]</full_name>
    <first_name>[first_name]</first_name>
    <last_name>[last_name]</last_name>
    <cost_center>[###]</cost_center>
    <gin_number>[#####]</gin_number>
   </details>
  </request>

Response:

<?xml version="1.0" encoding="UTF-8"?>
  <result>
   <responseHeader>
    <status>ok</status>
    <requestTimeMs>[##]</requestTimeMs>
    <token>[token]</token>
    <params>
     <details>
      <timesheet_id>[timesheet_id]</timesheet_id>
      <state>[ST]</state>
      <weekly_pay>[#.##]</weekly_pay>
      <assignment_id>[#####]</assignment_id>
      <week_ending>[YYYY-MM-DD]</week_ending>
      <employee_id>[#####]</employee_id>
      <full_name>[full_name]</full_name>
      <first_name>[first_name]</first_name>
      <last_name>[last_name]</last_name>
      <cost_center>[###]</cost_center>
      <gin_number>[#####]</gin_number>
     </details>
    </params>
   </responseHeader>
   <response>
    <message>Timesheet details have been saved</message>
    <timesheet>
     <timesheet_id>[timesheet_id]</timesheet_id>
     <week_ending>[YYYY-MM-DD]</week_ending>
     <soslogin_id>[soslogin_id]</soslogin_id>
     <employee_id>[employee_id]</employee_id>
     <branch_id>[###]</branch_id>
     <timecard_lrn>[timecard_lrn]</timecard_lrn>
     <assignment_id>[assignment_id]</assignment_id>
     <assignment_title>[assignment_title]</assignment_title>
     <assignment_address>[assignment_address]</assignment_address>
     <assignment_state>[ST]</assignment_state>
     <assignment_mileage>[#.##]</assignment_mileage>
     <taxable_meals>[#.##]</taxable_meals>
     <expense_total>[#.##]</expense_total>
     <regular_time>[#.##]</regular_time>
     <over_time>[#.##]</over_time>
     <double_time>[#.##]</double_time>
     <employee_signed_date>[YYYY-MM-DD]</employee_signed_date>
     <approval_date>[YYYY-MM-DD]</approval_date>
     <approval_name>[approval_name]</approval_name>
     <flags>[##]</flags>
     <supervisor_email>[supervisor_email]</supervisor_email>
     <supervisor_name>[supervisor_name]</supervisor_name>
     <customer_number>[customer_number]</customer_number>
     <comment_id>[##]</comment_id>
     <comment>[comment]</comment>
     <timesheet_values_id>[timesheet_values_id]</timesheet_values_id>
     <parent_timesheet_values_id>[parent_timesheet_values_id]</parent_timesheet_values_id>
     <created_date>[YYYY-MM-DD HH:ii:ss]</created_date>
     <status>[status]</status>
     <full_name>[full_name]</full_name>
     <first_name>[first_name]</first_name>
     <last_name>[last_name]</last_name>
     <area>[area]</area>
     <area_number>[area_number]</area_number>
     <apply_cash_advance>[apply_cash_advance]</apply_cash_advance>
     <pay>[pay]</pay>
     <gin_number>[gin_number]</gin_number>
     <cost_center>[###]</cost_center>
     <cost_center_number>[cost_center_number]</cost_center_number>
     <rec_pay_for_min_hours>[rec_pay_for_min_hours]</rec_pay_for_min_hours>
     <weekly_pay>[#.##]</weekly_pay>
     <location>
      <customer_number>[customer_number]</customer_number>
      <branch>[###]</branch>
      <department>[department]</department>
      <sub_department>[###]</sub_department>
      <cust5>[#####]</cust5>
      <name>[name]</name>
      <week_ending>[week_ending]</week_ending>
     </location>
     <is_extended>[0|1]</is_extended>
    </timesheet>
   </response>
  </result>

saveEntries

Saves entries to an existing timesheet

Link: https://webservices.sosstaffing.com/timesheet_client/saveEntries?token=[token]
Parameters:

token

A JOSSO session ID

timesheet_id

The timesheet ID to which the entries are being saved

entries

The entries being saved

Request:

<?xml version="1.0" encoding="UTF-8"?>
   <request>
    <timesheet_id>[timesheet_id]</timesheet_id>
    <entries>
     <entry>
      <timesheet_entry_id>[#####]</timesheet_entry_id>
      <date>[YYYY-MM-DD]</date>
      <removed>[0|1]</removed>
      <type>[type]</type>
      <time_in>[##:##]</time_in>
      <time_out>[##:##]</time_out>
      <explanation>[explanation]</explanation>
      <expense>[#.##]</expense>
     </entry>
     <entry>
      <...>
     </entry>
    </entries>
   </request>

Response:

<?xml version="1.0" encoding="UTF-8"?>
   <result>
    <responseHeader>
     <status>ok</status>
     <requestTimeMs>[##]</requestTimeMs>
     <token>[token]</token>
     <params>
      <timesheet_id>[timesheet_id]</timesheet_id>
      <entries>
       <entry>
        <timesheet_entry_id>[#####]</timesheet_entry_id>
        <date>[YYYY-MM-DD]</date>
        <removed>[0|1]</removed>
        <type>[type]</type>
        <time_in>[##:##]</time_in>
        <time_out>[##:##]</time_out>
        <explanation>[explanation]</explanation>
        <expense>[#.##]</expense>
       </entry>
       <entry>
        <...>
       </entry>
      </entries>
     </params>
    </responseHeader>
    <response>
     <message>Entries have been saved</message>
     <saved_entries>
      <entry>
       <date>[YYYY-MM-DD]</date>
       <type>[type]</type>
       <time_in>[##:##]</time_in>
       <time_out>[##:##]</time_out>
       <explanation>[explanation]</explanation>
       <expense>[#.##]</expense>
       <total_time>[#.##]</total_time>
       <hours>[##]</hours>
       <minutes>[##]</minutes>
       <timesheet_entry_id>[#####]</timesheet_entry_id>
      </entry>
      <entry>
       <...>
      </entry>
     </saved_entries>
     <totals>
      <expense_total>[#.##]</expense_total>
      <taxable_meals>[#.##]</taxable_meals>
      <regular_time>[#.##]</regular_time>
      <over_time>[#.##]</over_time>
      <double_time>[#.##]</double_time>
      <days>
       <day>
        <date>[YYYY-MM-DD]</date>
        <expense_total>[#.##]</expense_total>
        <total_time>[#.##]</total_time>
        <regular_time>[#.##]</regular_time>
        <over_time>[#.##]</over_time>
        <double_time>[#.##]</double_time>
        <hours>[##]</hours>
        <minutes>[##]</minutes>
       </day>
       <day>
        <...>
       </day>
      </days>
     </totals>
    </response>
   </result>

validateEntry

Validates a new entry, optionally checks against an existing list of entries

Link: https://webservices.sosstaffing.com/timesheet/validateEntry
Parameters:

new_entry

The entry information to validate

timesheet_id

(Optional) The timesheet ID to validate against

days

(Optional) The list of days/entries to validate against

Request:

<?xml version="1.0" encoding="UTF-8"?>
  <request>
   <new_entry>
    <timesheet_entry_id>[####]</timesheet_entry_id>
    <date>[YYYY-MM-DD]</date>
    <removed>[0|1]</removed>
    <type>[type]</type>
    <time_in>[HH:MM]</time_in>
    <time_out>[HH:MM]</time_out>
    <explanation>[explanation]</explanation>
    <unit_number>[#]</unit_number>
    <treatment_number>[#]</treatment_number>
    <expense>[#.##]</expense>
   </new_entry>
   <timesheet_id>[timesheet_id]</timesheet_id>
   <days>
    <day>
     <date>[YYYY-MM-DD]</date>
     <expense_total>[#.##]</expense_total>
     <total_time>[#.##]</total_time>
     <regular_time>[#.##]</regular_time>
     <over_time>[#.##]</over_time>
     <double_time>[#.##]</double_time>
     <hours>[#]</hours>
     <minutes>[#]</minutes>
    </day>
    <day>
     <...>
    </day>
   </days>
  </request>

Response:

<?xml version="1.0" encoding="UTF-8"?>
  <result>
   <responseHeader>
    <status>ok</status>
    <requestTimeMs>[##]</requestTimeMs>
    <params>
     <new_entry>
      <timesheet_entry_id>[####]</timesheet_entry_id>
      <date>[YYYY-MM-DD]</date>
      <removed>[0|1]</removed>
      <type>[type]</type>
      <time_in>[HH:MM]</time_in>
      <time_out>[HH:MM]</time_out>
      <explanation>[explanation]</explanation>
      <unit_number>[#]</unit_number>
      <treatment_number>[#]</treatment_number>
      <expense>[#.##]</expense>
     </new_entry>
     <timesheet_id>[timesheet_id]</timesheet_id>
     <days>
      <day>
       <date>[YYYY-MM-DD]</date>
       <expense_total>[#.##]</expense_total>
       <total_time>[#.##]</total_time>
       <regular_time>[#.##]</regular_time>
       <over_time>[#.##]</over_time>
       <double_time>[#.##]</double_time>
       <hours>[#]</hours>
       <minutes>[#]</minutes>
      </day>
      <day>
       <...>
      </day>
     </days>
    </params>
   </responseHeader>
   <response>
    <message>Timesheet entry is valid</message>
   </response>
  </result>

Timesheet/Client.php

\Service_Timesheet_Clientjump to top

Method List

Constants

Methods

\Service_Timesheet_Client
jump to top