SaaSHR REST API Reference Guide

https://secure7.saashr.com/ta/docs/rest/
Admin
This guide provides comprehensive documentation for the SaaSHR REST API, enabling developers to...
Tokens:4,417
Snippets:27
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Developer Hub API Endpoints

Source: https://secure7.saashr.com/ta/docs/rest/public

This section details the available API endpoints for interacting with the Developer Hub. It covers authentication, company and employee management, data operations, and reporting. Specific HTTP methods (GET, POST, PUT, PATCH, DELETE) are implied for resource operations.

```APIDOC
API Endpoints Overview:

Authentication:
  - Login: Authenticates a user.
  - Login As: Allows logging in as another user.
  - Logout: Terminates the current user session.
  - Refresh Token: Obtains a new access token.

Company Management:
  - Company: Accesses company-specific settings and resources.
    - Employee Types
    - Pay Types
    - Pay Period Profiles
    - Profiles
    - Rate Tables
    - Rate Items
    - Skills
    - Time Offs
    - Holiday Profiles

Employee Management:
  - Employee: Accesses individual employee details and actions.
    - Accrual Balances
    - Contracts
    - Password
    - Time Entry Notes
    - Todo (Todo Count, Todo Action)
    - Work Time Preferences
    - PTO Request (PTO Request, PTO Request Notes)
  - Employees: Manages collections of employees.
    - All Employees: Retrieves a list of all employees.
    - Employee: Specific employee operations.
    - Status: Manages employee status.

Data Operations:
  - All Data Exports: Retrieves a list of all data exports.
  - Data Export: Manages individual data exports.
    - Data Export: Specific data export operations.
    - Status: Manages data export status.
  - All Imports: Retrieves a list of all imports.
  - Import: Manages individual imports.
    - Import: Specific import operations.
    - Status: Manages import status.

Reporting:
  - Reports: Accesses reporting functionalities.
  - Report: Manages specific report types.
    - Global Report
    - Global Report Metadata
    - Saved Report
    - Saved Report Metadata

General API Information:
  - API Specifications: General overview of API structure.
  - Webhooks: Information on event-driven notifications.
  - Authentication and security: Details on securing API access.
  - Version 2 resources and operations: Information on API versioning.
  - Pragmatic REST: Guidelines for RESTful API usage.
  - Limits: Rate limiting and usage constraints.
  - HTTP Headers: Required and optional headers.
  - HTTP Status Codes: Standard response codes.
  - Error handling: How API errors are reported.
  - File Upload/Download: Procedures for handling file transfers.
  - Master Data: Access to core system data.
```

--------------------------------

### System Account APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing system accounts, including locking and security questions.

```APIDOC
System Accounts:
  System Account:
    Lock
      Description: Locks a system account.
    Security Question
      Description: Manages security questions for system accounts.
```

--------------------------------

### Scheduler APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing scheduler settings, workload, and shifts.

```APIDOC
Scheduler:
  Settings
    Description: Manages scheduler configuration settings.
  Workload Manager
    Description: Manages workload distribution and balancing.
  Schedule:
    Actions
      Description: Performs actions on schedules.
    Shifts:
      Shift
        Description: Manages individual shift data.
      Collection
        Description: Manages collections of shifts.
```

--------------------------------

### Payroll Management APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

Comprehensive APIs for managing payroll cycles, including initiation, submission, finalization, and rollback.

```APIDOC
Payrolls:
  Actions:
    Initiate
      Description: Starts the payroll processing cycle.
      Cancel Initiate
        Description: Cancels an ongoing payroll initiation.
    Recalculate
      Description: Recalculates payroll based on updated data.
      Cancel Recalculate
        Description: Cancels an ongoing payroll recalculation.
    Submit
      Description: Submits the payroll for approval or processing.
    Finalize
      Description: Completes the payroll processing.
      Cancel Finalize Payroll
        Description: Cancels a finalized payroll.
    Execute Accruals
      Description: Processes employee accruals.
    Execute Accrual Balances
      Description: Updates employee accrual balances.
    Deliver
      Description: Delivers payroll results to employees or systems.
    Finalyze and Deliver
      Description: Combines finalization and delivery steps.
    Rollback
      Description: Reverts a payroll process.
      Cancel Rollback Payroll
        Description: Cancels an ongoing payroll rollback.
    Reopen
      Description: Reopens a closed payroll cycle.
      Cancel Reopen Payroll
        Description: Cancels an attempt to reopen a payroll.
    Clear error messages
      Description: Clears any error messages associated with payroll processing.
    Close
      Description: Closes the payroll cycle.
      Cancel Closing
        Description: Cancels the closing of a payroll cycle.
    Sync Time
      Description: Synchronizes time data with payroll.
      Cancel Sync Time
        Description: Cancels a time synchronization process.
    Delete Sync Time
      Description: Deletes synchronized time data.
      Cancel Delete Sync Time
        Description: Cancels the deletion of synchronized time data.
  Employees
    Description: Manages employee data related to payroll.
  Multi Pay Statements
    Description: Handles multiple pay statements for employees.
  Payroll:
    Batches:
      /{id}
        Description: Retrieves or manages a specific payroll batch by ID.
    Pay Statements:
      Pay Statement
        Description: Retrieves or manages individual pay statements.
      Pay Statement Mass Delete
        Description: Deletes multiple pay statements in a single operation.
```

