GET api/v1/portal/{portalUid}/timesheet/status
Returns a list of timesheet statuses that have been configured for this portal
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
the uid of the portal to query |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
a list of timesheet statuses for this portal
Collection of TimesheetStatusViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name. |
string |
None. |
| IsDefault |
true if this instance is default; otherwise, false. |
boolean |
None. |
| IsUpdatable |
true if this instance is updatable; otherwise, false. |
boolean |
None. |
| IsApproved |
Set to true if this status means the timesheet is approved |
boolean |
None. |
| IsAuthorised |
Set to true if this status means the timesheet is authorised |
boolean |
None. |
| IsInvoiced |
Set to true if this status means the timesheet is invoiced |
boolean |
None. |
| IsModified |
Set to true if this status means the timesheet is modified |
boolean |
None. |
| IsPending |
Set to true if this status means the timesheet is pending |
boolean |
None. |
| IsRejected |
Set to true if this status means the timesheet is rejected |
boolean |
None. |
| IsSubmitted |
Set to true if this status means the timesheet is submitted |
boolean |
None. |
| IsPaid |
Set to true if the timesheet has been paid |
boolean |
None. |
| CandidateAlias |
An alias to show to the candidate instead of the name |
string |
None. |
| ClientContactAlias |
An alias to show to the client contact rather than the name |
string |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"IsDefault": true,
"IsUpdatable": true,
"IsApproved": true,
"IsAuthorised": true,
"IsInvoiced": true,
"IsModified": true,
"IsPending": true,
"IsRejected": true,
"IsSubmitted": true,
"IsPaid": true,
"CandidateAlias": "sample string 12",
"ClientContactAlias": "sample string 13",
"Uid": "4c886edf-171d-4996-8ba6-08a2d6e4e1a6",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:59:45.6253914+00:00",
"UpdatedBy": "sample string 15"
},
{
"Name": "sample string 1",
"IsDefault": true,
"IsUpdatable": true,
"IsApproved": true,
"IsAuthorised": true,
"IsInvoiced": true,
"IsModified": true,
"IsPending": true,
"IsRejected": true,
"IsSubmitted": true,
"IsPaid": true,
"CandidateAlias": "sample string 12",
"ClientContactAlias": "sample string 13",
"Uid": "4c886edf-171d-4996-8ba6-08a2d6e4e1a6",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:59:45.6253914+00:00",
"UpdatedBy": "sample string 15"
}
]
application/xml, text/xml
Sample:
<ArrayOfTimesheetStatusViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<TimesheetStatusViewModel>
<DateUpdated>2025-10-27T13:59:45.6253914+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>4c886edf-171d-4996-8ba6-08a2d6e4e1a6</Uid>
<UpdatedBy>sample string 15</UpdatedBy>
<CandidateAlias>sample string 12</CandidateAlias>
<ClientContactAlias>sample string 13</ClientContactAlias>
<IsApproved>true</IsApproved>
<IsAuthorised>true</IsAuthorised>
<IsDefault>true</IsDefault>
<IsInvoiced>true</IsInvoiced>
<IsModified>true</IsModified>
<IsPaid>true</IsPaid>
<IsPending>true</IsPending>
<IsRejected>true</IsRejected>
<IsSubmitted>true</IsSubmitted>
<IsUpdatable>true</IsUpdatable>
<Name>sample string 1</Name>
</TimesheetStatusViewModel>
<TimesheetStatusViewModel>
<DateUpdated>2025-10-27T13:59:45.6253914+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>4c886edf-171d-4996-8ba6-08a2d6e4e1a6</Uid>
<UpdatedBy>sample string 15</UpdatedBy>
<CandidateAlias>sample string 12</CandidateAlias>
<ClientContactAlias>sample string 13</ClientContactAlias>
<IsApproved>true</IsApproved>
<IsAuthorised>true</IsAuthorised>
<IsDefault>true</IsDefault>
<IsInvoiced>true</IsInvoiced>
<IsModified>true</IsModified>
<IsPaid>true</IsPaid>
<IsPending>true</IsPending>
<IsRejected>true</IsRejected>
<IsSubmitted>true</IsSubmitted>
<IsUpdatable>true</IsUpdatable>
<Name>sample string 1</Name>
</TimesheetStatusViewModel>
</ArrayOfTimesheetStatusViewModel>