Skip to main content

Actions

The ballerinax/sap.successfactors.ectimeoff package exposes the following clients:

Available clients:

ClientPurpose
ClientManages ectimeoff objects: TimeAccountPostingRule, WorkScheduleDayModelVariantAssignment, HolidayAssignment, TimeAccountPurchaseProfile, TimeTypeCAN, WorkScheduleDayModelVariantIdentifier, TimeManagementTerminationEndHandlingExcludedEventReason, TimeAccountPurchaseProfilePayComponentAssignment…, over the SAP SuccessFactors OData v2 API.

Client​

API to manage absences such as vacation, sick leave, and paid time off

Configuration​

ConnectionConfig​

Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.

FieldTypeDefaultDescription
authhttp:CredentialsConfigRequiredConfigurations related to client authentication
httpVersionhttp:HttpVersionSee defaultThe HTTP version understood by the client
http1Settingshttp:ClientHttp1SettingsSee defaultConfigurations related to HTTP/1.x protocol
http2Settingshttp:ClientHttp2SettingsSee defaultConfigurations related to HTTP/2 protocol
timeoutdecimalSee defaultThe maximum time to wait (in seconds) for a response before closing the connection
forwardedstringSee defaultThe choice of setting forwarded/x-forwarded header
followRedirectshttp:FollowRedirectsOptionalConfigurations associated with Redirection
poolConfighttp:PoolConfigurationOptionalConfigurations associated with request pooling
cachehttp:CacheConfigSee defaultHTTP caching related configurations
compressionhttp:CompressionSee defaultSpecifies the way of handling compression (accept-encoding) header
circuitBreakerhttp:CircuitBreakerConfigOptionalConfigurations associated with the behaviour of the Circuit Breaker
retryConfighttp:RetryConfigOptionalConfigurations associated with retrying
cookieConfighttp:CookieConfigOptionalConfigurations associated with cookies
responseLimitshttp:ResponseLimitConfigsSee defaultConfigurations associated with inbound response size limits
secureSockethttp:ClientSecureSocketOptionalSSL/TLS-related options
proxyhttp:ProxyConfigOptionalProxy server related options
socketConfighttp:ClientSocketConfigSee defaultProvides settings related to client socket configuration
validationbooleanSee defaultEnables the inbound payload validation functionality which provided by the constraint package. Enabled by default
laxDataBindingbooleanSee defaultEnables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).

Initializing the client​

import ballerinax/sap.successfactors.ectimeoff;

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

ectimeoff:Client client = check new (
{
auth: { username, password }
},
hostname
);

Operations​

TimeAccountPostingRule​

listTimeAccountPostingRules

Queries the TimeAccountPostingRule collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountPostingRulesQueriesNoQueries to be sent with the request

Returns: ListTimeAccountPostingRulesResponse&#124;error

Sample code:

ListTimeAccountPostingRulesResponse result = check client->listTimeAccountPostingRules();

Sample response:

{
"d": {}
}
getTimeAccountPostingRule

Retrieves a single TimeAccountPostingRule entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountPostingRuleQueriesNoQueries to be sent with the request

Returns: GetTimeAccountPostingRuleResponse&#124;error

Sample code:

GetTimeAccountPostingRuleResponse result = check client->getTimeAccountPostingRule(TimeType_externalCode, externalCode);

WorkScheduleDayModelVariantAssignment​

listWorkScheduleDayModelVariantAssignments

Queries the WorkScheduleDayModelVariantAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelVariantAssignmentsQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelVariantAssignmentsResponse&#124;error

Sample code:

ListWorkScheduleDayModelVariantAssignmentsResponse result = check client->listWorkScheduleDayModelVariantAssignments();

Sample response:

{
"d": {}
}
getWorkScheduleDayModelVariantAssignment

Retrieves a single WorkScheduleDayModelVariantAssignment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModel_externalCodestringYeskey: WorkScheduleDayModel_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelVariantAssignmentQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelVariantAssignmentResponse&#124;error

Sample code:

GetWorkScheduleDayModelVariantAssignmentResponse result = check client->getWorkScheduleDayModelVariantAssignment(WorkScheduleDayModel_externalCode, externalCode);

HolidayAssignment​

listHolidayAssignments

Queries the HolidayAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListHolidayAssignmentsQueriesNoQueries to be sent with the request

Returns: ListHolidayAssignmentsResponse&#124;error

Sample code:

ListHolidayAssignmentsResponse result = check client->listHolidayAssignments();

Sample response:

{
"d": {}
}
getHolidayAssignment

Retrieves a single HolidayAssignment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
HolidayCalendar_externalCodestringYeskey: HolidayCalendar_externalCode
datestringYeskey: date
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetHolidayAssignmentQueriesNoQueries to be sent with the request

Returns: GetHolidayAssignmentResponse&#124;error

Sample code:

GetHolidayAssignmentResponse result = check client->getHolidayAssignment(HolidayCalendar_externalCode, date);

TimeAccountPurchaseProfile​

listTimeAccountPurchaseProfiles

Queries the TimeAccountPurchaseProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountPurchaseProfilesQueriesNoQueries to be sent with the request

Returns: ListTimeAccountPurchaseProfilesResponse&#124;error

Sample code:

ListTimeAccountPurchaseProfilesResponse result = check client->listTimeAccountPurchaseProfiles();

Sample response:

{
"d": {}
}
getTimeAccountPurchaseProfile

Retrieves a single TimeAccountPurchaseProfile entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountPurchaseProfileQueriesNoQueries to be sent with the request

Returns: GetTimeAccountPurchaseProfileResponse&#124;error

Sample code:

GetTimeAccountPurchaseProfileResponse result = check client->getTimeAccountPurchaseProfile(externalCode);

TimeTypeCAN​

listTimeTypeCANs

Queries the TimeTypeCAN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeCANsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeCANsResponse&#124;error

Sample code:

ListTimeTypeCANsResponse result = check client->listTimeTypeCANs();

Sample response:

{
"d": {}
}
getTimeTypeCAN

Retrieves a single TimeTypeCAN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeCANQueriesNoQueries to be sent with the request

Returns: GetTimeTypeCANResponse&#124;error

Sample code:

GetTimeTypeCANResponse result = check client->getTimeTypeCAN(TimeType_externalCode, externalCode);

WorkScheduleDayModelVariantIdentifier​

listWorkScheduleDayModelVariantIdentifiers

Queries the WorkScheduleDayModelVariantIdentifier collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelVariantIdentifiersQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelVariantIdentifiersResponse&#124;error

Sample code:

ListWorkScheduleDayModelVariantIdentifiersResponse result = check client->listWorkScheduleDayModelVariantIdentifiers();

Sample response:

{
"d": {}
}
getWorkScheduleDayModelVariantIdentifier

Retrieves a single WorkScheduleDayModelVariantIdentifier entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelVariantIdentifierQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelVariantIdentifierResponse&#124;error

Sample code:

GetWorkScheduleDayModelVariantIdentifierResponse result = check client->getWorkScheduleDayModelVariantIdentifier(externalCode);

TimeManagementTerminationEndHandlingExcludedEventReason​

listTimeManagementTerminationEndHandlingExcludedEventReasons

