GET api/MonthlySummaries?users={users}&logon={logon}&logoff={logoff}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
users

string

None.

logon

string

None.

logoff

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ReportSummaryDto
NameDescriptionTypeAdditional information
YearlySummary

ReportYearlySummaryDto

None.

WorkModel

ReportWorkModelDto

None.

Month

integer

None.

Year

integer

None.

EstimatedWorkdaysPerMonth

decimal number

None.

EstimatedWorktimePerMonth

decimal number

None.

EstimatedPaidtimePerMonth

decimal number

None.

EstimatedWorktimePerMonthRegular

decimal number

None.

Overtime

decimal number

None.

CalculatedOvertime

decimal number

None.

Breaktime

decimal number

None.

Drivetime

decimal number

None.

Sparetime

decimal number

None.

Worktime

decimal number

None.

TakenOvertime

decimal number

None.

Leave

decimal number

None.

PaidLeave

decimal number

None.

PaidSick

decimal number

None.

PaidBankHoliday

decimal number

None.

LeaveAsDays

decimal number

None.

SickComplete

decimal number

None.

SickCompleteAsDays

decimal number

None.

Sick

decimal number

None.

SickAsDays

decimal number

None.

SickNotPaid

decimal number

None.

SickNotPaidAsDays

decimal number

None.

TotalOvertime

decimal number

None.

Locked

boolean

None.

Date

date

None.

OvertimeCutMode

OvertimeCutMode

None.

IsPaidOvertimeCalculated

boolean

None.

PaidOvertime

decimal number

None.

DecreasePaidTime

decimal number

None.

MissingHourCompensation

decimal number

None.

RegionId

globally unique identifier

None.

CountryId

globally unique identifier

None.

MaximumOvertime

decimal number

None.

OvertimeStartsAt

decimal number

None.

ExceptionForMinusWorkingTimeAccount

boolean

None.

WorkContract

WorkContract

None.

PaidTime

decimal number

None.

IsPaidTimeCalculated

boolean

None.

MaxPaidTime

decimal number

None.

UnpaidTime

decimal number

None.

WagePayment

WagePayment

None.

LowerOvertimeLimit

decimal number

None.

BankHoliday

decimal number

None.

BankHolidayAsDays

decimal number

None.

CountryName

string

None.

RegionName

string

None.

PreviousMonthOvertime

decimal number

None.

SpecialLeave

decimal number

None.

SpecialLeaveAsDays

decimal number

None.

ShortTimeWork

decimal number

None.

SurchargedOvertime

decimal number

None.

SurchargedCompleteOvertime

decimal number

None.

WorktimeOffset

decimal number

None.

TotalTime

decimal number

None.

EstimatedTotalTimePerMonth

decimal number

None.

NightSurchargeCoreTime

decimal number

None.

NightSurchargeTime

decimal number

None.

NightSurchargeTimeComplete

decimal number

None.

SaturdayWorkTime

decimal number

None.

SundayWorkTime

decimal number

None.

PublicHolidayWorkTime

decimal number

None.

SaturdayWorkTimeAm

decimal number

None.

SaturdayWorkTimePm

decimal number

None.

CutTime

decimal number

None.

RemoteWork

decimal number

None.

RemoteWorkAsDays

decimal number

None.

EveningSurchargeTime

decimal number

None.

MorningSurchargeTime

decimal number

None.

PreviousRemainingLeave

decimal number

None.

PreviousRemainingLeaveAsDays

decimal number

None.

PreviousAggregatedSick

decimal number

None.

PreviousAggregatedSickAsDays

decimal number

None.

PreviousAggregatedSickNotPaid

decimal number

None.

PreviousAggregatedSickNotPaidAsDays

decimal number

None.

CreatedBy

globally unique identifier

None.

Created

date

None.

LastUpdateBy

globally unique identifier

None.

LastUpdate

date

None.

CreatedByUser

string

None.

LastUpdateByUser

string

None.

Id

globally unique identifier

None.