--------------------------------

### Project Management APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing projects, including metrics and closing projects.

```APIDOC
Project Management:
  Project:
    Project Metrics
      Description: Retrieves or updates project performance metrics.
    Close Project
      Description: Marks a project as closed.
```

--------------------------------

### Recruitment APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing job requisitions and related questionnaires.

```APIDOC
Recruitment:
  Job Requisitions
    Description: Manages job requisition postings.
  Job Requisition Details
    Description: Retrieves detailed information for job requisitions.
  Job Requisition Questionniare questions
    Description: Manages questions associated with job requisition questionnaires.
```

--------------------------------

### Inventory and Job Management

Source: https://secure7.saashr.com/ta/docs/rest/public

Handles inventory profiles and items, as well as job applications and status tracking.

```APIDOC
Inventory and Jobs:
  - Inventory Profiles
    - Inventory Profile
      - Inventory Items
        - Inventory Item
  - Job Applications
    - Job Application
  - Job Status
```

--------------------------------

### Company Resources

Source: https://secure7.saashr.com/ta/docs/rest/public

Provides access to company-level configurations and data, including access policies, accrual balances, data exports, applicants, asset assignments, attendance, background processing, benefit plans, calendars, compensation, and general configuration settings.

```APIDOC
Company:
  - Access Policy Profiles
  - Accrual Balances Update
  - All Data Export
    - Get Data Export
    - Export
  - Applicants
    - Applicant
      - Applicant Job Applications
    - Batch Upload
  - Asset Assignments
    - Asset Assignment
      - Asset Assignment Action
  - Attendance
  - Background Job Prosessing
    - Job Processing Status
  - Background Screening
    - Order Status
  - Benefit Plans
    - Benefit Plan
    - Benefit Plan List
  - Calendar
    - Anniversary Calendar
    - Birthday Calendar
  - Compensation
    - Additional Compensation
      - Additional Compensation
    - History
      - History
        - Notes
    - Total Compensation
  - Configuration
    - Announcements
      - /{id}
    - Account Groups
      - Account Group
        - Managers
          - Manager
        - Members
          - Member
    - Cost Centers
      - Cost Center
      - Cost Center Action
      - Batch Upload
      - Cost Center Lists
        - List
    - Cost Center Jobs
      - Cost Center Job
```

--------------------------------

### Service Account APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for migrating and managing service accounts.

```APIDOC
Service Accounts:
  Migrate
    Description: Migrates service account data.
  Service Account
    Description: Manages individual service account details.
```

--------------------------------

### Position Management APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing company positions and employee assignments.

```APIDOC
Position Management:
  Position Assignments:
    Position Assignments Changed
      Description: Indicates changes in position assignments.
  Positions:
    Position
      Description: Manages individual position data.
  Company Assignments:
    Account Assignments
      Description: Manages account assignments within company positions.
```

--------------------------------

### Time Entry APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing time entries, including batch updates and notes.

```APIDOC
Time Entries:
  Batch Update
    Description: Updates multiple time entries in a single operation.
  Time Entry
    Description: Manages individual time entry records.
  Time Entry Notes:
    Time Entry Notes
      Description: Manages notes associated with time entries.
```

--------------------------------

### Rate Table APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing rate tables and schedules.

```APIDOC
Rate Tables:
  Rate Table:
    Reapply Rates
      Description: Reapplies rates to relevant entries.
    Rate Schedules:
      Rate Schedule
        Description: Manages specific rate schedules.
      Collection
        Description: Manages collections of rate schedules.
```

--------------------------------

### Vehicle Management APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing vehicle assignments, insurances, and maintenances.

```APIDOC
Vehicle:
  Vehicle Assignments:
    Vehicle Assignment:
      Vehicle Assignment Action
        Description: Performs actions related to vehicle assignments.
  Vehicle Insurances:
    Vehicle Insurance
      Description: Manages vehicle insurance records.
  Vehicle Maintenances:
    Vehicle Maintenance
      Description: Manages vehicle maintenance records.
```