Queries the TimeManagementTerminationEndHandlingExcludedEventReason collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementTerminationEndHandlingExcludedEventReasonsQueriesNoQueries to be sent with the request

Returns: ListTimeManagementTerminationEndHandlingExcludedEventReasonsResponse&#124;error

Sample code:

ListTimeManagementTerminationEndHandlingExcludedEventReasonsResponse result = check client->listTimeManagementTerminationEndHandlingExcludedEventReasons();

Sample response:

{
"d": {}
}
getTimeManagementTerminationEndHandlingExcludedEventReason

Retrieves a single TimeManagementTerminationEndHandlingExcludedEventReason entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeManagementTerminationEndHandlingExclusion_externalCodestringYeskey: TimeManagementTerminationEndHandlingExclusion_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementTerminationEndHandlingExcludedEventReasonQueriesNoQueries to be sent with the request

Returns: GetTimeManagementTerminationEndHandlingExcludedEventReasonResponse&#124;error

Sample code:

GetTimeManagementTerminationEndHandlingExcludedEventReasonResponse result = check client->getTimeManagementTerminationEndHandlingExcludedEventReason(TimeManagementTerminationEndHandlingExclusion_externalCode, externalCode);

TimeAccountPurchaseProfilePayComponentAssignment​

listTimeAccountPurchaseProfilePayComponentAssignments

Queries the TimeAccountPurchaseProfilePayComponentAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountPurchaseProfilePayComponentAssignmentsQueriesNoQueries to be sent with the request

Returns: ListTimeAccountPurchaseProfilePayComponentAssignmentsResponse&#124;error

Sample code:

ListTimeAccountPurchaseProfilePayComponentAssignmentsResponse result = check client->listTimeAccountPurchaseProfilePayComponentAssignments();

Sample response:

{
"d": {}
}
getTimeAccountPurchaseProfilePayComponentAssignment

Retrieves a single TimeAccountPurchaseProfilePayComponentAssignment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeAccountPurchaseProfile_externalCodestringYeskey: TimeAccountPurchaseProfile_externalCode
payComponentstringYeskey: payComponent
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountPurchaseProfilePayComponentAssignmentQueriesNoQueries to be sent with the request

Returns: GetTimeAccountPurchaseProfilePayComponentAssignmentResponse&#124;error

Sample code:

GetTimeAccountPurchaseProfilePayComponentAssignmentResponse result = check client->getTimeAccountPurchaseProfilePayComponentAssignment(TimeAccountPurchaseProfile_externalCode, payComponent);

EmployeeTimeGroupItem​

listEmployeeTimeGroupItems

Queries the EmployeeTimeGroupItem collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeGroupItemsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeGroupItems();
getEmployeeTimeGroupItem

Retrieves a single EmployeeTimeGroupItem entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTimeGroup_externalCodestringYeskey: EmployeeTimeGroup_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeGroupItemQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeGroupItem(EmployeeTimeGroup_externalCode, externalCode);

WorkScheduleDayModelAssignment​

listWorkScheduleDayModelAssignments

Queries the WorkScheduleDayModelAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelAssignmentsQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelAssignmentsResponse&#124;error

Sample code:

ListWorkScheduleDayModelAssignmentsResponse result = check client->listWorkScheduleDayModelAssignments();

Sample response:

{
"d": {}
}
createWorkScheduleDayModelAssignment

Creates a new WorkScheduleDayModelAssignment entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleDayModelAssignmentYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleDayModelAssignmentResponse&#124;error

Sample code:

CreateWorkScheduleDayModelAssignmentResponse result = check client->createWorkScheduleDayModelAssignment(payload);
getWorkScheduleDayModelAssignment

Retrieves a single WorkScheduleDayModelAssignment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelAssignmentQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelAssignmentResponse&#124;error

Sample code:

GetWorkScheduleDayModelAssignmentResponse result = check client->getWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day);
updateWorkScheduleDayModelAssignment

Updates the WorkScheduleDayModelAssignment identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
payloadUpdateWorkScheduleDayModelAssignmentPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day, payload);
deleteWorkScheduleDayModelAssignment

Deletes the WorkScheduleDayModelAssignment identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
headersDeleteWorkScheduleDayModelAssignmentHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day);

TimeAccountDetail​

listTimeAccountDetails

Queries the TimeAccountDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountDetailsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listTimeAccountDetails();
getTimeAccountDetail

Retrieves a single TimeAccountDetail entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeAccount_externalCodestringYeskey: TimeAccount_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountDetailQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeAccountDetail(TimeAccount_externalCode, externalCode);
deleteTimeAccountDetail

Deletes the TimeAccountDetail identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeAccount_externalCodestringYeskey: TimeAccount_externalCode
externalCodestringYeskey: externalCode
headersDeleteTimeAccountDetailHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteTimeAccountDetail(TimeAccount_externalCode, externalCode);

TimeTypeNLD​

listTimeTypeNLDs

Queries the TimeTypeNLD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeNLDsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeNLDsResponse&#124;error

Sample code:

ListTimeTypeNLDsResponse result = check client->listTimeTypeNLDs();

Sample response:

{
"d": {}
}
getTimeTypeNLD

Retrieves a single TimeTypeNLD entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeNLDQueriesNoQueries to be sent with the request

Returns: GetTimeTypeNLDResponse&#124;error

Sample code:

GetTimeTypeNLDResponse result = check client->getTimeTypeNLD(TimeType_externalCode, externalCode);

TimeTypeSWE​

listTimeTypeSWEs

Queries the TimeTypeSWE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeSWEsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeSWEsResponse&#124;error

Sample code:

ListTimeTypeSWEsResponse result = check client->listTimeTypeSWEs();

Sample response:

{
"d": {}
}
getTimeTypeSWE

Retrieves a single TimeTypeSWE entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeSWEQueriesNoQueries to be sent with the request

Returns: GetTimeTypeSWEResponse&#124;error

Sample code:

GetTimeTypeSWEResponse result = check client->getTimeTypeSWE(TimeType_externalCode, externalCode);

TimeTypeNOR​

listTimeTypeNORs

Queries the TimeTypeNOR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeNORsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeNORsResponse&#124;error

Sample code:

ListTimeTypeNORsResponse result = check client->listTimeTypeNORs();

Sample response:

{
"d": {}
}
getTimeTypeNOR

Retrieves a single TimeTypeNOR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeNORQueriesNoQueries to be sent with the request

Returns: GetTimeTypeNORResponse&#124;error

Sample code:

GetTimeTypeNORResponse result = check client->getTimeTypeNOR(TimeType_externalCode, externalCode);

TimeTypeITA​

listTimeTypeITAs

Queries the TimeTypeITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeITAsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeITAsResponse&#124;error

Sample code:

ListTimeTypeITAsResponse result = check client->listTimeTypeITAs();

Sample response:

{
"d": {}
}
getTimeTypeITA

Retrieves a single TimeTypeITA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeITAQueriesNoQueries to be sent with the request

Returns: GetTimeTypeITAResponse&#124;error

Sample code:

GetTimeTypeITAResponse result = check client->getTimeTypeITA(TimeType_externalCode, externalCode);

