App |  |
Contracts are broken out into a separate namespace as they tend to denote the pure class or entity of the underlying object that is reflected in the data store. These classes represent the data entities themselves that are passed between services.
Classes| Class | Description | |
|---|---|---|
  | AddHolidayListModel | This class is the model for Adding HolidayList information |
| AddLaborLevelDetailModel | This class is the model for adding labor-level-detail information |
| AddPayrollPayAdjustModel | This class is the model for payroll pay adjustments |
| AddPayrollPayTypeModel | This class is the model for payroll pay types |
| AddUserCustomField | **BETA** A structure that contains custom fields that are assigned to a user. |
| AddUserDetailModel | **BETA** This class is the model for adding the core meta data for a given user in the system |
| AddUserHomeLaborLevelDetails | This class is the model for adding and updating the home or default labor levels that are assigned to a user |
| AddUserLaborLevelModel | This class is the model for adding and updating a users assigned labor-level-detail information |
| AddUserPayAdjustModel | This class is the model for adding user pay adjustment information |
| AddUserProfile | **BETA** A structure that contains all the data of a users meta data profile. |
| AddUserScheduleDetailModel | This class is the model for adding user schedules details. |
| AddUserScheduleModel | This class is the model for adding user schedule information |
| AddUserTimeNonWorkShiftModel | This class is the model for adding a non-work time punch transaction |
| AddUserTimeOffRequestModel | This class is the model for adding user time-off requests |
| CreateTokenIn | This class is the model for retrieving a special token used for authentication for all web service requests |
| DeleteHolidayListModel | This class is the model for Deleting HolidayList information |
| GetCustomerConfigModel | This class is the model for retrieving the core meta data for a given customer account |
| GetCustomFieldModel | This class is the model for retrieving CustomField information |
| GetHolidayListModel | This class is the model for Viewing HolidayList information |
| GetLaborLevelDetailModel | This class is the model for retrieving labor-level-detail information |
| GetLaborLevelModel | This class is the model for retrieving labor level information |
| GetPayrollPayAdjustModel | This class is the model for payroll pay adjustments |
| GetPayrollPayTypeModel | This class is the model for getting payroll pay types |
| GetPayrollPoliciesModel | This class is the model for payroll policies |
| GetPunchPromptsModel | This is the class for retriving user punch prompts for each User |
| GetSSOLinkModel | This class is the model for retrieving single sign on (SSO) URLs |
| GetTimeOffPolicyDetailModel | This class is the model for retrieving TimeOffPolicyDetail information |
| GetTimeOffPolicyDetailRuleModel | This class is the model for retrieving TimeOffPolicyDetailRule information |
| GetTimeOffPolicyModel | This class is the model for retrieving TimeOffPolicy information |
| GetTimePunchStateModel | This class is the model for retrieving a user’s available punch type statues |
| GetTokenModel | This class is the model for validating and renewing token data |
| GetUserBasicModel | This class is the model for retrieving UserBasic information |
| GetUserDetailModel | This class is the model for retrieving the core meta data for a given user in the system |
| GetUserGroupsModel | **BETA** This class is the model for retrieving UserGroups information |
| GetUserIPAccessModel | This class is the model for retrieving user IP restriction access policy information |
| GetUserLaborLevelModel | This class is the model for retrieving user labor-level-detail information |
| GetUserPayAdjustModel | This class is the model for retrieving user pay adjustments. |
| GetUserScheduleDetailModel | This class is the model for retrieving user schedules details. |
| GetUserScheduleModel | This class is the model for retrieving user schedules. |
| GetUserTimeOffBalanceModel | This class is the model for retrieving user time off balance information |
| GetUserTimeOffRequestDetailModel | This class is the model for retrieving user time-off request detail data. |
| GetUserTimeOffRequestModel | This class is the model for retrieving user time-off request data. |
| GetUserTimeOnStatusBoardModel | This class is the model for retrieving a user’s available punch type statues |
| HolidayListDetailModel | This class is the model for HolidayListDetail Records. |
| PunchInformation | An object which represents the data necessary to find an existing punch in the system which will be updated. |
| PunchPromptDefinedAnswerModel | This class is the model for retriving the punch prompt defined answers for the questions |
| PunchPromptModel | This Class is the model for retriving punch prompts questions and answers |
| TimeSlicePreModel | TimeSlicePreModel represents the basic model for time slice information object |
| UpdateHolidayListModel | This class is the model for Updating HolidayList information |
| UpdateLaborLevelDetailModel | A model used to update labor-level-details |
| UpdatePayrollPayTypeModel | This class is the model for updating payroll pay types |
| UpdateTimeOffRequestModel | **SCHEMA** A model used to update user time-off request data |
| UpdateUserCustomField | **BETA** A structure that contains custom fields that are assigned to a user. |
| UpdateUserDetailModel | **BETA** This class is the model for adding the core meta data for a given user in the system |
| UpdateUserHomeLaborLevelDetails | This class is the model for adding and updating the home or default labor levels that are assigned to a user |
| UpdateUserLaborLevelModel | This class is the model for updating a users assigned labor-level-detail information |
| UpdateUserPayAdjustModel | A model used to update user pay adjustments |
| UpdateUserProfile | **BETA** A structure that contains all the data of a users meta data profile. |
| UpdateUserScheduleDetailModel | This class is the model for updating user schedules details. |
| UpdateUserScheduleModel | A model used to update user schedules |
| UpdateUserTimeApprovalModel | This class is the model for adding a user time approval |
| UpdateUserTimePunchObject | An object representing a single punch and the updates that should be made to it. |
| UpdateUserTimePunchResult | A data structure used to represent the status of a single punch update |
| UserHomeLaborLevelDetails | This class is the model for retrieving the home or default labor levels that are assigned to a user |
| UserLoginModel | This class is the model for retrieving UserInfoLoginDetail information |
Structures| Structure | Description | |
|---|---|---|
 | AddHolidayListDetailIn | A structure used to add a list of HolidayListDetailModel models |