--------------------------------

### Tax APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing company taxes, tax years, and tax quarters.

```APIDOC
Taxes:
  Company Tax Year:
    Company tax year status
      Description: Retrieves the status of a company's tax year.
    Actions:
      Recalculate company taxes
        Description: Recalculates taxes for a company tax year.
      Create Intuit W2 file
        Description: Generates a W2 file for Intuit.
    Company Tax Quarters:
      Company tax quarter status
        Description: Retrieves the status of a company's tax quarter.
```

--------------------------------

### Session OAuth APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs related to session management and OAuth flows.

```APIDOC
Session OAuth:
  Authentication
    Description: Handles user authentication processes.
  Authorization code
    Description: Manages the authorization code used in OAuth flows.
```

--------------------------------

### Timesheet APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing timesheets and their associated actions.

```APIDOC
Timesheets:
  Timesheet:
    Timesheet Action
      Description: Performs actions on a timesheet.
```

--------------------------------

### Pay Period Operations

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing pay periods, including processing records, snapshots, and payroll exports.

```APIDOC
Pay Periods:
  Pay Period:
    Actions:
      Process Records
        Description: Initiates the processing of records for a pay period.
        Returns: Process Records Status.
      Snapshot
        Description: Creates a snapshot of the pay period data.
      Export Payroll
        Description: Exports payroll data for the pay period.
        Returns: Payroll Export Status.
    Lock
      Description: Locks a pay period to prevent further changes.
    Snapshots:
      Snapshot
        Description: Retrieves or manages pay period snapshots.
```

--------------------------------

### Employee and Related Data

Source: https://secure7.saashr.com/ta/docs/rest/public

Encompasses detailed employee information, assignments, direct deposits, documents, and time-related data. Includes management of employee primary assignments, schedules, and various HR-specific fields.

```APIDOC
Employee Data:
  - Contacts
    - Contact
  - Contracts
  - Counter Adjustments
    - Counter Adjustment Notes
  - Dashboard Widget API
  - Data Delivery
    - DataView
    - Metadata
  - Dimensions HCM
    - HCM Application Details Widget
    - HCM System Details Widget
  - HR Action Audit Requests
    - HR Action Audit Request
  - Direct Deposits
    - Mass Update Actions
      - Mass Edit
    - Cancel Pre Note
    - Direct Deposit
  - Document Storage
    - Delete multiple documents
    - Document
      - Document Preview
  - Employee
    - Schedules
  - Employee Primary Assignment
  - Employees
    - Current employee
      - My Currency
    - Changed employees
    - Employee
      - Accrual Balances
      - Accrual Balances
      - Announcements
        - Announcement statistics
        - Announcement
          - Disable Popup
      - Attendance
      - Badges
      - Benefit Plans
      - Compensation
        - Additional Compensation
        - History
        - Total Compensation
      - Contacts
      - Counter adjustments
        - Counter adjustment
      - Credentials
      - Deductions
        - /{id}
      - Demographics
      - Direct Deposits
      - Employee Currency
      - Employee Documents
      - Forms
        - Custom
        - Pay
        - System
      - Holidays
      - HR Custom Fields
      - Leave Of Absence
        - Cases
        - Counters
        - Requests
      - Managed Cost Centers
        - Managed Cost Center
      - Manager Replacements
      - Notifications
        - Mailbox items
        - To-Do items
      - Overtime Requests
      - Password Policy
      - Pay Information
      - Profiles
      - Recent Punches
      - Tax Information
      - Time Entries
      - Timesheets
      - Time Off Calendar Sync
      - Training and Certifications
      - Skills
      - VCA Report Dialogs Settings
```

--------------------------------

### PTO Request APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for managing Paid Time Off (PTO) requests.

```APIDOC
PTO Request:
  PTO Request
    Description: Manages individual PTO requests.
  All PTO Requests
    Description: Retrieves or manages all PTO requests.
  PTO Request Notes
    Description: Manages notes associated with PTO requests.
```

--------------------------------

### OAuth Application Management

Source: https://secure7.saashr.com/ta/docs/rest/public

Manages OAuth applications, including revoking access for specific applications.

```APIDOC
OAuth Applications:
  OAuth Application:
    Revoke OAuth application.
      Description: Revokes all tokens associated with a specific OAuth application.
      Parameters: application_id
      Returns: Success or error message.
```

--------------------------------

### OAuth 2.0 API Authorization Endpoints

Source: https://secure7.saashr.com/ta/docs/rest/public

Provides endpoints for OAuth 2.0 authorization flows, including token introspection, revocation, and user information retrieval.

