Saashr Developer Hub

https://secure7.saashr.com/ta/docs/rest/public
Admin
The Saashr Developer Hub provides REST API documentation for integrating with Saashr's human capital...
Tokens:5,168
Snippets:41
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Webhooks API

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

Documentation for Webhooks, including a user guide and a catalog of available webhook events.

```APIDOC
WEBHOOKS:
  Webhooks User Guide:
    - Provides instructions on how to use and configure webhooks.
  Webhooks Events Catalog:
    - Lists all available events that can trigger webhooks.
```

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

### API Best Practices

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

Guidelines and recommendations for effectively using the API, ensuring efficient and robust integration.

```APIDOC
Best Practices:
  - Best Practices
```

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

### API Specifications Overview

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

This section outlines the general structure and principles of the API. It provides foundational information necessary for understanding how to interact with the Developer Hub's services.

```APIDOC
API Specifications:
  - Foundations
  - Client id and secret
  - Deprecation and Versioning
  - Pragmatic REST
  - Limits
  - HTTP Headers
  - HTTP Status Codes
  - Error handling
  - File Upload/Download
  - Master Data
```

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

### API Versioning and Resources

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

Details on API versioning strategies and access to V1 resources.

```APIDOC
API Versioning:
  - Version 2 resources and operations
  - V1 Resources:
    - Login
    - Login As
    - Logout
    - Refresh Token
    - Web Clock
    - Company
    - Employee
    - Employees
    - All Data Exports
    - Data Export
    - All Imports
    - Import
    - Reports
    - Report
```

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

### Service Account and System Account Management API

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

API for migrating service accounts and managing system accounts, including locking and security question settings.

```APIDOC
Service Accounts:
  Migrate:
    - Migrates service account data.
  Service Account:
    - Manages individual service account records.
```

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

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

### Scheduler API

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

API for managing scheduler settings, workload, and shifts. Includes actions for shifts and collections of shifts.

```APIDOC
Scheduler:
  Settings:
    - Manages scheduler configuration settings.
  Workload Manager:
    - Manages workload distribution and monitoring.
  Schedule:
    Actions:
      - Performs actions on schedules.
    Shifts:
      Shift:
        - Manages individual shift records.
      Collection:
        - Manages a collection of shifts.
```

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

### Recruitment API

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

API for managing recruitment processes, including job requisitions, details, and associated questionnaires.

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

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

### Background Screening and Benefit Plans API Endpoints

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

This section details API endpoints for managing background screening order statuses and retrieving information about benefit plans. It supports integration with external screening services and access to employee benefit configurations.

```APIDOC
Background Screening:
  - Order Status
Benefit Plans:
  - Benefit Plan
  - Benefit Plan List
```

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

### Applicant and Job Application API Endpoints

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

This section covers API endpoints for managing applicants and their job applications within the system. It includes functionalities for individual applicant details, their associated job applications, and batch upload capabilities for applicant data.

```APIDOC
Applicants:
  - Applicant:
    * Applicant Job Applications
  - Batch Upload
Job Applications:
  - Job Application
Job Status
```

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

### Authentication and Security

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

Details the methods for authenticating and securing API requests. This includes information on obtaining and using client credentials and managing sessions.

```APIDOC
Authentication:
  - Authentication and security
  - Client id and secret
  - Login
  - Login As
  - Logout
  - Refresh Token
```

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

### Rate Table Management API

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

No description

```APIDOC
Rate Tables:
  Rate Table:
    Reapply Rates:
      - Reapplies rates to relevant records.
    Rate Schedules:
      Rate Schedule:
        - Manages individual rate schedules.
      Collection:
        - Manages a collection of rate schedules.
```

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

### Position and Employee Assignment API

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

API for managing position assignments, positions, and company assignments, including account assignments.

```APIDOC
Position Management:
  Position Assignments:
    Position Assignments Changed:
      - Indicates changes in position assignments.
  Positions:
    Position:
      - Manages individual position records.
  Company Assignments:
    Account Assignments:
      - Manages account assignments within companies.
```

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

### Time Entry and Timesheet API

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

API endpoints for managing time entries and timesheets, including batch updates, individual time entry management, and timesheet actions.