IsNew

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  null,
  {
    "$id": "1",
    "YearlySummary": null,
    "WorkModel": null,
    "Month": 1,
    "Year": 2,
    "EstimatedWorkdaysPerMonth": 3.1,
    "EstimatedWorktimePerMonth": 4.1,
    "EstimatedPaidtimePerMonth": 5.1,
    "Overtime": 7.1,
    "CalculatedOvertime": 8.1,
    "Breaktime": 9.1,
    "Drivetime": 10.1,
    "Sparetime": 11.1,
    "Worktime": 12.1,
    "TakenOvertime": 13.1,
    "Leave": 14.1,
    "PaidLeave": 15.1,
    "LeaveAsDays": 18.1,
    "SickComplete": 19.1,
    "SickCompleteAsDays": 20.1,
    "Sick": 21.1,
    "SickAsDays": 22.1,
    "SickNotPaid": 23.1,
    "SickNotPaidAsDays": 24.1,
    "TotalOvertime": 25.1,
    "Locked": true,
    "Date": "2025-04-27T23:04:18.8134971+02:00",
    "OvertimeCutMode": 0,
    "IsPaidOvertimeCalculated": true,
    "PaidOvertime": 29.1,
    "DecreasePaidTime": 30.1,
    "MissingHourCompensation": 31.1,
    "RegionId": "4bbfd57b-6420-4f9d-bf84-6ce1d647d34b",
    "CountryId": "2b9ded3b-5406-4404-b5d7-d83fcfd51727",
    "MaximumOvertime": 34.1,
    "OvertimeStartsAt": 35.1,
    "WorkContract": 0,
    "PaidTime": 1.1,
    "IsPaidTimeCalculated": true,
    "MaxPaidTime": 1.1,
    "UnpaidTime": 38.1,
    "BankHoliday": 40.1,
    "BankHolidayAsDays": 41.1,
    "CountryName": "sample string 42",
    "RegionName": "sample string 43",
    "PreviousMonthOvertime": 44.1,
    "SpecialLeave": 45.1,
    "SpecialLeaveAsDays": 46.1,
    "CreatedBy": "ecde1bb6-9077-44d6-b522-a2ee3d1d12db",
    "Created": "2025-04-27T23:04:18.8134971+02:00",
    "LastUpdateBy": "eef17919-a2d5-4844-b941-84c63f349343",
    "LastUpdate": "2025-04-27T23:04:18.8134971+02:00",
    "CreatedByUser": "sample string 75",
    "LastUpdateByUser": "sample string 76",
    "Id": "22c40daf-66b8-4228-9483-4c4c42ee7b7f",
    "IsNew": true,
    "PaidSick": 16.1,
    "PaidBankHoliday": 17.1,
    "WagePayment": 0,
    "LowerOvertimeLimit": 39.1,
    "EstimatedWorktimePerMonthRegular": 6.1,
    "ShortTimeWork": 47.1,
    "SurchargedOvertime": 48.1,
    "SurchargedCompleteOvertime": 49.1,
    "WorktimeOffset": 50.1,
    "ExceptionForMinusWorkingTimeAccount": true,
    "TotalTime": 51.1,
    "EstimatedTotalTimePerMonth": 52.1,
    "NightSurchargeCoreTime": 53.1,
    "NightSurchargeTime": 54.1,
    "NightSurchargeTimeComplete": 55.1,
    "SaturdayWorkTime": 56.1,
    "SundayWorkTime": 57.1,
    "PublicHolidayWorkTime": 58.1,
    "SaturdayWorkTimeAm": 59.1,
    "SaturdayWorkTimePm": 60.1,
    "CutTime": 61.1,
    "RemoteWork": 62.1,
    "RemoteWorkAsDays": 63.1,
    "EveningSurchargeTime": 64.1,
    "MorningSurchargeTime": 65.1,
    "PreviousRemainingLeave": 1.1,
    "PreviousRemainingLeaveAsDays": 66.1,
    "PreviousAggregatedSick": 67.1,
    "PreviousAggregatedSickAsDays": 68.1,
    "PreviousAggregatedSickNotPaid": 69.1,
    "PreviousAggregatedSickNotPaidAsDays": 70.1
  }
]

text/html

