List Companies
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListCompaniesRequest req = new HrisListCompaniesRequest ( ) {
XAccountId = "<id>" ,
Fields = "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields" ,
Filter = new HrisListCompaniesFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListCompaniesResponse ? res = await sdk . Hris . GetCompaniesAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListCompaniesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Company
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetCompanyRequest req = new HrisGetCompanyRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetCompanyAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetCompanyRequest
✔️
The request object to use for the request.
HrisGetCompanyResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
GetEmployeeCustomFieldDefinition
Get employee Custom Field Definition
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeCustomFieldDefinitionRequest req = new HrisGetEmployeeCustomFieldDefinitionRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,description,type,options,unified_custom_fields" ,
Filter = new HrisGetEmployeeCustomFieldDefinitionFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeCustomFieldDefinitionAsync ( req ) ;
// handle response
HrisGetEmployeeCustomFieldDefinitionResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Employee
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeRequest req = new HrisGetEmployeeRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields" ,
Expand = "company,employments,work_location,home_location,groups,skills" ,
Include = "avatar_url,avatar,custom_fields,job_description,benefits,bank_details" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetEmployeeRequest
✔️
The request object to use for the request.
HrisGetEmployeeResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Employee Shifts
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListEmployeeShiftsRequest req = new HrisListEmployeeShiftsRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Filter = new HrisListEmployeeShiftsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
StartsAfter = "2024-01-15T09:00" ,
EndsBefore = "2024-01-15T17:00" ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListEmployeeShiftsResponse ? res = await sdk . Hris . ListEmployeeShiftsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListEmployeeShiftsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Employee Shift
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeShiftRequest req = new HrisGetEmployeeShiftRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeShiftAsync ( req ) ;
// handle response
HrisGetEmployeeShiftResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
ListEmployeeTimeOffRequests
List Employee Time Off Requests
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListEmployeeTimeOffRequestsRequest req = new HrisListEmployeeTimeOffRequestsRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields" ,
Filter = new HrisListEmployeeTimeOffRequestsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
StartDate = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
EndDate = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Expand = "policy" ,
Prefer = "heartbeat" ,
} ;
HrisListEmployeeTimeOffRequestsResponse ? res = await sdk . Hris . ListEmployeeTimeOffRequestsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListEmployeeTimeOffRequestsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
GetEmployeeTimeOffRequest
Get Employees Time Off Request
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeesTimeOffRequestRequest req = new HrisGetEmployeesTimeOffRequestRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields" ,
Expand = "policy" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeTimeOffRequestAsync ( req ) ;
// handle response
HrisGetEmployeesTimeOffRequestResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
UpdateEmployeeTimeOffRequest
Update Employee Time Off Request
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System . Collections . Generic ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisUpdateEmployeeTimeOffRequestRequest req = new HrisUpdateEmployeeTimeOffRequestRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Prefer = "heartbeat" ,
HrisCreateTimeOffRequestDto = new HrisCreateTimeOffRequestDto ( ) {
ApproverId = "1687-4" ,
StartDate = "2021-01-01T01:01:01.000" ,
EndDate = "2021-01-01T01:01:01.000" ,
StartHalfDay = HrisCreateTimeOffRequestDtoStartHalfDayUnion . CreateBoolean (
true
) ,
EndHalfDay = HrisCreateTimeOffRequestDtoEndHalfDayUnion . CreateBoolean (
true
) ,
TimeOffPolicyId = "cx280928933" ,
Reason = new HrisCreateTimeOffRequestDtoReason ( ) {
Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3" ,
RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3" ,
} ,
Comment = "Taking a day off for personal reasons" ,
Passthrough = new Dictionary < string , object > ( ) {
{ "other_known_names" , "John Doe" } ,
} ,
} ,
} ;
var res = await sdk . Hris . UpdateEmployeeTimeOffRequestAsync ( req ) ;
// handle response
HrisUpdateEmployeeTimeOffRequestResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Cancel Employee Time Off Request
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
var res = await sdk . Hris . CancelEmployeeTimeOffAsync (
xAccountId : "<id>" ,
id : "<id>" ,
subResourceId : "<id>" ,
prefer : "heartbeat"
) ;
// handle response
Parameter
Type
Required
Description
Example
XAccountId
string
✔️
The account identifier
Id
string
✔️
N/A
SubResourceId
string
✔️
N/A
Prefer
string
➖
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
heartbeat
HrisCancelEmployeeTimeOffRequestResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Upload Employee Document
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
var res = await sdk . Hris . UploadEmployeeDocumentAsync (
xAccountId : "<id>" ,
id : "<id>" ,
hrisDocumentsUploadRequestDto : new HrisDocumentsUploadRequestDto ( ) {
Name = "weather-forecast" ,
FileFormat = new HrisDocumentsUploadRequestDtoFileFormat ( ) {
Value = HrisDocumentsUploadRequestDtoFileFormatValue . Pdf ,
SourceValue = HrisDocumentsUploadRequestDtoFileFormatSourceValueUnion . CreateStr (
"application/pdf"
) ,
} ,
Content = "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE" ,
CategoryId = "6530" ,
Path = "/path/to/file" ,
Confidential = new HrisDocumentsUploadRequestDtoConfidential ( ) {
Value = HrisDocumentsUploadRequestDtoConfidentialValue . True ,
SourceValue = HrisDocumentsUploadRequestDtoConfidentialSourceValueUnion . CreateStr (
"public"
) ,
} ,
Category = new HrisDocumentsUploadRequestDtoCategory ( ) { } ,
} ,
prefer : "heartbeat"
) ;
// handle response
Parameter
Type
Required
Description
Example
XAccountId
string
✔️
The account identifier
Id
string
✔️
N/A
HrisDocumentsUploadRequestDto
HrisDocumentsUploadRequestDto
✔️
N/A
Prefer
string
➖
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
heartbeat
HrisUploadEmployeeDocumentResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Employee Documents
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListEmployeeDocumentsRequest req = new HrisListEmployeeDocumentsRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields" ,
Filter = new HrisListEmployeeDocumentsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListEmployeeDocumentsResponse ? res = await sdk . Hris . ListEmployeeDocumentsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListEmployeeDocumentsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Employee Document
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeDocumentRequest req = new HrisGetEmployeeDocumentRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Fields = "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeDocumentAsync ( req ) ;
// handle response
HrisGetEmployeeDocumentResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
ListEmployeeTimeOffBalances
List Employee Time Off Balances
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListEmployeeTimeOffBalancesRequest req = new HrisListEmployeeTimeOffBalancesRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields" ,
Filter = new HrisListEmployeeTimeOffBalancesFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Expand = "policy" ,
Prefer = "heartbeat" ,
} ;
HrisListEmployeeTimeOffBalancesResponse ? res = await sdk . Hris . ListEmployeeTimeOffBalancesAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListEmployeeTimeOffBalancesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
GetEmployeeTimeOffBalance
Get Employee Time Off Balance
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeTimeOffBalanceRequest req = new HrisGetEmployeeTimeOffBalanceRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields" ,
Expand = "policy" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeTimeOffBalanceAsync ( req ) ;
// handle response
HrisGetEmployeeTimeOffBalanceResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Employment
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmploymentRequest req = new HrisGetEmploymentRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields" ,
Expand = "groups" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmploymentAsync ( req ) ;
// handle response
HrisGetEmploymentResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Group
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetGroupRequest req = new HrisGetGroupRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetGroupAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetGroupRequest
✔️
The request object to use for the request.
HrisGetGroupResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Team Group
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetTeamGroupRequest req = new HrisGetTeamGroupRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetTeamGroupAsync ( req ) ;
// handle response
HrisGetTeamGroupResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Work Location
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetLocationRequest req = new HrisGetLocationRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetLocationAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetLocationRequest
✔️
The request object to use for the request.
HrisGetLocationResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Positions
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListPositionsRequest req = new HrisListPositionsRequest ( ) {
XAccountId = "<id>" ,
Filter = new HrisListPositionsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Status = HrisListPositionsStatus . Open ,
Prefer = "heartbeat" ,
} ;
HrisListPositionsResponse ? res = await sdk . Hris . ListPositionsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListPositionsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Position
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetPositionRequest req = new HrisGetPositionRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetPositionAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetPositionRequest
✔️
The request object to use for the request.
HrisGetPositionResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Time Entries
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListTimeEntriesRequest req = new HrisListTimeEntriesRequest ( ) {
XAccountId = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields" ,
Filter = new HrisListTimeEntriesFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
StartTime = "2020-01-01T00:00:00.000Z" ,
EndTime = "2020-01-01T00:00:00.000Z" ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListTimeEntriesResponse ? res = await sdk . Hris . ListTimeEntriesAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListTimeEntriesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Time Entry
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetTimeEntriesRequest req = new HrisGetTimeEntriesRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetTimeEntryAsync ( req ) ;
// handle response
HrisGetTimeEntriesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get time off request
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetTimeOffRequestRequest req = new HrisGetTimeOffRequestRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields" ,
Expand = "policy" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetTimeOffRequestAsync ( req ) ;
// handle response
HrisGetTimeOffRequestResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Shifts
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListShiftsRequest req = new HrisListShiftsRequest ( ) {
XAccountId = "<id>" ,
Filter = new HrisListShiftsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
StartsAfter = "2024-01-15T09:00" ,
EndsBefore = "2024-01-15T17:00" ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListShiftsResponse ? res = await sdk . Hris . ListShiftsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
Parameter
Type
Required
Description
request
HrisListShiftsRequest
✔️
The request object to use for the request.
HrisListShiftsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List time off types
⚠️ DEPRECATED : This will be removed in a future release, please migrate away from it as soon as possible.
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListTimeOffTypesRequest req = new HrisListTimeOffTypesRequest ( ) {
XAccountId = "<id>" ,
Fields = "id,remote_id,name,active,unified_custom_fields" ,
Filter = new HrisListTimeOffTypesFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListTimeOffTypesResponse ? res = await sdk . Hris . ListTimeOffTypesAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListTimeOffTypesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List Time Off Policies
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListTimeOffPoliciesRequest req = new HrisListTimeOffPoliciesRequest ( ) {
XAccountId = "<id>" ,
Fields = "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields" ,
Filter = new HrisListTimeOffPoliciesFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListTimeOffPoliciesResponse ? res = await sdk . Hris . ListTimeOffPoliciesAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListTimeOffPoliciesResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Time Off Policy
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetTimeOffPolicyRequest req = new HrisGetTimeOffPolicyRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetTimeOffPolicyAsync ( req ) ;
// handle response
HrisGetTimeOffPolicyResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
List benefits
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
using System ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisListBenefitsRequest req = new HrisListBenefitsRequest ( ) {
XAccountId = "<id>" ,
Fields = "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields" ,
Filter = new HrisListBenefitsFilter ( ) {
UpdatedAfter = System . DateTime . Parse ( "2020-01-01T00:00:00.000Z" ) ,
} ,
Prefer = "heartbeat" ,
} ;
HrisListBenefitsResponse ? res = await sdk . Hris . ListBenefitsAsync ( req ) ;
while ( res != null )
{
// handle items
res = await res . Next ! ( ) ;
}
HrisListBenefitsResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Create Employee Skill
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
var res = await sdk . Hris . CreateEmployeeSkillAsync (
xAccountId : "<id>" ,
id : "<id>" ,
entitySkillsCreateRequestDto : new EntitySkillsCreateRequestDto ( ) {
Id = "16873-IT345" ,
Name = "Information-Technology" ,
MaximumProficiency = new EntitySkillsCreateRequestDtoMaximumProficiency ( ) {
Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3" ,
RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3" ,
Name = "Expert" ,
} ,
MinimumProficiency = null ,
} ,
prefer : "heartbeat"
) ;
// handle response
Parameter
Type
Required
Description
Example
XAccountId
string
✔️
The account identifier
Id
string
✔️
N/A
EntitySkillsCreateRequestDto
EntitySkillsCreateRequestDto
✔️
N/A
Prefer
string
➖
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
heartbeat
HrisCreateEmployeeSkillResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Employee Task
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetEmployeeTaskRequest req = new HrisGetEmployeeTaskRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
SubResourceId = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields" ,
Expand = "attachments" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetEmployeeTaskAsync ( req ) ;
// handle response
HrisGetEmployeeTaskResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*
Get Task
using StackOneHQ . Client ;
using StackOneHQ . Client . Models . Components ;
using StackOneHQ . Client . Models . Requests ;
var sdk = new StackOneHQClient ( security : new Security ( ) {
Username = "" ,
Password = "" ,
} ) ;
HrisGetTaskRequest req = new HrisGetTaskRequest ( ) {
XAccountId = "<id>" ,
Id = "<id>" ,
Fields = "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields" ,
Expand = "attachments" ,
Prefer = "heartbeat" ,
} ;
var res = await sdk . Hris . GetTaskAsync ( req ) ;
// handle response
Parameter
Type
Required
Description
request
HrisGetTaskRequest
✔️
The request object to use for the request.
HrisGetTaskResponse
Error Type
Status Code
Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException
400
application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException
401
application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException
403
application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException
404
application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException
408
application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException
409
application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException
412
application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException
422
application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException
429
application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse
500
application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException
501
application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException
502
application/json
StackOneHQ.Client.Models.Errors.APIException
4XX, 5XX
*/*