AbsenceCountingMethod​

listAbsenceCountingMethods

Queries the AbsenceCountingMethod collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListAbsenceCountingMethodsQueriesNoQueries to be sent with the request

Returns: ListAbsenceCountingMethodsResponse&#124;error

Sample code:

ListAbsenceCountingMethodsResponse result = check client->listAbsenceCountingMethods();

Sample response:

{
"d": {}
}
getAbsenceCountingMethod

Retrieves a single AbsenceCountingMethod entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetAbsenceCountingMethodQueriesNoQueries to be sent with the request

Returns: GetAbsenceCountingMethodResponse&#124;error

Sample code:

GetAbsenceCountingMethodResponse result = check client->getAbsenceCountingMethod(externalCode);

ShiftClassification​

listShiftClassifications

Queries the ShiftClassification collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListShiftClassificationsQueriesNoQueries to be sent with the request

Returns: ListShiftClassificationsResponse&#124;error

Sample code:

ListShiftClassificationsResponse result = check client->listShiftClassifications();

Sample response:

{
"d": {}
}
getShiftClassification

Retrieves a single ShiftClassification entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetShiftClassificationQueriesNoQueries to be sent with the request

Returns: GetShiftClassificationResponse&#124;error

Sample code:

GetShiftClassificationResponse result = check client->getShiftClassification(externalCode);

WorkScheduleDay​

listWorkScheduleDays

Queries the WorkScheduleDay collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDaysQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDaysResponse&#124;error

Sample code:

ListWorkScheduleDaysResponse result = check client->listWorkScheduleDays();

Sample response:

{
"d": {}
}
createWorkScheduleDay

Creates a new WorkScheduleDay entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleDayYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleDayResponse&#124;error

Sample code:

CreateWorkScheduleDayResponse result = check client->createWorkScheduleDay(payload);
getWorkScheduleDay

Retrieves a single WorkScheduleDay entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayResponse&#124;error

Sample code:

GetWorkScheduleDayResponse result = check client->getWorkScheduleDay(WorkSchedule_externalCode, day);
updateWorkScheduleDay

Updates the WorkScheduleDay identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
payloadUpdateWorkScheduleDayPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkScheduleDay(WorkSchedule_externalCode, day, payload);
deleteWorkScheduleDay

Deletes the WorkScheduleDay identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
dayintYeskey: day
headersDeleteWorkScheduleDayHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkScheduleDay(WorkSchedule_externalCode, day);

HolidayCalendar​

listHolidayCalendars

Queries the HolidayCalendar collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListHolidayCalendarsQueriesNoQueries to be sent with the request

Returns: ListHolidayCalendarsResponse&#124;error

Sample code:

ListHolidayCalendarsResponse result = check client->listHolidayCalendars();

Sample response:

{
"d": {}
}
getHolidayCalendar

Retrieves a single HolidayCalendar entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetHolidayCalendarQueriesNoQueries to be sent with the request

Returns: GetHolidayCalendarResponse&#124;error

Sample code:

GetHolidayCalendarResponse result = check client->getHolidayCalendar(externalCode);

TimeManagementTerminationEndHandlingExcludedTimeAccountType​

listTimeManagementTerminationEndHandlingExcludedTimeAccountTypes

Queries the TimeManagementTerminationEndHandlingExcludedTimeAccountType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementTerminationEndHandlingExcludedTimeAccountTypesQueriesNoQueries to be sent with the request

Returns: ListTimeManagementTerminationEndHandlingExcludedTimeAccountTypesResponse&#124;error

Sample code:

ListTimeManagementTerminationEndHandlingExcludedTimeAccountTypesResponse result = check client->listTimeManagementTerminationEndHandlingExcludedTimeAccountTypes();

Sample response:

{
"d": {}
}
getTimeManagementTerminationEndHandlingExcludedTimeAccountType

Retrieves a single TimeManagementTerminationEndHandlingExcludedTimeAccountType entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeManagementTerminationEndHandlingExclusion_externalCodestringYeskey: TimeManagementTerminationEndHandlingExclusion_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementTerminationEndHandlingExcludedTimeAccountTypeQueriesNoQueries to be sent with the request

Returns: GetTimeManagementTerminationEndHandlingExcludedTimeAccountTypeResponse&#124;error

Sample code:

GetTimeManagementTerminationEndHandlingExcludedTimeAccountTypeResponse result = check client->getTimeManagementTerminationEndHandlingExcludedTimeAccountType(TimeManagementTerminationEndHandlingExclusion_externalCode, externalCode);

EmployeeTimeDEU​

listEmployeeTimeDEUs

Queries the EmployeeTimeDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeDEUsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeDEUs();
getEmployeeTimeDEU

Retrieves a single EmployeeTimeDEU entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeDEUQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeDEU(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeDEU

Deletes the EmployeeTimeDEU identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeDEUHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeDEU(EmployeeTime_externalCode, externalCode);

TimeAccount​

listTimeAccounts

Queries the TimeAccount collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listTimeAccounts();
getTimeAccount

Retrieves a single TimeAccount entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeAccount(externalCode);
deleteTimeAccount

Deletes the TimeAccount identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteTimeAccountHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteTimeAccount(externalCode);

WorkScheduleDayModelAssignmentSegment​

listWorkScheduleDayModelAssignmentSegments

Queries the WorkScheduleDayModelAssignmentSegment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelAssignmentSegmentsQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelAssignmentSegmentsResponse&#124;error

Sample code:

ListWorkScheduleDayModelAssignmentSegmentsResponse result = check client->listWorkScheduleDayModelAssignmentSegments();

Sample response:

{
"d": {}
}
createWorkScheduleDayModelAssignmentSegment

Creates a new WorkScheduleDayModelAssignmentSegment entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleDayModelAssignmentSegmentYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleDayModelAssignmentSegmentResponse&#124;error

Sample code:

CreateWorkScheduleDayModelAssignmentSegmentResponse result = check client->createWorkScheduleDayModelAssignmentSegment(payload);
getWorkScheduleDayModelAssignmentSegment

Retrieves a single WorkScheduleDayModelAssignmentSegment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModelAssignment_dayintYeskey: WorkScheduleDayModelAssignment_day
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelAssignmentSegmentQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelAssignmentSegmentResponse&#124;error

Sample code:

GetWorkScheduleDayModelAssignmentSegmentResponse result = check client->getWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode);
updateWorkScheduleDayModelAssignmentSegment

Updates the WorkScheduleDayModelAssignmentSegment identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModelAssignment_dayintYeskey: WorkScheduleDayModelAssignment_day
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
externalCodestringYeskey: externalCode
payloadUpdateWorkScheduleDayModelAssignmentSegmentPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode, payload);
deleteWorkScheduleDayModelAssignmentSegment

Deletes the WorkScheduleDayModelAssignmentSegment identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModelAssignment_dayintYeskey: WorkScheduleDayModelAssignment_day
WorkSchedule_externalCodestringYeskey: WorkSchedule_externalCode
externalCodestringYeskey: externalCode
headersDeleteWorkScheduleDayModelAssignmentSegmentHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode);

