GET api/clients/alltimesheets?year={year}&month={month}&clientId={clientId}

get client timesheets

Request Information

URI Parameters

NameDescriptionTypeAdditional information
year

integer

None.

month

integer

None.

clientId

string

None.

Body Parameters

None.

Response Information

Resource Description

ClientTimesheetDTO
NameDescriptionTypeAdditional information
CandidatesCount

integer

None.

SignOffDate

date

None.

SignedOffCount

integer

None.

TimesheetItems

Collection of TimesheetItemModelDTO

None.

TimesheetItemsCount

integer

None.

FullDaysCount

integer

None.

HalfDaysCount

integer

None.

AllCandidatesReviewed

boolean

None.

WeekStart

date

None.

TimesheetStatus

string

None.

Status

integer

None.

SignedOff

boolean

None.

WorkedDays

decimal number

None.

OvertimeHours

decimal number

None.

CurrencySymbol

string

None.

TotalAmount

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "CandidatesCount": 1,
  "SignOffDate": "2025-05-06T14:25:46.5715052Z",
  "SignedOffCount": 2,
  "TimesheetItems": [
    {
      "PlacedCandidateId": "sample string 1",
      "PlacedCandidate": "sample string 2",
      "PlacedCandidatePhotoImageUrl": "sample string 3",
      "VacancyDays": [
        {
          "ClientName": "sample string 1",
          "JobRole": "sample string 2",
          "JobTags": [
            "sample string 1",
            "sample string 2"
          ],
          "DailyRate": 3.0,
          "Id": "sample string 4",
          "VacancyUid": "sample string 5",
          "Date": "2025-05-06T14:25:46.5715052Z",
          "BookingTimeType": 0,
          "StartTime": "00:00:00.1234567",
          "DayStatus": 0,
          "ExtraHours": 12.0,
          "ExtraHoursRate": 13.0,
          "CurrencySymbol": "£",
          "InvoiceReference": "sample string 14",
          "InvoiceDayRate": 1.0,
          "InvoiceHalfDayRate": 1.0,
          "PayDayRate": 1.0,
          "PayHalfDayRate": 1.0,
          "OriginalPayRate": 1.0,
          "CustomInvoiceRateReason": "sample string 15",
          "CustomInvoiceRateSetBy": "sample string 16",
          "StandardRateCardId": 1,
          "CustomRateCardId": 1,
          "SelectedRateCard": "sample string 17",
          "RatePattern": 0,
          "WeekDayPattern": [
            1,
            2
          ],
          "DeleteReasonId": 1,
          "InvoiceCredit": 1.0
        },
        {
          "ClientName": "sample string 1",
          "JobRole": "sample string 2",
          "JobTags": [
            "sample string 1",
            "sample string 2"
          ],
          "DailyRate": 3.0,
          "Id": "sample string 4",
          "VacancyUid": "sample string 5",
          "Date": "2025-05-06T14:25:46.5715052Z",
          "BookingTimeType": 0,
          "StartTime": "00:00:00.1234567",
          "DayStatus": 0,
          "ExtraHours": 12.0,
          "ExtraHoursRate": 13.0,
          "CurrencySymbol": "£",
          "InvoiceReference": "sample string 14",
          "InvoiceDayRate": 1.0,
          "InvoiceHalfDayRate": 1.0,
          "PayDayRate": 1.0,
          "PayHalfDayRate": 1.0,
          "OriginalPayRate": 1.0,
          "CustomInvoiceRateReason": "sample string 15",
          "CustomInvoiceRateSetBy": "sample string 16",
          "StandardRateCardId": 1,
          "CustomRateCardId": 1,
          "SelectedRateCard": "sample string 17",
          "RatePattern": 0,
          "WeekDayPattern": [
            1,
            2
          ],
          "DeleteReasonId": 1,
          "InvoiceCredit": 1.0
        }
      ],
      "Status": 4,
      "SignedOff": true,
      "TotalAmount": 6.0,
      "HoursWorked": 7.0,
      "CurrencySymbol": "£",
      "JobRole": "sample string 8",
      "JobRoleId": "sample string 9",
      "Site": "sample string 10",
      "SiteId": "sample string 11",
      "JobTags": [
        "sample string 1",
        "sample string 2"
      ],
      "SignedOffBy": "sample string 12",
      "SignOffDate": "2025-05-06T14:25:46.5715052Z",
      "CandidateReviewed": true,
      "Ticket": {
        "Id": 1,
        "Type": 2,
        "ClientId": "sample string 3",
        "ClientSiteId": "sample string 4",
        "CandidateId": "sample string 5",
        "RoleId": "sample string 6",
        "UserId": "sample string 7",
        "IssueDate": "2025-05-06T14:25:46.5715052Z",
        "CreatedDate": "2025-05-06T14:25:46.5715052Z",
        "ResolvedDate": "2025-05-06T14:25:46.5715052Z",
        "Status": 10,
        "Notes": "sample string 11"
      }
    },
    {
      "PlacedCandidateId": "sample string 1",
      "PlacedCandidate": "sample string 2",
      "PlacedCandidatePhotoImageUrl": "sample string 3",
      "VacancyDays": [
        {
          "ClientName": "sample string 1",
          "JobRole": "sample string 2",
          "JobTags": [
            "sample string 1",
            "sample string 2"
          ],
          "DailyRate": 3.0,
          "Id": "sample string 4",
          "VacancyUid": "sample string 5",
          "Date": "2025-05-06T14:25:46.5715052Z",
          "BookingTimeType": 0,
          "StartTime": "00:00:00.1234567",
          "DayStatus": 0,
          "ExtraHours": 12.0,
          "ExtraHoursRate": 13.0,
          "CurrencySymbol": "£",
          "InvoiceReference": "sample string 14",
          "InvoiceDayRate": 1.0,
          "InvoiceHalfDayRate": 1.0,
          "PayDayRate": 1.0,
          "PayHalfDayRate": 1.0,
          "OriginalPayRate": 1.0,
          "CustomInvoiceRateReason": "sample string 15",
          "CustomInvoiceRateSetBy": "sample string 16",
          "StandardRateCardId": 1,
          "CustomRateCardId": 1,
          "SelectedRateCard": "sample string 17",
          "RatePattern": 0,
          "WeekDayPattern": [
            1,
            2
          ],
          "DeleteReasonId": 1,
          "InvoiceCredit": 1.0
        },
        {
          "ClientName": "sample string 1",
          "JobRole": "sample string 2",
          "JobTags": [
            "sample string 1",
            "sample string 2"
          ],
          "DailyRate": 3.0,
          "Id": "sample string 4",
          "VacancyUid": "sample string 5",
          "Date": "2025-05-06T14:25:46.5715052Z",
          "BookingTimeType": 0,
          "StartTime": "00:00:00.1234567",
          "DayStatus": 0,
          "ExtraHours": 12.0,
          "ExtraHoursRate": 13.0,
          "CurrencySymbol": "£",
          "InvoiceReference": "sample string 14",
          "InvoiceDayRate": 1.0,
          "InvoiceHalfDayRate": 1.0,
          "PayDayRate": 1.0,
          "PayHalfDayRate": 1.0,
          "OriginalPayRate": 1.0,
          "CustomInvoiceRateReason": "sample string 15",
          "CustomInvoiceRateSetBy": "sample string 16",
          "StandardRateCardId": 1,
          "CustomRateCardId": 1,
          "SelectedRateCard": "sample string 17",
          "RatePattern": 0,
          "WeekDayPattern": [
            1,
            2
          ],
          "DeleteReasonId": 1,
          "InvoiceCredit": 1.0
        }
      ],
      "Status": 4,
      "SignedOff": true,
      "TotalAmount": 6.0,
      "HoursWorked": 7.0,
      "CurrencySymbol": "£",
      "JobRole": "sample string 8",
      "JobRoleId": "sample string 9",
      "Site": "sample string 10",
      "SiteId": "sample string 11",
      "JobTags": [
        "sample string 1",
        "sample string 2"
      ],
      "SignedOffBy": "sample string 12",
      "SignOffDate": "2025-05-06T14:25:46.5715052Z",
      "CandidateReviewed": true,
      "Ticket": {
        "Id": 1,
        "Type": 2,
        "ClientId": "sample string 3",
        "ClientSiteId": "sample string 4",
        "CandidateId": "sample string 5",
        "RoleId": "sample string 6",
        "UserId": "sample string 7",
        "IssueDate": "2025-05-06T14:25:46.5715052Z",
        "CreatedDate": "2025-05-06T14:25:46.5715052Z",
        "ResolvedDate": "2025-05-06T14:25:46.5715052Z",
        "Status": 10,
        "Notes": "sample string 11"
      }
    }
  ],
  "TimesheetItemsCount": 3,
  "FullDaysCount": 4,
  "HalfDaysCount": 5,
  "AllCandidatesReviewed": true,
  "WeekStart": "2025-05-06T14:25:46.5715052Z",
  "TimesheetStatus": "sample string 8",
  "Status": 9,
  "SignedOff": true,
  "WorkedDays": 11.0,
  "OvertimeHours": 12.0,
  "CurrencySymbol": "£",
  "TotalAmount": 13.0
}