HomeAPI Reference
HomeAPI Reference
HomeAPI Reference
API Reference
Start typing to search…

Timesheet Summary Data

Timesheetsummarydata

Parameter Type Description
[IN] 
     Parameters described in Overview
  </td>
</tr>
<tr>
  <td>
    Company
  </td>
  <td>
    String
  </td>
  <td>
    [IN]

     The users default company number for the companies list
  </td>
</tr>
<tr>
  <td>
    Action
  </td>
  <td>
    String
  </td>
  <td>
    [IN]

     Identifier for the list requested
  </td>
</tr>
<tr>
  <td>
    Resource
  </td>
  <td>
    String
  </td>
  <td>
    [IN]

     Identifier for the resource context
  </td>
</tr>
<tr>
  <td>
    Date
  </td>
  <td>
    Date
  </td>
  <td>
    [IN]

     dd/mm/yyyy start of week date
  </td>
</tr>
<tr>
  <td>
    Response
  </td>
  <td>
    XML/JSON
  </td>
  <td>
    [OUT]

     An XML tree / JSON string containing a date range for the timesheetsummary.
  </td>
</tr>

Description

Calling the timesheets API with an action of timesheetsummarydata retrieves the weekly timesheet summary entries.

Return Values

Response – Timesheetsummary entries.

The structure of the response is:

<timesheetsummary morepages="False" totalpages="1" totalrows="1">
  <timesheetsummarydata>
    <array_timesheetsummarycompany>
      The Professional Services Company
    </array_timesheetsummarycompany>
    <array_timesheetsummarydescription>
      1/00000695.001 - Phils Company - Test Description
    </array_timesheetsummarydescription>
    <array_timesheetsummarymonday>0</array_timesheetsummarymonday>
    <array_timesheetsummaryfriday>0</array_timesheetsummaryfriday>
    <array_timesheetsummaryorder>00011/00000695.001</array_timesheetsummaryorder>
    <array_timesheetsummarysaturday>0</array_timesheetsummarysaturday>
    <array_timesheetsummarysunday>0</array_timesheetsummarysunday>
    <array_timesheetsummarythursday>0</array_timesheetsummarythursday>
    <array_timesheetsummarytotal>2</array_timesheetsummarytotal>
    <array_timesheetsummarytuesday>2</array_timesheetsummarytuesday>
    <array_timesheetsummaryunique>1/00000695.001</array_timesheetsummaryunique>
    <array_timesheetsummarywednesday>0</array_timesheetsummarywednesday>
  </timesheetsummarydata>
</timesheetsummary>

{
    "errormessage": "",
    "responsecode": 1,
    "pagerows": 0,
    "totalrows": 10,
    "responsestatus": "OK",
    "success": true,
    "responsemessage": "",
    "errorcode": 0,
    "totalpages": 1,
    "pagenumber": 1,
    "data": [
        {
            "array_timesheetsummarymonday": 0,
            "array_timesheetsummarytuesday": 2,
            "array_timesheetsummarysaturday": 0,
            "array_timesheetsummarythursday": 0,
            "array_timesheetsummarycompany": "The Professional Services Company",
            "array_timesheetsummarydescription": "1/00000695.001 - Phils Company - Test Description",
            "array_timesheetsummarytotal": 2,
            "array_timesheetsummaryorder": "00011/00000695.001",
            "array_timesheetsummarysunday": 0,
            "array_timesheetsummaryfriday": 0,
            "array_timesheetsummaryunique": "1/00000695.001",
            "array_timesheetsummarywednesday": 0
        }
    ]
}