```APIDOC
Time Entries:
  Batch Update:
    - Updates multiple time entries in a single request.
  Time Entry:
    - Manages individual time entry records (create, read, update, delete).
  Time Entry Notes:
    Time Entry Notes:
      - Manages notes associated with time entries.
```

```APIDOC
Timesheets:
  Timesheet:
    Timesheet Action:
      - Performs actions on a timesheet, such as submission or approval.
```

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

### Asset Management API Endpoints

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

This section provides API access for managing asset assignments to employees. It includes endpoints for individual asset assignments and actions related to these assignments, facilitating tracking and management of company assets.

```APIDOC
Asset Assignments:
  - Asset Assignment:
    * Asset Assignment Action
```

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

### Payroll Processing API

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

Comprehensive API for payroll processing, including initiating, recalculating, submitting, finalizing, and rolling back payroll runs. Supports accrual execution and delivery of payroll.

```APIDOC
Payrolls:
  Actions:
    Initiate:
      - Initiates a new payroll run.
      - Cancel Initiate:
        - Cancels an ongoing payroll initiation.
    Recalculate:
      - Recalculates payroll for selected employees or periods.
      - Cancel Recalculate:
        - Cancels an ongoing payroll recalculation.
    Submit:
      - Submits the payroll for approval or further processing.
    Finalize:
      - Finalizes the payroll run, making it ready for distribution.
      - Cancel Finalize Payroll:
        - Cancels the finalization of a payroll run.
    Execute Accruals:
      - Executes accrual calculations for employees.
    Execute Accrual Balances:
      - Updates or retrieves accrual balances.
    Deliver:
      - Delivers payroll information or payments.
    Finalize and Deliver:
      - Combines finalization and delivery steps.
    Rollback:
      - Reverts a finalized payroll run.
      - Cancel Rollback Payroll:
        - Cancels an ongoing payroll rollback.
    Reopen:
      - Reopens a closed or finalized payroll run.
      - Cancel Reopen Payroll:
        - Cancels an ongoing payroll reopening.
    Clear error messages:
      - Clears any error messages associated with a payroll run.
    Close:
      - Closes the payroll period or run.
      - Cancel Closing:
        - Cancels the closing of a payroll run.
    Sync Time:
      - Synchronizes time-related data for payroll.
      - Cancel Sync Time:
        - Cancels an ongoing time synchronization.
    Delete Sync Time:
      - Deletes synchronized time data.
      - Cancel Delete Sync Time:
        - Cancels the deletion of synchronized time data.
  Employees:
    - Retrieves employee-specific payroll information.
  Multi Pay Statements:
    - Manages or retrieves multiple pay statements.
  Payroll:
    Batches:
      /{id}:
        - Retrieves or manages a specific payroll batch by ID.
    Pay Statements:
      Pay Statement:
        - Retrieves or manages a specific pay statement.
      Pay Statement Mass Delete:
        - Performs a mass deletion of pay statements.
```

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

### Employee Management API Endpoints

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

This comprehensive section provides API access to various aspects of employee management, including schedules, primary assignments, and detailed employee profiles. It covers a wide range of employee data from compensation and benefits to time-off and credentials.

```APIDOC
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
```

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

### Counter Adjustments and Dashboard Widget API

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

This section details API endpoints for managing counter adjustments and accessing data for dashboard widgets. It includes functionalities for adding notes to counter adjustments and retrieving data for system dashboards.

```APIDOC
Counter Adjustments:
  - Counter Adjustment Notes
Dashboard Widget API
```

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

### Company Resource Management

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

Provides endpoints for managing company-specific data and configurations. This includes details on employee types, pay structures, and profile settings.

```APIDOC
Company Resources:
  - Company:
    - Employee Types
    - Pay Types
    - Pay Period Profiles
    - Profiles
    - Rate Tables
    - Rate Items
    - Skills
    - Time Offs
    - Holiday Profiles
```

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

### Taxes API

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

API for managing company tax information, including tax year status, recalculations, and W2 file generation. Also covers company tax quarters.

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

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

### Data Import and Export

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