```APIDOC
OAuth 2.0 API Authorization:
  Authorize
    Description: Initiates the OAuth 2.0 authorization code grant flow.
    Parameters: client_id, redirect_uri, response_type, scope, state
    Returns: Authorization code or error.

  Introspect
    Description: Validates an access token.
    Parameters: token (access token)
    Returns: Token introspection response (active status, expiration, etc.).

  Logout
    Description: Ends the user's session and revokes tokens.
    Parameters: token_hint (optional)
    Returns: Success or error message.

  OpenID Configuration
    Description: Retrieves the OpenID Connect discovery document.
    Returns: JSON document with configuration details.

  Revoke
    Description: Revokes an access or refresh token.
    Parameters: token, token_type_hint (optional)
    Returns: Success or error message.

  Token
    Description: Exchanges an authorization code for an access token or refreshes an existing token.
    Parameters: grant_type, code (for authorization code grant), redirect_uri, client_id, refresh_token (for refresh token grant)
    Returns: Access token, refresh token, expiration, scope.

  Userinfo
    Description: Retrieves information about the authenticated user.
    Requires: Valid access token.
    Returns: User profile information.
```

--------------------------------

### Expense Tracking and Forms

Source: https://secure7.saashr.com/ta/docs/rest/public

Manages expense reports, items, and types, including creation, updates, and retrieval of expense data. Also covers custom and system forms.

```APIDOC
Expense and Forms:
  - Expense Tracking
    - New Expense Report
    - Expense Report Metadata
    - Expense Type Metadata
    - Expense Report
      - Expense Item
        - Get/Update/Delete Expense Item
    - Expense Item Summaries
    - Expense Reports
  - Forms
    - Custom
    - System
```

--------------------------------

### Scheduled Earnings APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for mass adding, editing, or deleting scheduled earnings.

```APIDOC
Scheduled Earnings:
  Scheduled Earning Mass Add, Edit, or Delete
    Description: Performs bulk operations on scheduled earnings.
```

--------------------------------

### Webhook Event Ingestion API

Source: https://secure7.saashr.com/ta/docs/rest/public

API for ingesting webhook events.

```APIDOC
Webhook event ingestion:
  Description: Receives and processes incoming webhook events.
```

--------------------------------

### External Pay Statements

Source: https://secure7.saashr.com/ta/docs/rest/public

Provides access to external pay statements for employees.

```APIDOC
External Pay Statements:
  - External PayStatements
```

--------------------------------

### Scheduled Deductions APIs

Source: https://secure7.saashr.com/ta/docs/rest/public

APIs for mass adding, editing, or deleting scheduled deductions.

```APIDOC
Scheduled Deductions:
  Scheduled Deduction Mass Add, Edit, or Delete
    Description: Performs bulk operations on scheduled deductions.
```

--------------------------------

### Leave of Absence and Lookup Data

Source: https://secure7.saashr.com/ta/docs/rest/public

Manages leave of absence cases and requests, including associated notes. Provides access to a comprehensive list of lookup data for various HR entities.

```APIDOC
Leave of Absence and Lookups:
  - Leave Of Absence
    - Cases
      - Case
        - Notes
          - Note
    - Requests
      - Request
        - Notes
          - Note
  - Lookup
    - Additional Compensation Types
    - Assets
    - Asset Categories
    - Asset Types
    - Benefit Types
    - Benefit Plans
    - Data Export types
    - Company or Account Groups
    - Deduction Codes
    - Document Types
    - Degrees
    - Earning Codes
    - Education Levels
    - EINs
    - Employee Types
    - First Screens
    - Hiring Stages
    - Jobs
    - Job Application Status
    - Credential Types
    - Interview Names
    - Interview Locations
    - Job Categories
    - Job Change Reasons
    - Job Requisition
      - Job Requisition Categories
      - Job Requisition Locations
    - Eye Color
    - LOA Reasons
    - Locales
    - Manual Counters
    - Object Lists
    - Overtime Reasons
    - Pay Categories
    - Pay Calculation Profiles
    - Pay Grades
    - Pay period profiles
    - Pay Statement Types
    - Pay Types
    - Payroll Batch Types
    - Payroll Types
    - Profiles
      - Accruals
      - Accruals(1.0)
      - Attestations
      - Counter Distribution Profiles
      - Data Retention Profiles
      - Delivery Policies
      - Demographic Profiles
      - Device Access
      - Employee Perspectives Profiles
      - Holiday Profiles
      - Leave of Absence Profiles
      - Pay Calculation Profiles
      - Pay Calculation 2.0 Profiles
      - Pay Grades
      - Pay Period Profiles
      - Pay Prep Profiles
      - Performance Review
```
Tokens:
Raw