OnPay

OnPay Employees API

The Employees API from OnPay — 14 operation(s) for employees.

GitHub OpenAPI

Operations 23

GET /employees
POST /employees
GET /employees/{employee_id}
PATCH /employees/{employee_id}
GET /employees/{employee_id}/deductions
PATCH /employees/{employee_id}/deductions/{deduction_id}
POST /employees/{employee_id}/deductions/{deduction_id}
GET /employees/{employee_id}/deductions/{deduction_id}/schedule
POST /employees/{employee_id}/deductions/{deduction_id}/schedule
GET /employees/{employee_id}/bank-accounts
PUT /employees/{employee_id}/bank-accounts
GET /employees/{employee_id}/wages
PATCH /employees/{employee_id}/wages
GET /employees/{employee_id}/wages/schedule
POST /employees/{employee_id}/wages/schedule
GET /employees/{employee_id}/leave
PATCH /employees/{employee_id}/leave
GET /employees/{employee_id}/tax-fields
PATCH /employees/{employee_id}/tax-fields
PATCH /employees/{employee_id}/tax-fields/worksite
POST /employees/{employee_id}/termination
POST /employees/{employee_id}/rehire
GET /employees/recent-notes-and-comments

Documentation

📖
Documentation
https://onpay.readme.io/
📖
APIReference
https://onpay.readme.io/reference/authorization
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/authentication/onpay-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/openapi/onpay-employees-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/scopes/onpay-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/errors/onpay-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/conventions/onpay-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/data-model/onpay-data-model.yml
🔗
LLMsTxt
https://onpay.readme.io/llms.txt

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/onpay-employees-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

onpay-employees-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: OnPay Employees API
  description: Must present a valid Bearer token.