Details the API endpoints for managing data import and export operations. This includes initiating exports, tracking their status, and managing import processes.

```APIDOC
Data Management:
  - All Data Exports
  - Data Export:
    - Data Export
    - Status
  - All Imports
  - Import:
    - Import
    - Status
```

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

### Document Storage API Endpoints

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

This section details API endpoints for managing documents within the system's storage. It includes functionalities for deleting multiple documents, accessing individual documents, and retrieving document previews.

```APIDOC
Document Storage:
  - Delete multiple documents
  - Document:
    * Document Preview
```

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

### Attendance and Background Job Processing API Endpoints

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

This section outlines API endpoints for managing employee attendance records and monitoring the status of background job processes. It allows for programmatic interaction with attendance data and job execution statuses.

```APIDOC
Attendance
Background Job Prosessing:
  - Job Processing Status
```

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

### Company Management API Endpoints

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

This section details the API endpoints related to company-level management, including access policies, accrual balance updates, data exports, and various configuration settings. It provides access to organizational structures and global settings.

```APIDOC
Company:
  Access Policy Profiles:
    - Access Policy Profile
  Accrual Balances Update
  All Data Export:
    - Get Data Export
    - Export
  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
```

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

### Inventory Profiles API Endpoints

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

This section details API endpoints for managing inventory profiles and their associated items. It allows for programmatic access to inventory data, including individual inventory items within a profile.

```APIDOC
Inventory Profiles:
  - Inventory Profile:
    * Inventory Items:
      + Inventory Item
```

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

### OAuth 2.0 API Authorization Endpoints

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

Provides details on the OAuth 2.0 authorization endpoints used for securing API access and managing user sessions. Includes methods for authorization, token introspection, logout, and user information retrieval.

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

  Introspect
    - Validates an access token.
    - Parameters: token (access token)
    - Returns: Token introspection response.

  Logout
    - Terminates the user's session.
    - Parameters: token (optional)
    - Returns: Logout confirmation.

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

  Revoke
    - Revokes an access token or refresh token.
    - Parameters: token
    - Returns: Revocation status.

  Token
    - Exchanges an authorization code for an access token or refreshes an existing token.
    - Parameters: grant_type, code (for authorization code grant), refresh_token (for refresh token grant), redirect_uri, client_id, client_secret
    - Returns: Access token, refresh token, expiry information.

  Userinfo
    - Retrieves information about the authenticated user.
    - Parameters: Authorization header with Bearer token.
    - Returns: User claims.
```

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

### Data Delivery and HCM Dimensions API Endpoints

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

This section provides API access for data delivery, including DataView and Metadata, and specific HCM dimension widgets. It enables programmatic access to structured data views and system metadata, as well as details for HCM application and system widgets.

```APIDOC
Data Delivery:
  - DataView
  - Metadata
Dimensions HCM:
  - HCM Application Details Widget
  - HCM System Details Widget
```

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

### Webhooks

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

Information regarding the Webhooks API, which allows for real-time event notifications.

```APIDOC
Webhooks:
  - Webhooks
```

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

### Contacts and Contracts API Endpoints

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

This section covers API endpoints for managing contact information and contracts within the system. It allows for creation, retrieval, and management of employee contacts and associated contractual agreements.

```APIDOC
Contacts:
  - Contact
Contracts
```

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

### Pay Period Management API

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

API operations for managing pay periods, including processing records, exporting payroll, and handling snapshots. Supports actions like processing, snapshotting, and exporting payroll data.

```APIDOC
Pay Periods:
  Pay Period:
    Actions:
      Process Records:
        - Initiates the processing of payroll records for a pay period.
        - Returns: Status of the record processing.
      Snapshot:
        - Creates a snapshot of the pay period data.
        - Returns: Snapshot confirmation.
      Export Payroll:
        - Exports payroll data for the pay period.
        - Returns: Status of the payroll export.
    Lock:
      - Locks a pay period to prevent further modifications.
    Snapshots:
      Snapshot:
        - Retrieves a specific snapshot of a pay period.
    Payroll Export Formats:
      - Manages or retrieves available payroll export formats.