Sample:
[null,{"$id":"1","YearlySummary":null,"WorkModel":null,"Month":1,"Year":2,"EstimatedWorkdaysPerMonth":3.1,"EstimatedWorktimePerMonth":4.1,"EstimatedPaidtimePerMonth":5.1,"Overtime":7.1,"CalculatedOvertime":8.1,"Breaktime":9.1,"Drivetime":10.1,"Sparetime":11.1,"Worktime":12.1,"TakenOvertime":13.1,"Leave":14.1,"PaidLeave":15.1,"LeaveAsDays":18.1,"SickComplete":19.1,"SickCompleteAsDays":20.1,"Sick":21.1,"SickAsDays":22.1,"SickNotPaid":23.1,"SickNotPaidAsDays":24.1,"TotalOvertime":25.1,"Locked":true,"Date":"2025-04-27T23:04:18.8134971+02:00","OvertimeCutMode":0,"IsPaidOvertimeCalculated":true,"PaidOvertime":29.1,"DecreasePaidTime":30.1,"MissingHourCompensation":31.1,"RegionId":"4bbfd57b-6420-4f9d-bf84-6ce1d647d34b","CountryId":"2b9ded3b-5406-4404-b5d7-d83fcfd51727","MaximumOvertime":34.1,"OvertimeStartsAt":35.1,"WorkContract":0,"PaidTime":1.1,"IsPaidTimeCalculated":true,"MaxPaidTime":1.1,"UnpaidTime":38.1,"BankHoliday":40.1,"BankHolidayAsDays":41.1,"CountryName":"sample string 42","RegionName":"sample string 43","PreviousMonthOvertime":44.1,"SpecialLeave":45.1,"SpecialLeaveAsDays":46.1,"CreatedBy":"ecde1bb6-9077-44d6-b522-a2ee3d1d12db","Created":"2025-04-27T23:04:18.8134971+02:00","LastUpdateBy":"eef17919-a2d5-4844-b941-84c63f349343","LastUpdate":"2025-04-27T23:04:18.8134971+02:00","CreatedByUser":"sample string 75","LastUpdateByUser":"sample string 76","Id":"22c40daf-66b8-4228-9483-4c4c42ee7b7f","IsNew":true,"PaidSick":16.1,"PaidBankHoliday":17.1,"WagePayment":0,"LowerOvertimeLimit":39.1,"EstimatedWorktimePerMonthRegular":6.1,"ShortTimeWork":47.1,"SurchargedOvertime":48.1,"SurchargedCompleteOvertime":49.1,"WorktimeOffset":50.1,"ExceptionForMinusWorkingTimeAccount":true,"TotalTime":51.1,"EstimatedTotalTimePerMonth":52.1,"NightSurchargeCoreTime":53.1,"NightSurchargeTime":54.1,"NightSurchargeTimeComplete":55.1,"SaturdayWorkTime":56.1,"SundayWorkTime":57.1,"PublicHolidayWorkTime":58.1,"SaturdayWorkTimeAm":59.1,"SaturdayWorkTimePm":60.1,"CutTime":61.1,"RemoteWork":62.1,"RemoteWorkAsDays":63.1,"EveningSurchargeTime":64.1,"MorningSurchargeTime":65.1,"PreviousRemainingLeave":1.1,"PreviousRemainingLeaveAsDays":66.1,"PreviousAggregatedSick":67.1,"PreviousAggregatedSickAsDays":68.1,"PreviousAggregatedSickNotPaid":69.1,"PreviousAggregatedSickNotPaidAsDays":70.1}]

application/xml, text/xml