| AddHolidayListDetailOut | Returns a list of AddResult structures representing the response from a call to the AddHolidayListDetail(AddHolidayListDetailIn) endpoint |
| AddHolidayListIn | A structure used to add a list of AddHolidayListModel models |
| AddHolidayListOut | Returns a list of AddResult structures representing the response from a call to the AddHolidayList(AddHolidayListIn) endpoint |
| AddLaborLevelDetailCustomField | A structure that represents the custom field for adding custom field values to a specific labor-level-detail |
| AddLaborLevelDetailIn | Create a new AddLaborLevelDetailModel |
| AddLaborLevelDetailOut | A model used to represent the results of a returned labor-level-detail output |
| AddPayrollPayAdjustIn | A structure used to add a list of AddPayrollPayAdjustModel |
| AddPayrollPayAdjustOut | A structure that returns a result list of AddPayrollPayAdjustModel |
| AddPayrollPayTypeIn | A structure used to add a list of AddPayrollPayTypeModel |
| AddPayrollPayTypeOut | A structure that returns a result list of AddPayrollPayTypeModel |
| AddUserAccess | **BETA** A structure that contains a users access or permissions meta data. |
| AddUserAssignedLaborLevelDetails | A structure that represents the labor levels that are assigned to a given user. |
| AddUserDetailIn | **BETA** Adds the payload data for a list of AddUserDetailModel |
| AddUserDetailOut | **BETA** Returns the result statues of add operation |
| AddUserLaborLevelIn | A structure used to add a list of AddUserLaborLevelModel |
| AddUserLaborLevelOut | A structure that returns a result list of AddUserLaborLevelResult |
| AddUserLaborLevelResult | A structure that returns a result list of AddResult for both assigned and home labor level details |
| AddUserPayAdjustIn | Adds the payload data for a list of AddUserPayAdjustModel |
| AddUserPayAdjustOut | Returns the result statues of add operation |
| AddUserScheduleDetailIn | Adds the payload data for a list of AddUserScheduleDetailModel |
| AddUserScheduleDetailOut | Returns the result statues of add operation |
| AddUserScheduleIn | Adds the payload data for a list of AddUserScheduleModel |
| AddUserScheduleOut | Returns the result statues of add operation |
| AddUserTimeNonWorkShiftIn | A structure used to add a list of AddUserTimeNonWorkShiftModel |
| AddUserTimeNonWorkShiftOut | A structure that returns a result list of AddResult |
| AddUserTimeOffRequestIn | Adds the payload data for a list of AddUserTimeOffRequestModel |
| AddUserTimeOffRequestOut | Returns the result statues of add operation |
| CustomerCompanyInfo | A structure that contains all the customer data profile. |
| CustomerGeneralSettings | A structure that contains all the customer general settings meta data |
| CustomerGlobalSettings | A structure that contains all the customer global settings meta data |
| DeleteHolidayListDetailIn | A structure sent to the DeleteHolidayListDetail(DeleteHolidayListDetailIn) endpoint to Delete a list of HolidayList objects. |
| DeleteHolidayListDetailOut | Returns the result statues of a delete operation |
| DeleteHolidayListIn | A structure sent to the DeleteHolidayList(DeleteHolidayListIn) endpoint to Delete a list of HolidayList objects. |
| DeleteHolidayListOut | Returns a list of DeleteResult structures representing the response from a call to the DeleteHolidayList(DeleteHolidayListIn) endpoint |
| DeleteLaborLevelDetailIn | Deletes a labor level detail |
| DeleteLaborLevelDetailOut | Delete a labor level detail |
| DeletePayrollPayTypeIn | The input params for deleting a payroll pay-type |
| DeletePayrollPayTypeOut | The output params for deleting a payroll pay-type |
| DeleteTimeOffRequestIn | **SCHEMA** Deletes a list of user time-off requests by its ID |
| DeleteTimeOffRequestOut | **SCHEMA** Returns the result statues of a delete operation |
| DeleteUserIn | Deletes a list of user(s) by employee ID |
| DeleteUserLaborLevelIn | Deletes a user labor level detail |
| DeleteUserLaborLevelOut | Delete a labor level detail assignment |
| DeleteUserOut | Returns the result statues of a delete operation for a given list of users |
| DeleteUserPayAdjustIn | Deletes a list of user pay adjustments by its ID |
| DeleteUserPayAdjustOut | Returns the result statues of a delete operation |
| DeleteUserScheduleDetailIn | Deletes a list of user schedules by its ID |
| DeleteUserScheduleDetailOut | Returns the result statues of a delete operation |
| DeleteUserScheduleIn | Deletes a list of user schedules by its ID |
| DeleteUserScheduleOut | Returns the result statues of a delete operation |
| GetCustomerConfigIn | A structure used to get a list of GetCustomerConfigModel |
| GetCustomerConfigOut | A structure that returns a result list of GetCustomerConfigModel |
| GetCustomFieldIn | A structure used to get a list of GetCustomFieldModel |
| GetCustomFieldOut | A structure that returns a result list of GetCustomFieldModel |
| GetHolidayListDetailIn | A structure used to request a list of HolidayListDetailModel models via the GetHolidayListDetail(GetHolidayListDetailIn) endpoint |
| GetHolidayListDetailOut | A structure that returns a result list of HolidayListDetailModel models |
| GetHolidayListIn | A structure used to get a list of GetHolidayListModel models. |
| GetHolidayListOut | A structure that returns a result list of GetHolidayListModel models |
| GetLaborLevelDetailIn | A structure used to get a list of GetLaborLevelDetailModel |
| GetLaborLevelDetailOut | A structure that returns a result list of GetLaborLevelDetailModel |
| GetLaborLevelIn | A structure used to get a list of GetLaborLevelModel |
| GetLaborLevelOut | A structure that returns a result list of GetLaborLevelModel |
| GetPayrollPayAdjustIn | A structure used to get a list of GetPayrollPayAdjustModel |
| GetPayrollPayAdjustOut | A structure that returns a result list of GetPayrollPayAdjustModel |
| GetPayrollPayTypeIn | A structure used to get a list of GetPayrollPayTypeModel |
| GetPayrollPayTypeOut | A structure that returns a result list of GetPayrollPayTypeModel |
| GetPayrollPoliciesGeneral | A structure that has the general settings of a payroll policy |
| GetPayrollPoliciesIn | A structure used to get a list of GetPayrollPoliciesModel |
| GetPayrollPoliciesOut | A structure that returns a result list of GetPayrollPoliciesModel |
| GetPunchPromptsIn | |
| GetPunchPromptsOut | |
| GetSSOEnabledIn | A structure used to get a list of GetSSOEnabledOut |
| GetSSOEnabledOut | A structure used to return the status of GetSSOEnabled(GetSSOEnabledIn) |
| GetSSOLinkIn | A structure used to get a list of GetSSOLinkModel |
| GetSSOLinkOut | A structure used to get a list of GetSSOLinkModel |
| GetTimeOffPolicyDetailIn | A structure used to get a list of GetTimeOffPolicyDetailModel |
| GetTimeOffPolicyDetailOut | A structure that returns a result list of GetTimeOffPolicyDetailModel |
| GetTimeOffPolicyDetailRuleIn | A structure used to get a list of GetTimeOffPolicyDetailRuleModel |
| GetTimeOffPolicyDetailRuleOut | A structure that returns a result list of GetTimeOffPolicyDetailRuleModel |
| GetTimeOffPolicyIn | A structure used to get a list of GetTimeOffPolicyModel |
| GetTimeOffPolicyOut | A structure that returns a result list of GetTimeOffPolicyModel |
| GetTimePunchStateIn | A structure used to get a list of GetTimePunchStateModel |
| GetTimePunchStateOut | A structure that returns a result list of GetTimePunchStateModel |
| GetTokenIn | A structure used to get a GetTokenModel |
| GetTokenOut | A structure that returns a result of GetSSOLinkModel |
| GetUserBasicIn | A structure used to get a list of GetUserBasicModel |
| GetUserBasicOut | A structure that returns a result list of GetUserBasicModel |
| GetUserDetailIn | A structure used to get a list of GetUserDetailModel |
| GetUserDetailOut | A structure that returns a result list of GetUserDetailModel |
| GetUserGroupsIn | **BETA** A structure used to get a list of GetUserGroupsModel |
| GetUserGroupsOut | **BETA** A structure that returns a result list of GetUserGroupsModel |
| GetUserIPAccessIn | A structure used to get a list of GetUserIPAccessModel |
| GetUserIPAccessOut | A structure that returns a result list of GetUserIPAccessModel |
| GetUserLaborLevelIn | A structure used to get a list of GetUserLaborLevelModel |
| GetUserLaborLevelOut | A structure that returns a result list of GetUserLaborLevelModel |
| GetUserLoginIn | A structure used to get a list of UserLoginModel |
| GetUserLoginOut | A structure that returns a result list of UserLoginModel |
| GetUserPayAdjustIn | A structure used to get a list of GetUserPayAdjustModel |
| GetUserPayAdjustOut | A structure that returns a result list of GetUserPayAdjustModel |
| GetUserScheduleIn | A structure used to get a list of GetUserScheduleModel |
| GetUserScheduleOut | A structure that returns a result list of GetUserScheduleModel |
| GetUserTimeOffBalanceIn | A structure used to get a list of GetUserTimeOffBalanceModel |
| GetUserTimeOffBalanceOut | A structure that returns a result list of GetUserTimeOffBalanceModel |
| GetUserTimeOffRequestIn | A structure used to get a list of GetUserTimeOffRequestModel |
| GetUserTimeOffRequestOut | A structure that returns a result list of GetUserTimeOffRequestModel |
| GetUserTimeOnStatusBoardIn | A structure used to get a list of GetUserTimeOnStatusBoardModel |
| GetUserTimeOnStatusBoardOut | A structure that returns a result list of GetUserTimeOnStatusBoardModel |
| LaborLevelCustomField | A structure represents the custom field for the labor-level-detail |
| MealRestriction | A structure that contains all Enforce meal details of the user |
| ScheduleEnforcements | A structure that contains all Enforce Schedule Details of the User |
| UpdateHolidayListIn | A structure used to add Update HolidayList items using a list of UpdateHolidayListModel models |
| UpdateHolidayListOut | Returns a list of UpdateResult structures representing the response from a call to the UpdateHolidayList(UpdateHolidayListIn) endpoint |
| UpdateLaborLevelDetailIn | The input model used to ad UpdateLaborLevelDetailModel |
| UpdateLaborLevelDetailOut | A model used to represent the results of a returned labor-level-detail output |
| UpdatePayrollPayTypeIn | The input model used to udpate an UpdatePayrollPayTypeModel |
| UpdatePayrollPayTypeOut | A structure that returns a result list of UpdatePayrollPayTypeModel |
| UpdateTimeOffRequestIn | **SCHEMA** Create a new AddUserTimeOffRequestModel |
| UpdateTimeOffRequestOut | **SCHEMA** A model used to represent the results of a returned labor-level-detail output |
| UpdateUserAccess | **BETA** A structure that contains a users access or permissions meta data. |
| UpdateUserAssignedLaborLevelDetails | A structure that represents the labor levels that are assigned to a given user. |
| UpdateUserAssignedLaborLevelDetailsChargeRate | A structure that represents the labor levels details charge rate that are assigned to a given user. |
| UpdateUserAssignedLaborLevelDetailsPayRate | A structure that represents the labor levels details pay rate that are assigned to a given user. |
| UpdateUserDetailIn | **BETA** Updates the payload data for a list of UpdateUserDetailModel |
| UpdateUserDetailOut | **BETA** Returns the result statues of add operation |
| UpdateUserLaborLevelIn | A structure used to add a list of UpdateUserLaborLevelModel |
| UpdateUserLaborLevelOut | A structure that returns a result list of UpdateUserLaborLevelResult |
| UpdateUserLaborLevelResult | A structure that returns a result list of AddResult for both assigned and home labor level details |
| UpdateUserPayAdjustIn | Update an existing UpdateUserPayAdjustModel |
| UpdateUserPayAdjustOut | A model used to represent the results of a returned labor-level-detail output |
| UpdateUserScheduleDetailIn | Updates a new UpdateUserScheduleDetailModel |
| UpdateUserScheduleDetailOut | A model used to represent the results of a returned labor-level-detail output |
| UpdateUserScheduleIn | Update an existing UpdateUserScheduleModel |
| UpdateUserScheduleOut | Return the results for updating an existing UpdateUserScheduleModel |
| UpdateUserTimeApprovalIn | A structure used to add a list of UpdateUserTimeApprovalModel |
| UpdateUserTimeApprovalOut | A structure that returns a result list of AddUserLaborLevelResult |
| UpdateUserTimePunchIn | A data structure representing the input sent to the web service to update between 1 and 50 records at a time. |
| UpdateUserTimePunchOut | A data structure representing the response returned from the API upon completing an Update request. |
| UserAccess | A structure that contains a users access or permissions meta data. |
| UserAccruals | A structure that contains a users time off or accruals meta data. |
| UserAssignedLaborLevelDetails | A structure that represents the labor levels that are assigned to a given user. |
| UserAssignedLaborLevelDetailsChargeRateHistory | A structure that represents the labor levels details charge rate that are assigned to a given user. |
| UserAssignedLaborLevelDetailsPayRateHistory | A structure that represents the labor levels details pay rate that are assigned to a given user. |
| UserCustomField | A structure that contains custom fields that are assigned to a user. |
| UserHierarchyLaborLevelDetails | A structurer that represents the labor levels that are assigned to a given user by labor level hierarchy. |
| UserIPAccessList | A structure that represents a users IP access search range |
| UserIPAccessPolicyDetail | A structure that represents an IP access policy detail |
| UserPolicies | A structure that contains all assigned to a users policy assignments. |
| UserPolicyGroups | A structure that contains the policy groups that an employee belongs to/in. |
| UserProfile | A structure that contains all the data of a users meta data profile. |
| UserRates | A structure that contains all the data assigned to a user pay rates meta data profile. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | CustomFieldTypes | Represents the custom field type enums that belong to custom fields |
| LaborLevelCutomFieldTypes | Represents the custom field types for labor-levels |
| RequestStatus | An enumeration of the different statuses that can be returned indicating the overall status of the entire request. |
| UpdateStatus | An enumeration of the different statuses that can be returned for a given update request |