Timesheet Summary Totals

Timesheetsummarytotals

ParameterTypeDescription

[IN]

Parameters described in Overview

CompanyString

[IN]

The users default company number for the companies list

ActionString

[IN]

Identifier for the list requested

ResourceString

[IN]

Identifier for the resource context

DateDate

[IN]

dd/mm/yyyy start of week date

ResponseXML/JSON

[OUT]

An XML tree / JSON string containing a list of weekly totals for time entries

Description

Calling the timesheets API with an action of timesheetsummarytotals retrieves weekly totals for the timesheet weekly summary view. Contains overtime totals where available.

Return Values

Response – List of weekly totals for the timesheetsummary.

The structure of the response is:

<timesheetsummary morepages="False" totalpages="1" totalrows="1">
<timesheetsummarydata>
<variable_timesheetsummarychargeabletotal>17.5
</variable_timesheetsummarychargeabletotal>
<variable_timesheetsummaryfridaytotal>0</variable_timesheetsummaryfridaytotal>
<variable_timesheetsummarymondaytotal>0</variable_timesheetsummarymondaytotal>
<variable_timesheetsummarynonchargeabletotal>1.75
</variable_timesheetsummarynonchargeabletotal>
<variable_timesheetsummarysaturdaytotal>0</variable_timesheetsummarysaturdaytotal>
<variable_timesheetsummarysundaytotal>0</variable_timesheetsummarysundaytotal>
<variable_timesheetsummarythursdaytotal>0</variable_timesheetsummarythursdaytotal>
<variable_timesheetsummarytuesdaytotal>17.5</variable_timesheetsummarytuesdaytotal>
<variable_timesheetsummarywednesdaytotal>0
</variable_timesheetsummarywednesdaytotal>
</timesheetsummarydata>

<timesheetsummarydata>
<variable_timesheetsummarychargeableot1total>1
</variable_timesheetsummarychargeableot1total>
<variable_timesheetsummaryfridayot1total>0</variable_timesheetsummaryfridayot1total>
<variable_timesheetsummarynonchargeableot1total>0.25
</variable_timesheetsummarynonchargeableot1total>
<variable_timesheetsummarysaturdayot1total>0
</variable_timesheetsummarysaturdayot1total>
<variable_timesheetsummarysundayot1total>0
</variable_timesheetsummarysundayot1total>
<variable_timesheetsummarythursdayot1total>0
</variable_timesheetsummarythursdayot1total>
<variable_timesheetsummarytuesdayot1total>1
</variable_timesheetsummarytuesdayot1total>
<variable_timesheetsummaryviewmondayot1total>0
</variable_timesheetsummaryviewmondayot1total>
<variable_timesheetsummarywednesdayot1total>0.25
</variable_timesheetsummarywednesdayot1total>
</timesheetsummarydata>

<timesheetsummarydata>
<variable_timesheetsummarychargeableot2total>1
</variable_timesheetsummarychargeableot2total>
<variable_timesheetsummaryfridayot2total>0</variable_timesheetsummaryfridayot2total>
<variable_timesheetsummarymondayot2total>0
</variable_timesheetsummarymondayot2total>
<variable_timesheetsummarynonchargeableot2total>0.25
</variable_timesheetsummarynonchargeableot2total>
<variable_timesheetsummarysaturdayot2total>0
</variable_timesheetsummarysaturdayot2total>
<variable_timesheetsummarysundayot2total>0
</variable_timesheetsummarysundayot2total>
<variable_timesheetsummarythursdayot2total>0
</variable_timesheetsummarythursdayot2total>
<variable_timesheetsummarytuesdayot2total>1
</variable_timesheetsummarytuesdayot2total>
<variable_timesheetsummarywednesdayot2total>0.25
</variable_timesheetsummarywednesdayot2total>
</timesheetsummarydata>
</timesheetsummary>
{
    "responsecode": 1,
    "responsestatus": "OK",
    "errorcode": 0,
    "errormessage": "",
    "totalrows": 1,
    "totalpages": 1,
    "responsemessage": "",
    "pagerows": 0,
    "pagenumber": 1,
    "success": true,
    "ot1totals": [
        {
            "variable_timesheetsummarychargeableot1total": 1,
            "variable_timesheetsummaryfridayot1total": 0,
            "variable_timesheetsummarymondayot1total": 0,
            "variable_timesheetsummarynonchargeableot1total": 0.25,
            "variable_timesheetsummarysaturdayot1total": 0,
            "variable_timesheetsummarysundayot1total": 0,
            "variable_timesheetsummarythursdayot1total": 0,
            "variable_timesheetsummarytuesdayot1total": 1,
            "variable_timesheetsummarywednesdayot1total": 0.25
        }
    ],
    "ot2totals": [
        {
            "variable_timesheetsummarychargeableot2total": 1,
            "variable_timesheetsummaryfridayot2total": 0,
            "variable_timesheetsummarymondayot2total": 0,
            "variable_timesheetsummarynonchargeableot2total": 0.25,
            "variable_timesheetsummarysaturdayot2total": 0,
            "variable_timesheetsummarysundayot2total": 0,
            "variable_timesheetsummarythursdayot2total": 0,
            "variable_timesheetsummarytuesdayot2total": 1,
            "variable_timesheetsummarywednesdayot2total": 0.25
        }
    ],
    "totals": [
        {
            "variable_timesheetsummarychargeabletotal": 16.5,
            "variable_timesheetsummaryfridaytotal": 0,
            "variable_timesheetsummarymondaytotal": 0,
            "variable_timesheetsummarynonchargeabletotal": 1.75,
            "variable_timesheetsummarysaturdaytotal": 0,
            "variable_timesheetsummarysundaytotal": 0,
            "variable_timesheetsummarythursdaytotal": 0,
            "variable_timesheetsummarytuesdaytotal": 16.5,
            "variable_timesheetsummarywednesdaytotal": 1.75
        }
    ]
}