servers:
- url: https://onpaydev.com/v2
tags:
- name: Employees
paths:
  /employees:
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Get list of employees

        '
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '402':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Insert employee

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeePost'
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertSuccessful'
  /employees/{employee_id}:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Get employee by employee_id

        '
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        default:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Update an employee

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
        description: JSON Merge Patch [RFC 7396]
      responses:
        '200':
          description: Successful resopnse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchSuccessful'
        default:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
  /employees/{employee_id}/deductions:
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
        - Controller
        - Manager
        - Employee
      description: 'Get deductions for an employee

        '
      parameters:
      - name: employee_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  associated:
                    description: Group of deductions that employee is currently or has been associated with
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeDeductionItem'
                  actions_pending_approval:
                    type: array
                    items:
                      type: object
                      properties:
                        verb:
                          type: string
                        route:
                          type: string
                        options:
                          type: array
                          items: {}
                        description:
                          type: string
                        effective_date:
                          type: string
                        requested_date:
                          type: string
                        body:
                          type: object
                          properties:
                            id:
                              type: integer
                            employee_id:
                              type: integer
                            employee_number:
                              type: string
                            deduction_type:
                              $ref: '#/components/schemas/DeductionType'
                            deduction_id:
                              type: integer
                            percent:
                              type: number
                            annual_limit:
                              type: number
                            amount:
                              type: number
                            override_amount:
                              type: number
                            active:
                              type: boolean
                            ach_active:
                              type: boolean
                            routing:
                              type: integer
                            account:
                              type: integer
                            savings:
                              type: boolean
                            memo:
                              type: string
                            include_benefit_amount_in_ach:
                              type: boolean
                            override_company_benefit_amount:
                              type: number
                            lifetime_limit:
                              type: number
        default:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
  /employees/{employee_id}/deductions/{deduction_id}:
    parameters:
    - name: employee_id
      in: path
      required: true
      schema:
        type: integer
    - name: deduction_id
      in: path
      required: true
      schema:
        type: integer
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Update an employee deduction batch by employee ID and deduction ID

        '
      requestBody:
        $ref: '#/components/requestBodies/Parameters'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchSuccessful'
        default:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Insert deduction batch for an employee by employee ID and deduction ID

        '
      requestBody:
        $ref: '#/components/requestBodies/Parameters'
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertSuccessful'
  /employees/{employee_id}/deductions/{deduction_id}/schedule:
    parameters:
    - name: employee_id
      in: path
      required: true
      schema:
        type: integer
    - name: deduction_id
      in: path
      required: true
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: List scheduled changes to employee deductions
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    verb:
                      type: string
                    options:
                      type: array
                      items: {}
                    description:
                      type: string
                    requested_date:
                      type: string
                    effective_date:
                      type: string
                    body:
                      type: object
                      properties:
                        id:
                          type: integer
                        employee_id:
                          type: integer
                        employee_number:
                          type: string
                        deduction_type:
                          $ref: '#/components/schemas/DeductionType'
                        deduction_id:
                          type: integer
                        percent:
                          type: number
                        annual_limit:
                          type: number
                        amount:
                          type: number
                        override_amount:
                          type: number
                        active:
                          type: boolean
                        ach_active:
                          type: boolean
                        routing:
                          type: integer
                        account:
                          type: integer
                        savings:
                          type: boolean
                        memo:
                          type: string
                        include_benefit_amount_in_ach:
                          type: boolean
                        override_company_benefit_amount:
                          type: number
                        lifetime_limit:
                          type: number
                    requested_version:
                      type: string
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Submit a scheduled change to a deduction batch for an employee by employee ID and deduction ID

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - verb
              - effective_date
              - body
              properties:
                verb:
                  type: string
                options:
                  type: array
                  items: {}
                effective_date:
                  type: string
                body:
                  type: object
                  properties:
                    id:
                      type: integer
                    employee_id:
                      type: integer
                    employee_number:
                      type: string
                    deduction_type:
                      $ref: '#/components/schemas/DeductionType'
                    deduction_id:
                      type: integer
                    percent:
                      type: number
                    annual_limit:
                      type: number
                    amount:
                      type: number
                    override_amount:
                      type: number
                    active:
                      type: boolean
                    ach_active:
                      type: boolean
                    routing:
                      type: integer
                    account:
                      type: integer
                    savings:
                      type: boolean
                    memo:
                      type: string
                    include_benefit_amount_in_ach:
                      type: boolean
                    override_company_benefit_amount:
                      type: number
                    lifetime_limit:
                      type: number
                version:
                  type: string
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertSuccessful'
  /employees/{employee_id}/bank-accounts:
    parameters:
    - name: employee_id
      in: path
      required: true
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'list employee bank accounts

        '
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeAchAccountItem'
    put:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: put employee bank accounts
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bank_accounts:
                  type: array
                  items:
                    $ref: '#/components/schemas/EmployeeAchAccountPutItem'
                version:
                  type: string
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  bank_accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeAchAccountItem'
                  version:
                    type: string
  /employees/{employee_id}/wages:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: List employee pay items
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  pay_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayItem'
                  actions_pending_approval:
                    type: array
                    items:
                      type: object
                      properties:
                        verb:
                          type: string
                        route:
                          type: string
                        options:
                          type: array
                          items: {}
                        description:
                          type: string
                        effective_date:
                          type: string
                        requested_date:
                          type: string
                        body:
                          type: object
                          properties:
                            pay_items:
                              type: array
                              items:
                                $ref: '#/components/schemas/PayItem'
                        version:
                          type: string
                  version:
                    type: string
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: Update employee pay items
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                pay_items:
                  type: array
                  items:
                    $ref: '#/components/schemas/PayItem'
                version:
                  type: string
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  pay_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayItem'
                  version:
                    type: string
  /employees/{employee_id}/wages/schedule:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: List scheduled changes to employee pay items
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    verb:
                      type: string
                    route:
                      type: string
                    options:
                      type: array
                      items: {}
                    description:
                      type: string
                    requested_date:
                      type: string
                    effective_date:
                      type: string
                    body:
                      type: object
                      properties:
                        pay_items:
                          type: array
                          items:
                            $ref: '#/components/schemas/PayItem'
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: 'Schedule changes to employee wages for approval.

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - verb
              - effective_date
              - body
              properties:
                verb:
                  type: string
                options:
                  type: array
                  items: {}
                effective_date:
                  type: string
                body:
                  type: object
                  properties:
                    pay_items:
                      type: array
                      items:
                        $ref: '#/components/schemas/PayItem'
                version:
                  type: string
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertSuccessful'
  /employees/{employee_id}/leave:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: List employee leave items
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaveItem'
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: Update employee leave items
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LeaveItem'
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaveItem'
  /employees/{employee_id}/tax-fields:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: List employee tax fields
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  worksite_id:
                    type: integer
                  federal_status:
                    type: integer
                  federal_allowances:
                    type: integer
                  fica_exempt:
                    type: boolean
                  fit_exempt:
                    type: boolean
                  fit_additional_amount:
                    type: integer
                  work_location_display_fields:
                    $ref: '#/components/schemas/StateDisplayFieldsObject'
                  state_misc_1_value:
                    type: string
                  state_misc_3_value:
                    type: string
                  state_misc_2_value:
                    type: string
                  sit_additional_amount:
                    type: integer
                  sdi_exempt:
                    type: boolean
                  state_misc_4_value:
                    type: string
                  sit_exempt:
                    type: boolean
                  state_resident:
                    type: boolean
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: Patch employee tax fields
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                worksite_id:
                  type: integer
                federal_status:
                  type: integer
                federal_allowances:
                  type: integer
                fica_exempt:
                  type: boolean
                fit_exempt:
                  type: boolean
                fit_additional_amount:
                  type: integer
                work_location_display_fields:
                  $ref: '#/components/schemas/StateDisplayFieldsObject'
                state_misc_1_value:
                  type: string
                state_misc_3_value:
                  type: string
                state_misc_2_value:
                  type: string
                sit_additional_amount:
                  type: integer
                sdi_exempt:
                  type: boolean
                state_misc_4_value:
                  type: string
                sit_exempt:
                  type: boolean
                state_resident:
                  type: boolean
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  worksite_id:
                    type: integer
                  federal_status:
                    type: integer
                  federal_allowances:
                    type: integer
                  fica_exempt:
                    type: boolean
                  fit_exempt:
                    type: boolean
                  fit_additional_amount:
                    type: integer
                  work_location_display_fields:
                    $ref: '#/components/schemas/StateDisplayFieldsObject'
                  state_misc_1_value:
                    type: string
                  state_misc_3_value:
                    type: string
                  state_misc_2_value:
                    type: string
                  sit_additional_amount:
                    type: integer
                  sdi_exempt:
                    type: boolean
                  state_misc_4_value:
                    type: string
                  sit_exempt:
                    type: boolean
                  state_resident:
                    type: boolean
  /employees/{employee_id}/tax-fields/worksite:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    patch:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
      description: Update employee worksite id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                worksite_id:
                  type: integer
                version:
                  type: string
      responses:
        '200':
          description: Sucessful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  worksite_id:
                    type: integer
                  federal_status:
                    type: integer
                  federal_allowances:
                    type: integer
                  fica_exempt:
                    type: boolean
                  fit_exempt:
                    type: boolean
                  fit_additional_amount:
                    type: integer
                  work_location_display_fields:
                    $ref: '#/components/schemas/StateDisplayFieldsObject'
                  state_misc_1_value:
                    type: string
                  state_misc_3_value:
                    type: string
                  state_misc_2_value:
                    type: string
                  sit_additional_amount:
                    type: integer
                  sdi_exempt:
                    type: boolean
                  state_misc_4_value:
                    type: string
                  sit_exempt:
                    type: boolean
                  state_resident:
                    type: boolean
  /employees/{employee_id}/termination:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
        - Controller
        - Manager
      description: Terminate employee
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - termination_date
              - termination_code
              properties:
                termination_code:
                  type: string
                termination_date:
                  type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
  /employees/{employee_id}/rehire:
    parameters:
    - name: employee_id
      required: true
      in: path
      schema:
        type: integer
    post:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
        - Controller
        - Manager
      description: Rehire employee
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - rehire_date
              - version
              properties:
                rehire_date:
                  type: string
                version:
                  type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
  /employees/recent-notes-and-comments:
    get:
      tags:
      - Employees
      security:
      - OAuth2:
        - Owner
        - Approver
        - Controller
        - Manager
      description: 'Get recent notes and or comments from an employees account.

        '
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeNote'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '402':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
components:
  schemas:
    WageListItem:
      type: object
      properties:
        name:
          type: string
        hours:
          type: number
        rate:
          type: number
        amount:
          type: number
        ytd:
          type: number
        pay_type_id:
          type: number
    EmployeeDeductionItemBatch:
      type: object
      properties:
        id:
          type: integer
        employee_id:
          type: integer
        employee_number:
          type: string
        deduction_type:
          $ref: '#/components/schemas/DeductionType'
        deduction_id:
          type: integer
        percent:
          type: number
        annual_limit:
          type: number
        amount:
          type: number
        override_amount:
          type: number
        active:
          type: boolean
        ach_active:
          type: boolean
        routing:
          type: integer
        account:
          type: integer
        savings:
          type: boolean
        memo:
          type: string
        include_benefit_amount_in_ach:
          type: boolean
        override_company_benefit_amount:
          type: number
        lifetime_limit:
          type: number
        version:
          type: string
    StateDisplayFieldsObject:
      type: object
      properties:
        state_information:
          $ref: '#/components/schemas/StateInformationObject'
        display_fields:
          $ref: '#/components/schemas/DisplayFieldsObject'
    EmployeePost:
      type: object
      properties:
        employee:
          type: array
          properties:
            birthday:
              type: string
            hire_date:
              type: string
            rehire_date:
              type: string
            termination_date:
              type: string
            accrual_vacation_policy_id:
              type: integer
            accrual_sick_policy_id:
              type: integer
            accrual_pto_policy_id:
              type: integer
            can_revoke_online_access:
              type: boolean
            cell_phone_number:
              type: string
            department_id:
              type: integer
            email:
              type: string
            address:
              type: string
            address_2:
              type: string
            city:
              type: string
            state:
              type: string
            zip:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            middle_initial:
              type: string
            employee_notes:
              type: string
            employee_number:
              type: string
            ssn:
              type: string
            gender:
              type: integer
              enum:
              - M
              - F
            home_phone_number:
              type: string
            mail_address:
              type: string
            mail_address_2:
              type: string
            mail_city:
              type: string
            mail_state:
              type: string
            use_mail_address:
              type: boolean
            mail_zip:
              type: string
            manager_id:
              type: string
            part_time:
              type: boolean
            pay_schedule_id:
              type: integer
            position_id:
              type: intege

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onpay/refs/heads/main/openapi/onpay-employees-api-openapi.yml