HomeAPI Reference
HomeAPI Reference
HomeAPI Reference
API Reference

Timesheet Summary

Timesheetsummary

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 the summary list of weekly timesheet entries for the resource

Description

Calling the timesheets API with an action of timesheetsummary retrieves for the weekly timesheet summary.
Returns a summary of weekly timesheets for the date requested
The data returned will be for the whole week (Monday - Sunday) and the rquest date can be any date within that week (yyyy-mm-dd)

Return Values

Response – Summary of timesheet entries for a given week, for the resource context.

The structure of the response is:

<timesheetsummary morepages="False" totalpages="1" totalrows="2">
<timesheetsummarydata>
<array_timesheetsummarycompany>
Confidence Creative
</array_timesheetsummarycompany>
<array_timesheetsummarydescription>
1/00000591.001 - Cartier - A5 Brochure, 12 Page, Full Colour - A4 Brochure, 4 Page,
</array_timesheetsummarydescription>
<array_timesheetsummaryfriday>0</array_timesheetsummaryfriday>
<array_timesheetsummarymonday>0</array_timesheetsummarymonday>
<array_timesheetsummaryorder>00011/00000591.001</array_timesheetsummaryorder>
<array_timesheetsummarysaturday>0</array_timesheetsummarysaturday>
<array_timesheetsummarysunday>0</array_timesheetsummarysunday>
<array_timesheetsummarythursday>28</array_timesheetsummarythursday>
<array_timesheetsummarytotal>28</array_timesheetsummarytotal>
<array_timesheetsummarytuesday>0</array_timesheetsummarytuesday>
<array_timesheetsummaryunique>1/00000591.001</array_timesheetsummaryunique>
<array_timesheetsummarywednesday>0</array_timesheetsummarywednesday>
</timesheetsummarydata>

<timesheetsummarydata>
<array_timesheetsummarycompany>
Confidence Creative
</array_timesheetsummarycompany>
<array_timesheetsummarydescription>
1/00000600.001 - Adderley Wainright - Christmas Bash Video - Christmas Bash Video
</array_timesheetsummarydescription>
<array_timesheetsummaryfriday>0</array_timesheetsummaryfriday>
<array_timesheetsummarymonday>0</array_timesheetsummarymonday>
<array_timesheetsummaryorder>00011/00000600.001</array_timesheetsummaryorder>
<array_timesheetsummarysaturday>0</array_timesheetsummarysaturday>
<array_timesheetsummarysunday>0</array_timesheetsummarysunday>
<array_timesheetsummarythursday>5</array_timesheetsummarythursday>
<array_timesheetsummarytotal>5</array_timesheetsummarytotal>
<array_timesheetsummarytuesday>0</array_timesheetsummarytuesday>
<array_timesheetsummaryunique>1/00000600.001</array_timesheetsummaryunique>
<array_timesheetsummarywednesday>0</array_timesheetsummarywednesday>
</timesheetsummarydata>

<timesheetsummarydata>
<variable_timesheetsummaryfridaydate>2015-01-23</variable_timesheetsummaryfridaydate>
<variable_timesheetsummarymondaydate>
2015-01-19
</variable_timesheetsummarymondaydate>
<variable_timesheetsummarysaturdaydate>
2015-01-24
</variable_timesheetsummarysaturdaydate>
<variable_timesheetsummarysundaydate>
2015-01-25
</variable_timesheetsummarysundaydate>
<variable_timesheetsummarythursdaydate>
2015-01-22
</variable_timesheetsummarythursdaydate>
<variable_timesheetsummarytuesdaydate>
2015-01-20
</variable_timesheetsummarytuesdaydate>
<variable_timesheetsummarywednesdaydate>
2015-01-21
</variable_timesheetsummarywednesdaydate>
</timesheetsummarydata>

<timesheetsummarydata>
<variable_timesheethoursrequired>40</variable_timesheethoursrequired>
<variable_timesheetsummaryresourcechargeable>33
</variable_timesheetsummaryresourcechargeable>
<variable_timesheetsummaryresourcenonchargeable>0
</variable_timesheetsummaryresourcenonchargeable>
</timesheetsummarydata>

<timesheetsummarydata>
<variable_timesheetsummarychargeabletotal>33
</variable_timesheetsummarychargeabletotal>
<variable_timesheetsummaryfridaytotal>0</variable_timesheetsummaryfridaytotal>
<variable_timesheetsummarymondaytotal>0</variable_timesheetsummarymondaytotal>
<variable_timesheetsummarynonchargeabletotal>0
</variable_timesheetsummarynonchargeabletotal>
<variable_timesheetsummarysaturdaytotal>0</variable_timesheetsummarysaturdaytotal>
<variable_timesheetsummarysundaytotal>0</variable_timesheetsummarysundaytotal>
<variable_timesheetsummarythursdaytotal>33</variable_timesheetsummarythursdaytotal>
<variable_timesheetsummarytuesdaytotal>0</variable_timesheetsummarytuesdaytotal>
<variable_timesheetsummarywednesdaytotal>0</variable_timesheetsummarywednesdaytotal>
</timesheetsummarydata>

</timesheetsummary>

"array_timesheetsummaryorder": "00011/00000591.001",
            "array_timesheetsummarysaturday": 0,
            "array_timesheetsummarysunday": 0,
            "array_timesheetsummarythursday": 28,
            "array_timesheetsummarytotal": 28,
            "array_timesheetsummarytuesday": 0,
            "array_timesheetsummaryunique": "1/00000591.001",
            "array_timesheetsummarywednesday": 0
        },
        {
            "array_timesheetsummarycompany": "Confidence Creative",
            "array_timesheetsummarydescription": "1/00000600.001 - Adderley Wainright - Christmas Bash Video - Christmas Bash Video",
            "array_timesheetsummaryfriday": 0,
            "array_timesheetsummarymonday": 0,
            "array_timesheetsummaryorder": "00011/00000600.001",
            "array_timesheetsummarysaturday": 0,
            "array_timesheetsummarysunday": 0,
            "array_timesheetsummarythursday": 5,
            "array_timesheetsummarytotal": 5,
            "array_timesheetsummarytuesday": 0,
            "array_timesheetsummaryunique": "1/00000600.001",
            "array_timesheetsummarywednesday": 0
        }
    ],
    "dates": [
        {
            "variable_timesheetsummaryfridaydate": "2015-01-23",
            "variable_timesheetsummarymondaydate": "2015-01-19",
            "variable_timesheetsummarysaturdaydate": "2015-01-24",
            "variable_timesheetsummarysundaydate": "2015-01-25",
            "variable_timesheetsummarythursdaydate": "2015-01-22",
            "variable_timesheetsummarytuesdaydate": "2015-01-20",
            "variable_timesheetsummarywednesdaydate": "2015-01-21"
        }
    ],
    "resource": [
        {
            "variable_timesheethoursrequired": 40,
            "variable_timesheetsummaryresourcechargeable": 33,
            "variable_timesheetsummaryresourcenonchargeable": 0
        }
    ],
    "totals": [
        {
            "variable_timesheetsummarychargeabletotal": 33,
            "variable_timesheetsummaryfridaytotal": 0,
            "variable_timesheetsummarymondaytotal": 0,
            "variable_timesheetsummarynonchargeabletotal": 0,
            "variable_timesheetsummarysaturdaytotal": 0,
            "variable_timesheetsummarysundaytotal": 0,
            "variable_timesheetsummarythursdaytotal": 33,
            "variable_timesheetsummarytuesdaytotal": 0,
            "variable_timesheetsummarywednesdaytotal": 0
        }
    ]
}