```

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

### HR Action Audit Requests and Direct Deposits API Endpoints

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

This section covers API endpoints for managing HR action audit requests and direct deposit information. It includes functionalities for creating audit requests, mass updating direct deposit details, and canceling pre-notes.

```APIDOC
HR Action Audit Requests:
  - HR Action Audit Request
Direct Deposits:
  - Mass Update Actions:
    * Mass Edit
  - Cancel Pre Note
  - Direct Deposit
```

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

### Employee Resource Management

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

Encompasses endpoints for managing individual employee data and related information. This covers personal details, work preferences, time entries, and PTO requests.

```APIDOC
Employee Resources:
  - Employee:
    - Accrual Balances
    - Contracts
    - Password
    - Time Entry Notes
    - Todo:
      - Todo Count
      - Todo Action
    - Work Time Preferences
    - PTO Request:
      - PTO Request
      - PTO Request Notes
    - All PTO Requests
  - Employees:
    - All Employees
    - Employee
    - Status
```

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

### Lookup Data API Endpoints

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

This extensive section provides API access to various lookup data types used throughout the system. It includes endpoints for retrieving lists of predefined values such as compensation types, asset categories, benefit types, deduction codes, and many other system configurations.

```APIDOC
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
```

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

### Expense Tracking API Endpoints

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

This section outlines API endpoints for managing expense reports and related metadata. It includes functionalities for creating new expense reports, retrieving metadata for expense types, and managing individual expense items within a report.

```APIDOC
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
```

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

### Vehicle Management API

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

API operations for managing vehicle assignments, insurances, and maintenance records. Includes actions related to vehicle assignments.

```APIDOC
Vehicle:
  Vehicle Assignments:
    Vehicle Assignment:
      Vehicle Assignment Action:
        - Performs actions on a vehicle assignment.
  Vehicle Insurances:
    Vehicle Insurance:
      - Manages vehicle insurance records.
  Vehicle Maintenances:
    Vehicle Maintenance:
      - Manages vehicle maintenance records.
```

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

### Session OAuth API

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

API endpoints related to session management via OAuth, covering authentication and authorization code flows.

```APIDOC
Session OAuth:
  Authentication:
    - Handles authentication processes.
  Authorization code:
    - Manages the authorization code grant type.
```

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

### Reporting and Analytics

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

Provides access to reporting functionalities, including generating reports, retrieving metadata, and managing saved reports.

```APIDOC
Reporting:
  - Reports
  - Report:
    - Global Report
    - Global Report Metadata
    - Saved Report
    - Saved Report Metadata
```

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

### PTO Request API

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

API for managing Paid Time Off (PTO) requests, including individual requests, collections, and associated notes.

```APIDOC
PTO Request:
  PTO Request:
    - Manages individual PTO requests.
  All PTO Requests:
    - Retrieves or manages all PTO requests.
  PTO Request Notes:
    PTO Request Notes:
      - Manages notes related to PTO requests.
```

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

### Calendar and Compensation API Endpoints

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

This section provides API access to calendar-related data such as anniversaries and birthdays, as well as comprehensive compensation information. It includes endpoints for additional compensation, historical compensation data, and total compensation summaries.

```APIDOC
Calendar:
  - Anniversary Calendar
  - Birthday Calendar
Compensation:
  - Additional Compensation:
    * Additional Compensation
  - History:
    * History:
      + Notes
  - Total Compensation
```

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

### Scheduled Deductions and Earnings API

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

API for mass adding, editing, or deleting scheduled deductions and earnings for employees.

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

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

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

### External Pay Statements and Forms API Endpoints

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

This section provides API access to external pay statements and various system forms. It allows for retrieval of pay statement data and access to both custom and system-defined forms.

```APIDOC
External Pay Statements:
  - External PayStatements
Forms:
  - Custom
  - System
```

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

### Leave of Absence API Endpoints

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

This section covers API endpoints for managing leave of absence cases and requests. It includes functionalities for accessing and adding notes to both LOA cases and individual requests.

```APIDOC
Leave Of Absence:
  - Cases:
    * Case:
      + Notes:
        - Note
  - Requests:
    * Request:
      + Notes:
        - Note
```
Tokens:
Raw