EmployeeTimeCOL​

listEmployeeTimeCOLs

Queries the EmployeeTimeCOL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeCOLsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeCOLs();
getEmployeeTimeCOL

Retrieves a single EmployeeTimeCOL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeCOLQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeCOL(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeCOL

Deletes the EmployeeTimeCOL identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeCOLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeCOL(EmployeeTime_externalCode, externalCode);

EmployeeTimeESP​

listEmployeeTimeESPs

Queries the EmployeeTimeESP collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeESPsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeESPs();
getEmployeeTimeESP

Retrieves a single EmployeeTimeESP entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeESPQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeESP(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeESP

Deletes the EmployeeTimeESP identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeESPHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeESP(EmployeeTime_externalCode, externalCode);

TimeManagementTerminationEndHandlingConfiguration​

listTimeManagementTerminationEndHandlingConfigurations

Queries the TimeManagementTerminationEndHandlingConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementTerminationEndHandlingConfigurationsQueriesNoQueries to be sent with the request

Returns: ListTimeManagementTerminationEndHandlingConfigurationsResponse&#124;error

Sample code:

ListTimeManagementTerminationEndHandlingConfigurationsResponse result = check client->listTimeManagementTerminationEndHandlingConfigurations();

Sample response:

{
"d": {}
}
getTimeManagementTerminationEndHandlingConfiguration

Retrieves a single TimeManagementTerminationEndHandlingConfiguration entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementTerminationEndHandlingConfigurationQueriesNoQueries to be sent with the request

Returns: GetTimeManagementTerminationEndHandlingConfigurationResponse&#124;error

Sample code:

GetTimeManagementTerminationEndHandlingConfigurationResponse result = check client->getTimeManagementTerminationEndHandlingConfiguration(externalCode);

HolidayCategory​

listHolidayCategorys

Queries the HolidayCategory collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListHolidayCategorysQueriesNoQueries to be sent with the request

Returns: ListHolidayCategorysResponse&#124;error

Sample code:

ListHolidayCategorysResponse result = check client->listHolidayCategorys();

Sample response:

{
"d": {
"results": [
{
"externalCode": "1000"
}
]
}
}
getHolidayCategory

Retrieves a single HolidayCategory entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetHolidayCategoryQueriesNoQueries to be sent with the request

Returns: GetHolidayCategoryResponse&#124;error

Sample code:

GetHolidayCategoryResponse result = check client->getHolidayCategory(externalCode);

ElectronicSicknessCertificateExclusionReasonDEU​

listElectronicSicknessCertificateExclusionReasonDEUs

Queries the ElectronicSicknessCertificateExclusionReasonDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListElectronicSicknessCertificateExclusionReasonDEUsQueriesNoQueries to be sent with the request

Returns: ListElectronicSicknessCertificateExclusionReasonDEUsResponse&#124;error

Sample code:

ListElectronicSicknessCertificateExclusionReasonDEUsResponse result = check client->listElectronicSicknessCertificateExclusionReasonDEUs();

Sample response:

{
"d": {}
}
getElectronicSicknessCertificateExclusionReasonDEU

Retrieves a single ElectronicSicknessCertificateExclusionReasonDEU entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetElectronicSicknessCertificateExclusionReasonDEUQueriesNoQueries to be sent with the request

Returns: GetElectronicSicknessCertificateExclusionReasonDEUResponse&#124;error

Sample code:

GetElectronicSicknessCertificateExclusionReasonDEUResponse result = check client->getElectronicSicknessCertificateExclusionReasonDEU(externalCode);

EmployeeTimeGroup​

listEmployeeTimeGroups

Queries the EmployeeTimeGroup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeGroupsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeGroups();
getEmployeeTimeGroup

Retrieves a single EmployeeTimeGroup entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeGroupQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeGroup(externalCode);

TimeAccountType​

listTimeAccountTypes

Queries the TimeAccountType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountTypesQueriesNoQueries to be sent with the request

Returns: ListTimeAccountTypesResponse&#124;error

Sample code:

ListTimeAccountTypesResponse result = check client->listTimeAccountTypes();

Sample response:

{
"d": {}
}
getTimeAccountType

Retrieves a single TimeAccountType entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountTypeQueriesNoQueries to be sent with the request

Returns: GetTimeAccountTypeResponse&#124;error

Sample code:

GetTimeAccountTypeResponse result = check client->getTimeAccountType(externalCode);

AccrualCalculationBase​

listAccrualCalculationBases

Queries the AccrualCalculationBase collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListAccrualCalculationBasesQueriesNoQueries to be sent with the request

Returns: ListAccrualCalculationBasesResponse&#124;error

Sample code:

ListAccrualCalculationBasesResponse result = check client->listAccrualCalculationBases();

Sample response:

{
"d": {}
}
createAccrualCalculationBase

Creates a new AccrualCalculationBase entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadAccrualCalculationBaseYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateAccrualCalculationBaseResponse&#124;error

Sample code:

CreateAccrualCalculationBaseResponse result = check client->createAccrualCalculationBase(payload);
getAccrualCalculationBase

Retrieves a single AccrualCalculationBase entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetAccrualCalculationBaseQueriesNoQueries to be sent with the request

Returns: GetAccrualCalculationBaseResponse&#124;error

Sample code:

GetAccrualCalculationBaseResponse result = check client->getAccrualCalculationBase(externalCode);
updateAccrualCalculationBase

Updates the AccrualCalculationBase identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadUpdateAccrualCalculationBasePayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateAccrualCalculationBase(externalCode, payload);
deleteAccrualCalculationBase

Deletes the AccrualCalculationBase identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteAccrualCalculationBaseHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteAccrualCalculationBase(externalCode);

EmployeeTimeUSA​

listEmployeeTimeUSAs

Queries the EmployeeTimeUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeUSAsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeUSAsResponse&#124;error

Sample code:

ListEmployeeTimeUSAsResponse result = check client->listEmployeeTimeUSAs();

Sample response:

{
"d": {}
}
createEmployeeTimeUSA

Creates a new EmployeeTimeUSA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeUSAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeUSAResponse&#124;error

Sample code:

CreateEmployeeTimeUSAResponse result = check client->createEmployeeTimeUSA(payload);
getEmployeeTimeUSA

Retrieves a single EmployeeTimeUSA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeUSAQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeUSAResponse&#124;error

Sample code:

GetEmployeeTimeUSAResponse result = check client->getEmployeeTimeUSA(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeUSA

Updates the EmployeeTimeUSA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeUSAPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeUSA(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeUSA

Deletes the EmployeeTimeUSA identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeUSAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeUSA(EmployeeTime_externalCode, externalCode);

TimeTypeUSA​

listTimeTypeUSAs

Queries the TimeTypeUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeUSAsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeUSAsResponse&#124;error

Sample code:

ListTimeTypeUSAsResponse result = check client->listTimeTypeUSAs();

Sample response:

{
"d": {}
}
getTimeTypeUSA

Retrieves a single TimeTypeUSA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeUSAQueriesNoQueries to be sent with the request

Returns: GetTimeTypeUSAResponse&#124;error

Sample code:

GetTimeTypeUSAResponse result = check client->getTimeTypeUSA(TimeType_externalCode, externalCode);

TemporaryTimeInformation​

listTemporaryTimeInformations

Queries the TemporaryTimeInformation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTemporaryTimeInformationsQueriesNoQueries to be sent with the request

Returns: ListTemporaryTimeInformationsResponse&#124;error

Sample code:

ListTemporaryTimeInformationsResponse result = check client->listTemporaryTimeInformations();

Sample response:

{
"d": {}
}
createTemporaryTimeInformation

Creates a new TemporaryTimeInformation entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadTemporaryTimeInformationYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateTemporaryTimeInformationResponse&#124;error

Sample code:

CreateTemporaryTimeInformationResponse result = check client->createTemporaryTimeInformation(payload);
getTemporaryTimeInformation

Retrieves a single TemporaryTimeInformation entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTemporaryTimeInformationQueriesNoQueries to be sent with the request

Returns: GetTemporaryTimeInformationResponse&#124;error

Sample code:

GetTemporaryTimeInformationResponse result = check client->getTemporaryTimeInformation(externalCode);
updateTemporaryTimeInformation

Updates the TemporaryTimeInformation identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadUpdateTemporaryTimeInformationPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateTemporaryTimeInformation(externalCode, payload);
deleteTemporaryTimeInformation

Deletes the TemporaryTimeInformation identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteTemporaryTimeInformationHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteTemporaryTimeInformation(externalCode);

TimeTypeProfile​

listTimeTypeProfiles

Queries the TimeTypeProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeProfilesQueriesNoQueries to be sent with the request

Returns: ListTimeTypeProfilesResponse&#124;error

Sample code:

ListTimeTypeProfilesResponse result = check client->listTimeTypeProfiles();

Sample response:

{
"d": {}
}
getTimeTypeProfile

Retrieves a single TimeTypeProfile entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
mdfSystemEffectiveStartDatestringYeskey: mdfSystemEffectiveStartDate
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeProfileQueriesNoQueries to be sent with the request

Returns: GetTimeTypeProfileResponse&#124;error

Sample code:

GetTimeTypeProfileResponse result = check client->getTimeTypeProfile(externalCode, mdfSystemEffectiveStartDate);

TimeManagementAlert​

listTimeManagementAlerts

Queries the TimeManagementAlert collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementAlertsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listTimeManagementAlerts();
getTimeManagementAlert

Retrieves a single TimeManagementAlert entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementAlertQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeManagementAlert(externalCode);

TimeTypeDEU​

listTimeTypeDEUs

Queries the TimeTypeDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeDEUsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeDEUsResponse&#124;error

Sample code:

ListTimeTypeDEUsResponse result = check client->listTimeTypeDEUs();

Sample response:

{
"d": {}
}
getTimeTypeDEU

Retrieves a single TimeTypeDEU entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeDEUQueriesNoQueries to be sent with the request

Returns: GetTimeTypeDEUResponse&#124;error

Sample code:

GetTimeTypeDEUResponse result = check client->getTimeTypeDEU(TimeType_externalCode, externalCode);

TimeType​

listTimeTypes

Queries the TimeType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypesQueriesNoQueries to be sent with the request

Returns: ListTimeTypesResponse&#124;error

Sample code:

ListTimeTypesResponse result = check client->listTimeTypes();

Sample response:

{
"d": {}
}
getTimeType

Retrieves a single TimeType entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeQueriesNoQueries to be sent with the request

Returns: GetTimeTypeResponse&#124;error

Sample code:

GetTimeTypeResponse result = check client->getTimeType(externalCode);

TimeManagementTerminationEndHandlingExclusion​

listTimeManagementTerminationEndHandlingExclusions

Queries the TimeManagementTerminationEndHandlingExclusion collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementTerminationEndHandlingExclusionsQueriesNoQueries to be sent with the request

Returns: ListTimeManagementTerminationEndHandlingExclusionsResponse&#124;error

Sample code:

ListTimeManagementTerminationEndHandlingExclusionsResponse result = check client->listTimeManagementTerminationEndHandlingExclusions();

Sample response:

{
"d": {}
}
getTimeManagementTerminationEndHandlingExclusion

Retrieves a single TimeManagementTerminationEndHandlingExclusion entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementTerminationEndHandlingExclusionQueriesNoQueries to be sent with the request

Returns: GetTimeManagementTerminationEndHandlingExclusionResponse&#124;error

Sample code:

GetTimeManagementTerminationEndHandlingExclusionResponse result = check client->getTimeManagementTerminationEndHandlingExclusion(externalCode);

EmployeeTimeMEX​

listEmployeeTimeMEXs

Queries the EmployeeTimeMEX collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeMEXsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeMEXs();
getEmployeeTimeMEX

Retrieves a single EmployeeTimeMEX entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeMEXQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeMEX(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeMEX

Deletes the EmployeeTimeMEX identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeMEXHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeMEX(EmployeeTime_externalCode, externalCode);

WorkScheduleDayModel​

listWorkScheduleDayModels

Queries the WorkScheduleDayModel collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelsQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelsResponse&#124;error

Sample code:

ListWorkScheduleDayModelsResponse result = check client->listWorkScheduleDayModels();

Sample response:

{
"d": {}
}
createWorkScheduleDayModel

Creates a new WorkScheduleDayModel entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleDayModelYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleDayModelResponse&#124;error

Sample code:

CreateWorkScheduleDayModelResponse result = check client->createWorkScheduleDayModel(payload);
getWorkScheduleDayModel

Retrieves a single WorkScheduleDayModel entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelResponse&#124;error

Sample code:

GetWorkScheduleDayModelResponse result = check client->getWorkScheduleDayModel(externalCode);
updateWorkScheduleDayModel

Updates the WorkScheduleDayModel identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadUpdateWorkScheduleDayModelPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkScheduleDayModel(externalCode, payload);
deleteWorkScheduleDayModel

Deletes the WorkScheduleDayModel identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteWorkScheduleDayModelHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkScheduleDayModel(externalCode);

TimeAccountSnapshot​

listTimeAccountSnapshots

Queries the TimeAccountSnapshot collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountSnapshotsQueriesNoQueries to be sent with the request

Returns: ListTimeAccountSnapshotsResponse&#124;error

Sample code:

ListTimeAccountSnapshotsResponse result = check client->listTimeAccountSnapshots();

Sample response:

{
"d": {}
}
getTimeAccountSnapshot

Retrieves a single TimeAccountSnapshot entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountSnapshotQueriesNoQueries to be sent with the request

Returns: GetTimeAccountSnapshotResponse&#124;error

Sample code:

GetTimeAccountSnapshotResponse result = check client->getTimeAccountSnapshot(externalCode);

EmpTimeAccountBalance​

listEmpTimeAccountBalances

Queries the EmpTimeAccountBalance collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmpTimeAccountBalancesQueriesNoQueries to be sent with the request

Returns: ListEmpTimeAccountBalancesResponse&#124;error

Sample code:

ListEmpTimeAccountBalancesResponse result = check client->listEmpTimeAccountBalances();

Sample response:

{
"d": {}
}
getEmpTimeAccountBalance

Retrieves a single EmpTimeAccountBalance entity identified by its key property.

Parameters:

NameTypeRequiredDescription
timeAccountstringYeskey: timeAccount
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmpTimeAccountBalanceQueriesNoQueries to be sent with the request

Returns: GetEmpTimeAccountBalanceResponse&#124;error

Sample code:

GetEmpTimeAccountBalanceResponse result = check client->getEmpTimeAccountBalance(timeAccount);

TimeManagementAlertMessage​

listTimeManagementAlertMessages

Queries the TimeManagementAlertMessage collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementAlertMessagesQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listTimeManagementAlertMessages();
getTimeManagementAlertMessage

Retrieves a single TimeManagementAlertMessage entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeManagementAlert_externalCodestringYeskey: TimeManagementAlert_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementAlertMessageQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeManagementAlertMessage(TimeManagementAlert_externalCode, externalCode);

EmployeeTimeNLD​

listEmployeeTimeNLDs

Queries the EmployeeTimeNLD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeNLDsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeNLDsResponse&#124;error

Sample code:

ListEmployeeTimeNLDsResponse result = check client->listEmployeeTimeNLDs();

Sample response:

{
"d": {}
}
createEmployeeTimeNLD

Creates a new EmployeeTimeNLD entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeNLDYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeNLDResponse&#124;error

Sample code:

CreateEmployeeTimeNLDResponse result = check client->createEmployeeTimeNLD(payload);
getEmployeeTimeNLD

Retrieves a single EmployeeTimeNLD entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeNLDQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeNLDResponse&#124;error

Sample code:

GetEmployeeTimeNLDResponse result = check client->getEmployeeTimeNLD(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeNLD

Updates the EmployeeTimeNLD identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeNLDPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeNLD(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeNLD

Deletes the EmployeeTimeNLD identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeNLDHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeNLD(EmployeeTime_externalCode, externalCode);

EmployeeTimeSWE​

listEmployeeTimeSWEs

Queries the EmployeeTimeSWE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeSWEsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeSWEsResponse&#124;error

Sample code:

ListEmployeeTimeSWEsResponse result = check client->listEmployeeTimeSWEs();

Sample response:

{
"d": {}
}
createEmployeeTimeSWE

Creates a new EmployeeTimeSWE entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeSWEYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeSWEResponse&#124;error

Sample code:

CreateEmployeeTimeSWEResponse result = check client->createEmployeeTimeSWE(payload);
getEmployeeTimeSWE

Retrieves a single EmployeeTimeSWE entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeSWEQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeSWEResponse&#124;error

Sample code:

GetEmployeeTimeSWEResponse result = check client->getEmployeeTimeSWE(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeSWE

Updates the EmployeeTimeSWE identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeSWEPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeSWE(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeSWE

Deletes the EmployeeTimeSWE identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeSWEHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeSWE(EmployeeTime_externalCode, externalCode);

EmployeeTimeNOR​

listEmployeeTimeNORs

Queries the EmployeeTimeNOR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeNORsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeNORsResponse&#124;error

Sample code:

ListEmployeeTimeNORsResponse result = check client->listEmployeeTimeNORs();

Sample response:

{
"d": {}
}
createEmployeeTimeNOR

Creates a new EmployeeTimeNOR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeNORYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeNORResponse&#124;error

Sample code:

CreateEmployeeTimeNORResponse result = check client->createEmployeeTimeNOR(payload);
getEmployeeTimeNOR

Retrieves a single EmployeeTimeNOR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeNORQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeNORResponse&#124;error

Sample code:

GetEmployeeTimeNORResponse result = check client->getEmployeeTimeNOR(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeNOR

Updates the EmployeeTimeNOR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeNORPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeNOR(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeNOR

Deletes the EmployeeTimeNOR identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeNORHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeNOR(EmployeeTime_externalCode, externalCode);

EmployeeTimeITA​

listEmployeeTimeITAs

Queries the EmployeeTimeITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeITAsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeITAsResponse&#124;error

Sample code:

ListEmployeeTimeITAsResponse result = check client->listEmployeeTimeITAs();

Sample response:

{
"d": {}
}
createEmployeeTimeITA

Creates a new EmployeeTimeITA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeITAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeITAResponse&#124;error

Sample code:

CreateEmployeeTimeITAResponse result = check client->createEmployeeTimeITA(payload);
getEmployeeTimeITA

Retrieves a single EmployeeTimeITA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeITAQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeITAResponse&#124;error

Sample code:

GetEmployeeTimeITAResponse result = check client->getEmployeeTimeITA(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeITA

Updates the EmployeeTimeITA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeITAPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeITA(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeITA

Deletes the EmployeeTimeITA identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeITAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeITA(EmployeeTime_externalCode, externalCode);

EmployeeTimeCAN​

listEmployeeTimeCANs

Queries the EmployeeTimeCAN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeCANsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeCANsResponse&#124;error

Sample code:

ListEmployeeTimeCANsResponse result = check client->listEmployeeTimeCANs();

Sample response:

{
"d": {}
}
createEmployeeTimeCAN

Creates a new EmployeeTimeCAN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeCANYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeCANResponse&#124;error

Sample code:

CreateEmployeeTimeCANResponse result = check client->createEmployeeTimeCAN(payload);
getEmployeeTimeCAN

Retrieves a single EmployeeTimeCAN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeCANQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeCANResponse&#124;error

Sample code:

GetEmployeeTimeCANResponse result = check client->getEmployeeTimeCAN(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeCAN

Updates the EmployeeTimeCAN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeCANPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeCAN(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeCAN

Deletes the EmployeeTimeCAN identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeCANHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeCAN(EmployeeTime_externalCode, externalCode);

TimeManagementTerminationEndHandlingLegalEntityConfiguration​

listTimeManagementTerminationEndHandlingLegalEntityConfigurations

Queries the TimeManagementTerminationEndHandlingLegalEntityConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeManagementTerminationEndHandlingLegalEntityConfigurationsQueriesNoQueries to be sent with the request

Returns: ListTimeManagementTerminationEndHandlingLegalEntityConfigurationsResponse&#124;error

Sample code:

ListTimeManagementTerminationEndHandlingLegalEntityConfigurationsResponse result = check client->listTimeManagementTerminationEndHandlingLegalEntityConfigurations();

Sample response:

{
"d": {}
}
getTimeManagementTerminationEndHandlingLegalEntityConfiguration

Retrieves a single TimeManagementTerminationEndHandlingLegalEntityConfiguration entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeManagementTerminationEndHandlingConfiguration_externalCodestringYeskey: TimeManagementTerminationEndHandlingConfiguration_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeManagementTerminationEndHandlingLegalEntityConfigurationQueriesNoQueries to be sent with the request

Returns: GetTimeManagementTerminationEndHandlingLegalEntityConfigurationResponse&#124;error

Sample code:

GetTimeManagementTerminationEndHandlingLegalEntityConfigurationResponse result = check client->getTimeManagementTerminationEndHandlingLegalEntityConfiguration(TimeManagementTerminationEndHandlingConfiguration_externalCode, externalCode);

EmployeeTimePOL​

listEmployeeTimePOLs

Queries the EmployeeTimePOL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimePOLsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimePOLsResponse&#124;error

Sample code:

ListEmployeeTimePOLsResponse result = check client->listEmployeeTimePOLs();

Sample response:

{
"d": {}
}
createEmployeeTimePOL

Creates a new EmployeeTimePOL entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimePOLYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimePOLResponse&#124;error

Sample code:

CreateEmployeeTimePOLResponse result = check client->createEmployeeTimePOL(payload);
getEmployeeTimePOL

Retrieves a single EmployeeTimePOL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimePOLQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimePOLResponse&#124;error

Sample code:

GetEmployeeTimePOLResponse result = check client->getEmployeeTimePOL(EmployeeTime_externalCode, externalCode);
updateEmployeeTimePOL

Updates the EmployeeTimePOL identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimePOLPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimePOL(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimePOL

Deletes the EmployeeTimePOL identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimePOLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimePOL(EmployeeTime_externalCode, externalCode);

TimeAccountPayout​

listTimeAccountPayouts

Queries the TimeAccountPayout collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountPayoutsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listTimeAccountPayouts();
getTimeAccountPayout

Retrieves a single TimeAccountPayout entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountPayoutQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeAccountPayout(externalCode);
getAccountTypeNavOfTimeAccountPayout

Retrieves a single TimeAccountPayout entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetAccountTypeNavOfTimeAccountPayoutQueriesNoQueries to be sent with the request

Returns: TimeAccountType&#124;error

Sample code:

TimeAccountType result = check client->getAccountTypeNavOfTimeAccountPayout(externalCode);

Sample response:

{
"externalCode": "1000",
"countryExtensionAUS": {
"TimeAccountType_externalCode": "1000",
"externalCode": "1000"
},
"periodicTimeAccountUpdateProfileNav": {
"externalCode": "1000"
},
"recalculationBasedFieldList": {
"results": [
{
"TimeAccountType_externalCode": "1000",
"recalcField": "string"
}
]
},
"timeAccountPayoutProfileNav": {
"externalCode": "1000"
},
"timeAccountPurchaseProfileNav": {
"externalCode": "1000",
"deductionPayComponents": {
"results": []
}
}
}
getTimeAccountDetailNavOfTimeAccountPayout

Retrieves a single TimeAccountPayout entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountDetailNavOfTimeAccountPayoutQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeAccountDetailNavOfTimeAccountPayout(externalCode);
getTimeAccountNavOfTimeAccountPayout

Retrieves a single TimeAccountPayout entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountNavOfTimeAccountPayoutQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getTimeAccountNavOfTimeAccountPayout(externalCode);

TimeAccountPayoutProfile​

listTimeAccountPayoutProfiles

Queries the TimeAccountPayoutProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountPayoutProfilesQueriesNoQueries to be sent with the request

Returns: ListTimeAccountPayoutProfilesResponse&#124;error

Sample code:

ListTimeAccountPayoutProfilesResponse result = check client->listTimeAccountPayoutProfiles();

Sample response:

{
"d": {}
}
getTimeAccountPayoutProfile

Retrieves a single TimeAccountPayoutProfile entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountPayoutProfileQueriesNoQueries to be sent with the request

Returns: GetTimeAccountPayoutProfileResponse&#124;error

Sample code:

GetTimeAccountPayoutProfileResponse result = check client->getTimeAccountPayoutProfile(externalCode);

TimeAccountSummary​

listTimeAccountSummarys

Queries the TimeAccountSummary collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountSummarysQueriesNoQueries to be sent with the request

Returns: ListTimeAccountSummarysResponse&#124;error

Sample code:

ListTimeAccountSummarysResponse result = check client->listTimeAccountSummarys();
getTimeAccountSummary

Retrieves a single TimeAccountSummary entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountSummaryQueriesNoQueries to be sent with the request

Returns: TimeAccountSummary&#124;error

Sample code:

TimeAccountSummary result = check client->getTimeAccountSummary(externalCode);

Sample response:

{
"createdBy": "string",
"createdDateTime": "2026-01-01",
"entityUUID": "1000",
"externalCode": "1000",
"lastModifiedBy": "string",
"lastModifiedDateTime": "2026-01-01",
"mdfSystemRecordStatus": "string"
}

TimeAccountTypeAUS​

listTimeAccountTypeAUSs

Queries the TimeAccountTypeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeAccountTypeAUSsQueriesNoQueries to be sent with the request

Returns: ListTimeAccountTypeAUSsResponse&#124;error

Sample code:

ListTimeAccountTypeAUSsResponse result = check client->listTimeAccountTypeAUSs();

Sample response:

{
"d": {}
}
getTimeAccountTypeAUS

Retrieves a single TimeAccountTypeAUS entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeAccountType_externalCodestringYeskey: TimeAccountType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeAccountTypeAUSQueriesNoQueries to be sent with the request

Returns: GetTimeAccountTypeAUSResponse&#124;error

Sample code:

GetTimeAccountTypeAUSResponse result = check client->getTimeAccountTypeAUS(TimeAccountType_externalCode, externalCode);

PeriodicTimeAccountUpdateProfile​

listPeriodicTimeAccountUpdateProfiles

Queries the PeriodicTimeAccountUpdateProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPeriodicTimeAccountUpdateProfilesQueriesNoQueries to be sent with the request

Returns: ListPeriodicTimeAccountUpdateProfilesResponse&#124;error

Sample code:

ListPeriodicTimeAccountUpdateProfilesResponse result = check client->listPeriodicTimeAccountUpdateProfiles();

Sample response:

{
"d": {}
}
getPeriodicTimeAccountUpdateProfile

Retrieves a single PeriodicTimeAccountUpdateProfile entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPeriodicTimeAccountUpdateProfileQueriesNoQueries to be sent with the request

Returns: GetPeriodicTimeAccountUpdateProfileResponse&#124;error

Sample code:

GetPeriodicTimeAccountUpdateProfileResponse result = check client->getPeriodicTimeAccountUpdateProfile(externalCode);

AvailableTimeType​

listAvailableTimeTypes

Queries the AvailableTimeType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListAvailableTimeTypesQueriesNoQueries to be sent with the request

Returns: ListAvailableTimeTypesResponse&#124;error

Sample code:

ListAvailableTimeTypesResponse result = check client->listAvailableTimeTypes();

Sample response:

{
"d": {}
}
getAvailableTimeType

Retrieves a single AvailableTimeType entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeTypeProfile_externalCodestringYeskey: TimeTypeProfile_externalCode
TimeTypeProfile_mdfSystemEffectiveStartDatestringYeskey: TimeTypeProfile_mdfSystemEffectiveStartDate
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetAvailableTimeTypeQueriesNoQueries to be sent with the request

Returns: GetAvailableTimeTypeResponse&#124;error

Sample code:

GetAvailableTimeTypeResponse result = check client->getAvailableTimeType(TimeTypeProfile_externalCode, TimeTypeProfile_mdfSystemEffectiveStartDate, externalCode);

WorkSchedule​

listWorkSchedules

Queries the WorkSchedule collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkSchedulesQueriesNoQueries to be sent with the request

Returns: ListWorkSchedulesResponse&#124;error

Sample code:

ListWorkSchedulesResponse result = check client->listWorkSchedules();

Sample response:

{
"d": {}
}
createWorkSchedule

Creates a new WorkSchedule entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleResponse&#124;error

Sample code:

CreateWorkScheduleResponse result = check client->createWorkSchedule(payload);
getWorkSchedule

Retrieves a single WorkSchedule entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleResponse&#124;error

Sample code:

GetWorkScheduleResponse result = check client->getWorkSchedule(externalCode);
updateWorkSchedule

Updates the WorkSchedule identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadUpdateWorkSchedulePayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkSchedule(externalCode, payload);
deleteWorkSchedule

Deletes the WorkSchedule identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteWorkScheduleHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkSchedule(externalCode);

EmployeeTimeAUS​

listEmployeeTimeAUSs

Queries the EmployeeTimeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeAUSsQueriesNoQueries to be sent with the request

Returns: ListEmployeeTimeAUSsResponse&#124;error

Sample code:

ListEmployeeTimeAUSsResponse result = check client->listEmployeeTimeAUSs();

Sample response:

{
"d": {}
}
createEmployeeTimeAUS

Creates a new EmployeeTimeAUS entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadEmployeeTimeAUSYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateEmployeeTimeAUSResponse&#124;error

Sample code:

CreateEmployeeTimeAUSResponse result = check client->createEmployeeTimeAUS(payload);
getEmployeeTimeAUS

Retrieves a single EmployeeTimeAUS entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeAUSQueriesNoQueries to be sent with the request

Returns: GetEmployeeTimeAUSResponse&#124;error

Sample code:

GetEmployeeTimeAUSResponse result = check client->getEmployeeTimeAUS(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeAUS

Updates the EmployeeTimeAUS identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
payloadUpdateEmployeeTimeAUSPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateEmployeeTimeAUS(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeAUS

Deletes the EmployeeTimeAUS identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodeintYeskey: externalCode
headersDeleteEmployeeTimeAUSHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTimeAUS(EmployeeTime_externalCode, externalCode);

WorkScheduleDayModelSegment​

listWorkScheduleDayModelSegments

Queries the WorkScheduleDayModelSegment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListWorkScheduleDayModelSegmentsQueriesNoQueries to be sent with the request

Returns: ListWorkScheduleDayModelSegmentsResponse&#124;error

Sample code:

ListWorkScheduleDayModelSegmentsResponse result = check client->listWorkScheduleDayModelSegments();

Sample response:

{
"d": {}
}
createWorkScheduleDayModelSegment

Creates a new WorkScheduleDayModelSegment entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadWorkScheduleDayModelSegmentYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreateWorkScheduleDayModelSegmentResponse&#124;error

Sample code:

CreateWorkScheduleDayModelSegmentResponse result = check client->createWorkScheduleDayModelSegment(payload);
getWorkScheduleDayModelSegment

Retrieves a single WorkScheduleDayModelSegment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModel_externalCodestringYeskey: WorkScheduleDayModel_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetWorkScheduleDayModelSegmentQueriesNoQueries to be sent with the request

Returns: GetWorkScheduleDayModelSegmentResponse&#124;error

Sample code:

GetWorkScheduleDayModelSegmentResponse result = check client->getWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode);
updateWorkScheduleDayModelSegment

Updates the WorkScheduleDayModelSegment identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModel_externalCodestringYeskey: WorkScheduleDayModel_externalCode
externalCodestringYeskey: externalCode
payloadUpdateWorkScheduleDayModelSegmentPayloadYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode, payload);
deleteWorkScheduleDayModelSegment

Deletes the WorkScheduleDayModelSegment identified by its key properties.

Parameters:

NameTypeRequiredDescription
WorkScheduleDayModel_externalCodestringYeskey: WorkScheduleDayModel_externalCode
externalCodestringYeskey: externalCode
headersDeleteWorkScheduleDayModelSegmentHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode);

RecalculationBasedField​

listRecalculationBasedFields

Queries the RecalculationBasedField collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListRecalculationBasedFieldsQueriesNoQueries to be sent with the request

Returns: ListRecalculationBasedFieldsResponse&#124;error

Sample code:

ListRecalculationBasedFieldsResponse result = check client->listRecalculationBasedFields();

Sample response:

{
"d": {}
}
getRecalculationBasedField

Retrieves a single RecalculationBasedField entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeAccountType_externalCodestringYeskey: TimeAccountType_externalCode
recalcFieldstringYeskey: recalcField
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetRecalculationBasedFieldQueriesNoQueries to be sent with the request

Returns: GetRecalculationBasedFieldResponse&#124;error

Sample code:

GetRecalculationBasedFieldResponse result = check client->getRecalculationBasedField(TimeAccountType_externalCode, recalcField);

Holiday​

listHolidays

Queries the Holiday collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListHolidaysQueriesNoQueries to be sent with the request

Returns: ListHolidaysResponse&#124;error

Sample code:

ListHolidaysResponse result = check client->listHolidays();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
getHoliday

Retrieves a single Holiday entity identified by its key property.

Parameters:

NameTypeRequiredDescription
holidayCodestringYeskey: holidayCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetHolidayQueriesNoQueries to be sent with the request

Returns: Holiday&#124;error

Sample code:

Holiday result = check client->getHoliday(holidayCode);

Sample response:

{
"d": {}
}

EmployeeTimeCalendar​

listEmployeeTimeCalendars

Queries the EmployeeTimeCalendar collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimeCalendarsQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimeCalendars();
getEmployeeTimeCalendar

Retrieves a single EmployeeTimeCalendar entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
EmployeeTime_externalCodestringYeskey: EmployeeTime_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeCalendarQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTimeCalendar(EmployeeTime_externalCode, externalCode);

TimeTypeAUS​

listTimeTypeAUSs

Queries the TimeTypeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListTimeTypeAUSsQueriesNoQueries to be sent with the request

Returns: ListTimeTypeAUSsResponse&#124;error

Sample code:

ListTimeTypeAUSsResponse result = check client->listTimeTypeAUSs();

Sample response:

{
"d": {}
}
getTimeTypeAUS

Retrieves a single TimeTypeAUS entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
TimeType_externalCodestringYeskey: TimeType_externalCode
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTimeTypeAUSQueriesNoQueries to be sent with the request

Returns: GetTimeTypeAUSResponse&#124;error

Sample code:

GetTimeTypeAUSResponse result = check client->getTimeTypeAUS(TimeType_externalCode, externalCode);

EmployeeTime​

listEmployeeTimes

Queries the EmployeeTime collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListEmployeeTimesQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->listEmployeeTimes();
getEmployeeTime

Retrieves a single EmployeeTime entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEmployeeTimeQueriesNoQueries to be sent with the request

Returns: json&#124;error

Sample code:

json result = check client->getEmployeeTime(externalCode);
deleteEmployeeTime

Deletes the EmployeeTime identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteEmployeeTimeHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteEmployeeTime(externalCode);