Shop-Ware Pay Rates API

The Pay Rates API from Shop-Ware — 3 operation(s) for pay rates.

Business capability
Compensation & Benefits Management BC-300.30

Operations 5

GET /api/v1/tenants/{tenant_id}/pay_rates Get a list of all pay rates #
POST /api/v1/tenants/{tenant_id}/pay_rates Create a new pay rates #
PUT /api/v1/tenants/{tenant_id}/pay_rates Update the specified existing pay rates #
GET /api/v1/tenants/{tenant_id}/pay_rates/{id} Get a specific pay rate by ID #
POST /api/v1/tenants/{tenant_id}/pay_rates/delete Delete the specified pay rates #

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/shop-ware-pay-rates-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.

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

OpenAPI Specification

shop-ware-pay-rates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: V1 Pay Rates API
  version: v1
  contact:
    name: API Support
    email: support@shop-ware.com
security:
- api_partner_id: []
  api_secret: []
tags:
- name: Pay Rates
paths:
  /api/v1/tenants/{tenant_id}/pay_rates:
    parameters:
    - name: tenant_id
      in: path
      required: true
      example: '1'
      schema:
        type: integer
    get:
      summary: Get a list of all pay rates
      tags:
      - Pay Rates
      parameters:
      - name: page
        in: query
        required: false
        example: '1'
        schema:
          type: integer
      - name: per_page
        in: query
        required: false
        example: '30'
        schema:
          type: integer
      - name: updated_after
        in: query
        required: false
        format: date-time
        description: Filter response to only include records updated after a given time
        example: 2022-10-24T12%3A00%3A00%2B08%3A00
        schema:
          type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              examples:
                successful:
                  value:
                    results:
                    - id: 1
                      created_at: '2026-06-09T14:24:08Z'
                      updated_at: '2026-06-09T14:24:08Z'
                      pay_type: Flat Rate
                      commission_percent: null
                      hourly_rate_cents: 1000
                      hourly_rate_currency: USD
                      staff_id: 1
                      effective_date: '2023-01-01'
                      loaded_cost_percent: '0.1'
                    limit: 1
                    limited: false
                    total_count: 1
                    current_page: 1
                    total_pages: 1
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier of this record.
                        pay_type:
                          type: string
                          description: Pay type. Default is 'Flat Rate'.
                        commission_percent:
                          type:
                          - integer
                          - 'null'
                          description: Commission percent.
                        hourly_rate_cents:
                          type: integer
                          description: Hourly rate in cents.
                        hourly_rate_currency:
                          type: string
                          description: Hourly rate currency. Default is 'USD'.
                        staff_id:
                          type: integer
                          description: A foreign key that points to staff associated with this pay rate.
                        effective_date:
                          type: string
                          format: date
                          description: Effective date in YYYY-MM-DD format. Must be unique within specific employee's pay rates.
                        loaded_cost_percent:
                          type:
                          - string
                          - 'null'
                          description: Loaded cost percent as a decimal.
                        created_at:
                          type: string
                          format: date-time
                          description: Date and time when record was created.
                        updated_at:
                          type: string
                          format: date-time
                          description: Date and time when record was last updated.
                  limit:
                    type: integer
                  limited:
                    type: boolean
                  total_count:
                    type: integer
                  current_page:
                    type: integer
                  total_pages:
                    type: integer
      operationId: getApiV1TenantsByTenantIdPayRates
      x-operation-id-source: derived
    post:
      summary: Create a new pay rates
      tags:
      - Pay Rates
      parameters: []
      responses:
        '201':
          description: successful
          content:
            application/json:
              examples:
                successful:
                  value:
                  - id: 1
                    created_at: '2026-06-09T14:24:11Z'
                    updated_at: '2026-06-09T14:24:11Z'
                    pay_type: Flat Rate
                    commission_percent: null
                    hourly_rate_cents: 1000
                    hourly_rate_currency: USD
                    staff_id: 1
                    effective_date: '2023-01-01'
                    loaded_cost_percent: '0.1'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Unique identifier of this record.
                    pay_type:
                      type: string
                      description: Pay type. Default is 'Flat Rate'.
                    commission_percent:
                      type:
                      - integer
                      - 'null'
                      description: Commission percent.
                    hourly_rate_cents:
                      type: integer
                      description: Hourly rate in cents.
                    hourly_rate_currency:
                      type: string
                      description: Hourly rate currency. Default is 'USD'.
                    staff_id:
                      type: integer
                      description: A foreign key that points to staff associated with this pay rate.
                    effective_date:
                      type: string
                      format: date
                      description: Effective date in YYYY-MM-DD format. Must be unique within specific employee's pay rates.
                    loaded_cost_percent:
                      type:
                      - string
                      - 'null'
                      description: Loaded cost percent as a decimal.
                    created_at:
                      type: string
                      format: date-time
                      description: Date and time when record was created.
                    updated_at:
                      type: string
                      format: date-time
                      description: Date and time when record was last updated.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - employee_id
              - shop_id
              - pay_information
              properties:
                employee_id:
                  type: integer
                  description: Employee identifier.
                shop_id:
                  type: integer
                  description: A foreign key that points to the Shop this staff is currently assigned to.
                pay_information:
                  type: array
                  items:
                    type: object
                    required:
                    - pay_type
                    - effective_date
                    - hourly_rate_cents
                    description: Pay information.
                    properties:
                      pay_type:
                        type: string
                        minLength: 1
                        description: Pay type.
                      effective_date:
                        type: string
                        format: date
                        description: Effective date in YYYY-MM-DD format. Must be unique within specific employee.
                      hourly_rate_cents:
                        type: integer
                        exclusiveMinimum: 0
                        description: Hourly rate in cents.
                      loaded_cost_percent:
                        type: number
                        description: Loaded cost percent as a decimal
                        minimum: 0
                        maximum: 1
              example:
                employee_id: 1
                shop_id: 2
                pay_information:
                - pay_type: Flat Rate
                  effective_date: '2023-01-01'
                  hourly_rate_cents: 1000
                  loaded_cost_percent: 0.1
      operationId: postApiV1TenantsByTenantIdPayRates
      x-operation-id-source: derived
    put:
      summary: Update the specified existing pay rates
      tags:
      - Pay Rates
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              examples:
                successful:
                  value:
                  - id: 1
                    created_at: '2026-06-09T14:24:14Z'
                    updated_at: '2026-06-09T14:24:14Z'
                    pay_type: Flat Rate
                    commission_percent: null
                    hourly_rate_cents: 1000
                    hourly_rate_currency: USD
                    staff_id: 1
                    effective_date: '2023-01-01'
                    loaded_cost_percent: '0.1'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Unique identifier of this record.
                    pay_type:
                      type: string
                      description: Pay type. Default is 'Flat Rate'.
                    commission_percent:
                      type:
                      - integer
                      - 'null'
                      description: Commission percent.
                    hourly_rate_cents:
                      type: integer
                      description: Hourly rate in cents.
                    hourly_rate_currency:
                      type: string
                      description: Hourly rate currency. Default is 'USD'.
                    staff_id:
                      type: integer
                      description: A foreign key that points to staff associated with this pay rate.
                    effective_date:
                      type: string
                      format: date
                      description: Effective date in YYYY-MM-DD format. Must be unique within specific employee's pay rates.
                    loaded_cost_percent:
                      type:
                      - string
                      - 'null'
                      description: Loaded cost percent as a decimal.
                    created_at:
                      type: string
                      format: date-time
                      description: Date and time when record was created.
                    updated_at:
                      type: string
                      format: date-time
                      description: Date and time when record was last updated.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - pay_information
              properties:
                pay_information:
                  type: array
                  items:
                    type: object
                    required:
                    - pay_type
                    - effective_date
                    - hourly_rate_cents
                    description: Pay information.
                    properties:
                      id:
                        type: integer
                      pay_type:
                        type: string
                        minLength: 1
                        description: Pay type.
                      effective_date:
                        type: string
                        format: date
                        description: Effective date in YYYY-MM-DD format. Must be unique within specific employee.
                      hourly_rate_cents:
                        type: integer
                        exclusiveMinimum: 0
                        description: Hourly rate in cents.
                      loaded_cost_percent:
                        type: number
                        description: Loaded cost percent as a decimal
                        minimum: 0
                        maximum: 1
              example:
                pay_information:
                - id: 1
                  pay_type: Flat Rate
                  effective_date: '2023-01-01'
                  hourly_rate_cents: 1000
                  loaded_cost_percent: 0.1
      operationId: putApiV1TenantsByTenantIdPayRates
      x-operation-id-source: derived
  /api/v1/tenants/{tenant_id}/pay_rates/{id}:
    parameters:
    - name: tenant_id
      in: path
      required: true
      example: '1'
      schema:
        type: integer
    - name: id
      in: path
      required: true
      example: '1'
      schema:
        type: integer
    get:
      summary: Get a specific pay rate by ID
      tags:
      - Pay Rates
      responses:
        '200':
          description: successful
          content:
            application/json:
              examples:
                successful:
                  value:
                    id: 1
                    created_at: '2026-06-09T14:24:17Z'
                    updated_at: '2026-06-09T14:24:17Z'
                    pay_type: Flat Rate
                    commission_percent: null
                    hourly_rate_cents: 1000
                    hourly_rate_currency: USD
                    staff_id: 1
                    effective_date: '2023-01-01'
                    loaded_cost_percent: '0.1'
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: Unique identifier of this record.
                  pay_type:
                    type: string
                    description: Pay type. Default is 'Flat Rate'.
                  commission_percent:
                    type:
                    - integer
                    - 'null'
                    description: Commission percent.
                  hourly_rate_cents:
                    type: integer
                    description: Hourly rate in cents.
                  hourly_rate_currency:
                    type: string
                    description: Hourly rate currency. Default is 'USD'.
                  staff_id:
                    type: integer
                    description: A foreign key that points to staff associated with this pay rate.
                  effective_date:
                    type: string
                    format: date
                    description: Effective date in YYYY-MM-DD format. Must be unique within specific employee's pay rates.
                  loaded_cost_percent:
                    type:
                    - string
                    - 'null'
                    description: Loaded cost percent as a decimal.
                  created_at:
                    type: string
                    format: date-time
                    description: Date and time when record was created.
                  updated_at:
                    type: string
                    format: date-time
                    description: Date and time when record was last updated.
      operationId: getApiV1TenantsByTenantIdPayRatesById
      x-operation-id-source: derived
  /api/v1/tenants/{tenant_id}/pay_rates/delete:
    parameters:
    - name: tenant_id
      in: path
      required: true
      example: '1'
      schema:
        type: integer
    post:
      summary: Delete the specified pay rates
      tags:
      - Pay Rates
      parameters: []
      responses:
        '200':
          description: successful
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - pay_rate_ids
              properties:
                pay_rate_ids:
                  type: array
                  description: Pay rate ids to delete.
                  items:
                    type: integer
              example:
                pay_rate_ids:
                - 1
      operationId: postApiV1TenantsByTenantIdPayRatesDelete
      x-operation-id-source: derived
components:
  securitySchemes:
    api_partner_id:
      type: apiKey
      name: X-Api-Partner-Id
      in: header
    api_secret:
      type: apiKey
      name: X-Api-Secret
      in: header