Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Paycycle Return API

17 actions 17 updates phrasing extends openapi/deputy-employeepaycyclereturn-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/EmployeePaycycleReturn'].get
$.paths['/resource/EmployeePaycycleReturn'].put
$.paths['/resource/EmployeePaycycleReturn'].post
$.paths['/resource/EmployeePaycycleReturn/BULK'].post
$.paths['/resource/EmployeePaycycleReturn/INFO'].get
$.paths['/resource/EmployeePaycycleReturn/PREDICT'].post
$.paths['/resource/EmployeePaycycleReturn/QUERY'].post
$.paths['/resource/EmployeePaycycleReturn/{id}'].get
$.paths['/resource/EmployeePaycycleReturn/{id}'].put
$.paths['/resource/EmployeePaycycleReturn/{id}'].post
$.paths['/resource/EmployeePaycycleReturn/{id}'].delete
$.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS'].get
$.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS'].post
$.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeePaycycleReturn/{id}/HISTORY'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Deputy V1 Resource Employee Paycycle Return API
  version: 1.0.0
extends: openapi/deputy-employeepaycyclereturn-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/resource/EmployeePaycycleReturn'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay cycle return records
      effect: read
      questions:
      - Which pay cycle return records have been recorded for a pay cycle?
      - Can I page through all pay cycle return records?
      instructions:
      - text: List all employee pay cycle return records.
      - text: Show every pay cycle return record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a pay cycle return record
      effect: write
      questions:
      - How do I overwrite a pay cycle return record with a new value?
      - Can I replace a pay cycle return record in one call?
      instructions:
      - text: Replace pay cycle return {id} with pay rule {pay_rule} and value {value}.
        slots:
          id: requestBody.Id
          pay_rule: requestBody.PayRule
          value: requestBody.Value
      - text: Overwrite pay cycle return {id} for pay cycle {paycycle_id} with {value}.
        slots:
          id: requestBody.Id
          paycycle_id: requestBody.PaycycleId
          value: requestBody.Value
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pay cycle return record
      effect: write
      questions:
      - How do I add a new pay cycle return record?
      - Can I create a pay cycle return record for a pay rule?
      instructions:
      - text: Create pay cycle return {id} for pay rule {pay_rule} with value {value}.
        slots:
          id: requestBody.Id
          pay_rule: requestBody.PayRule
          value: requestBody.Value
      - text: Add a new pay cycle return record {id} with pay rule {pay_rule}.
        slots:
          id: requestBody.Id
          pay_rule: requestBody.PayRule
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many pay cycle return records
      effect: write
      questions:
      - Can I create or update many pay cycle return records at once?
      - How do I bulk load pay cycle return records?
      instructions:
      - text: Bulk create or update these pay cycle return records.
      - text: Apply this batch of pay cycle return records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pay cycle return field metadata
      effect: read
      questions:
      - Which fields and associations does a pay cycle return record have?
      - What types are the fields on a pay cycle return record?
      instructions:
      - text: Show the field metadata for pay cycle return records.
      - text: List the fields and associations of pay cycle return records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing pay cycle return
      effect: read
      questions:
      - Can I find the existing pay cycle return record that matches a partial payload?
      - Which existing pay cycle return record matches this pay rule and pay cycle?
      instructions:
      - text: Predict the existing pay cycle return record for pay rule {pay_rule} in pay cycle {paycycle_id}.
        slots:
          pay_rule: requestBody.PayRule
          paycycle_id: requestBody.PaycycleId
      - text: Find the matching pay cycle return record for {id}.
        slots:
          id: requestBody.Id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search pay cycle return records
      effect: read
      questions:
      - How do I find pay cycle return records matching a pay rule?
      - Can I sort and page through pay cycle return records?
      instructions:
      - text: Search pay cycle return records where pay rule {pay_rule} equals {value}.
        slots:
          pay_rule: requestBody.search
          value: requestBody.search
      - text: Find pay cycle return records matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay cycle return record
      effect: read
      questions:
      - What value and pay rule does a pay cycle return record have?
      - Can I fetch one pay cycle return record by id?
      instructions:
      - text: Get pay cycle return record {id}.
        slots:
          id: path.id
      - text: Show the value and pay rule on pay cycle return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or update a paycycle return
      effect: write
      questions:
      - How do I approve a paycycle return for a staff member?
      - Can I change the pay rule or override a paycycle return?
      instructions:
      - text: Approve paycycle return {id} with pay rule {PayRule}.
        slots:
          id: path.id
          PayRule: requestBody.PayRule
      - text: Set paycycle return {id} approved to {Approved}, amount {Value}.
        slots:
          id: path.id
          Approved: requestBody.Approved
          Value: requestBody.Value
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a pay cycle return record
      effect: write
      questions:
      - How do I change the value on an existing pay cycle return record?
      - Can I edit a pay cycle return record after creating it?
      instructions:
      - text: Update pay cycle return {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.Value
      - text: Change the pay rule on existing pay cycle return {id} to {pay_rule}.
        slots:
          id: path.id
          pay_rule: requestBody.PayRule
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pay cycle return record
      effect: destructive
      questions:
      - How do I delete a pay cycle return record?
      - Can I remove a pay cycle return record I no longer need?
      instructions:
      - text: Delete pay cycle return record {id}.
        slots:
          id: path.id
      - text: Remove pay cycle return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pay cycle return
      effect: read
      questions:
      - What comments have been left on a pay cycle return record?
      - Can I read the comment history for a pay cycle return?
      instructions:
      - text: List comments on pay cycle return {id}.
        slots:
          id: path.id
      - text: Show the comment history for pay cycle return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a pay cycle return
      effect: write
      questions:
      - How do I add a comment to a pay cycle return record?
      - Can I annotate a pay cycle return with a comment?
      instructions:
      - text: Add comment {comment} to pay cycle return {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment pay cycle return {id} with {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pay cycle return
      effect: destructive
      questions:
      - How do I remove a comment from a pay cycle return record?
      - Can I delete one comment on a pay cycle return?
      instructions:
      - text: Delete comment {comment_id} from pay cycle return {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on pay cycle return {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a pay cycle return
      effect: read
      questions:
      - What changes have been made to a pay cycle return record over time?
      - Can I see the change history of a pay cycle return?
      instructions:
      - text: Show the change history of pay cycle return {id}.
        slots:
          id: path.id
      - text: List every change made to pay cycle return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycleReturn/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay cycle return as it was at a past time
      effect: read
      questions:
      - How do I see what a pay cycle return record looked like at a past moment?
      - Can I travel back to a prior version of a pay cycle return?
      instructions:
      - text: Show pay cycle return {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to pay cycle return {id} at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/deputy-employeepaycyclereturn-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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