Sample:
<ArrayOfReportSummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TimePunch.Core.Services.ReportingService.Dto">
  <ReportSummaryDto i:nil="true" />
  <ReportSummaryDto z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <Id>22c40daf-66b8-4228-9483-4c4c42ee7b7f</Id>
    <IsNew>true</IsNew>
    <Created>2025-04-27T23:04:18.8134971+02:00</Created>
    <CreatedBy>ecde1bb6-9077-44d6-b522-a2ee3d1d12db</CreatedBy>
    <CreatedByUser>sample string 75</CreatedByUser>
    <LastUpdate>2025-04-27T23:04:18.8134971+02:00</LastUpdate>
    <LastUpdateBy>eef17919-a2d5-4844-b941-84c63f349343</LastUpdateBy>
    <LastUpdateByUser>sample string 76</LastUpdateByUser>
    <BankHoliday>40.1</BankHoliday>
    <BankHolidayAsDays>41.1</BankHolidayAsDays>
    <Breaktime>9.1</Breaktime>
    <CalculatedOvertime>8.1</CalculatedOvertime>
    <CountryId>2b9ded3b-5406-4404-b5d7-d83fcfd51727</CountryId>
    <CountryName>sample string 42</CountryName>
    <Date>2025-04-27T23:04:18.8134971+02:00</Date>
    <DecreasePaidTime>30.1</DecreasePaidTime>
    <Drivetime>10.1</Drivetime>
    <EstimatedPaidtimePerMonth>5.1</EstimatedPaidtimePerMonth>
    <EstimatedWorkdaysPerMonth>3.1</EstimatedWorkdaysPerMonth>
    <EstimatedWorktimePerMonth>4.1</EstimatedWorktimePerMonth>
    <IsPaidOvertimeCalculated>true</IsPaidOvertimeCalculated>
    <IsPaidTimeCalculated>true</IsPaidTimeCalculated>
    <Leave>14.1</Leave>
    <LeaveAsDays>18.1</LeaveAsDays>
    <Locked>true</Locked>
    <MaxPaidTime>1.1</MaxPaidTime>
    <MaximumOvertime>34.1</MaximumOvertime>
    <MissingHourCompensation>31.1</MissingHourCompensation>
    <Month>1</Month>
    <Overtime>7.1</Overtime>
    <OvertimeCutMode>Monthly</OvertimeCutMode>
    <OvertimeStartsAt>35.1</OvertimeStartsAt>
    <PaidLeave>15.1</PaidLeave>
    <PaidOvertime>29.1</PaidOvertime>
    <PaidTime>1.1</PaidTime>
    <PreviousMonthOvertime>44.1</PreviousMonthOvertime>
    <RegionId>4bbfd57b-6420-4f9d-bf84-6ce1d647d34b</RegionId>
    <RegionName>sample string 43</RegionName>
    <Sick>21.1</Sick>
    <SickAsDays>22.1</SickAsDays>
    <SickComplete>19.1</SickComplete>
    <SickCompleteAsDays>20.1</SickCompleteAsDays>
    <SickNotPaid>23.1</SickNotPaid>
    <SickNotPaidAsDays>24.1</SickNotPaidAsDays>
    <Sparetime>11.1</Sparetime>
    <SpecialLeave>45.1</SpecialLeave>
    <SpecialLeaveAsDays>46.1</SpecialLeaveAsDays>
    <TakenOvertime>13.1</TakenOvertime>
    <TotalOvertime>25.1</TotalOvertime>
    <UnpaidTime>38.1</UnpaidTime>
    <WorkContract>Employee</WorkContract>
    <WorkModel i:nil="true" />
    <Worktime>12.1</Worktime>
    <Year>2</Year>
    <YearlySummary i:nil="true" />
    <PaidBankHoliday>17.1</PaidBankHoliday>
    <PaidSick>16.1</PaidSick>
    <WagePayment>BasedOnWorkingTimeModel</WagePayment>
    <LowerOvertimeLimit>39.1</LowerOvertimeLimit>
    <EstimatedWorktimePerMonthRegular>6.1</EstimatedWorktimePerMonthRegular>
    <ShortTimeWork>47.1</ShortTimeWork>
    <SurchargedCompleteOvertime>49.1</SurchargedCompleteOvertime>
    <SurchargedOvertime>48.1</SurchargedOvertime>
    <WorktimeOffset>50.1</WorktimeOffset>
    <ExceptionForMinusWorkingTimeAccount>true</ExceptionForMinusWorkingTimeAccount>
    <CutTime>61.1</CutTime>
    <EstimatedTotalTimePerMonth>52.1</EstimatedTotalTimePerMonth>
    <NightSurchargeCoreTime>53.1</NightSurchargeCoreTime>
    <NightSurchargeTime>54.1</NightSurchargeTime>
    <NightSurchargeTimeComplete>55.1</NightSurchargeTimeComplete>
    <PublicHolidayWorkTime>58.1</PublicHolidayWorkTime>
    <SaturdayWorkTime>56.1</SaturdayWorkTime>
    <SaturdayWorkTimeAm>59.1</SaturdayWorkTimeAm>
    <SaturdayWorkTimePm>60.1</SaturdayWorkTimePm>
    <SundayWorkTime>57.1</SundayWorkTime>
    <TotalTime>51.1</TotalTime>
    <EveningSurchargeTime>64.1</EveningSurchargeTime>
    <MorningSurchargeTime>65.1</MorningSurchargeTime>
    <RemoteWork>62.1</RemoteWork>
    <RemoteWorkAsDays>63.1</RemoteWorkAsDays>
    <PreviousAggregatedSick>67.1</PreviousAggregatedSick>
    <PreviousAggregatedSickAsDays>68.1</PreviousAggregatedSickAsDays>
    <PreviousAggregatedSickNotPaid>69.1</PreviousAggregatedSickNotPaid>
    <PreviousAggregatedSickNotPaidAsDays>70.1</PreviousAggregatedSickNotPaidAsDays>
    <PreviousRemainingLeave>1.1</PreviousRemainingLeave>
    <PreviousRemainingLeaveAsDays>66.1</PreviousRemainingLeaveAsDays>
  </ReportSummaryDto>
</ArrayOfReportSummaryDto>