Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Timesheet Pay Return Detail API

11 actions 11 updates phrasing extends openapi/deputy-timesheetpayreturndetail-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 11

$.info
$.paths['/resource/TimesheetPayReturnDetail'].get
$.paths['/resource/TimesheetPayReturnDetail/INFO'].get
$.paths['/resource/TimesheetPayReturnDetail/PREDICT'].post
$.paths['/resource/TimesheetPayReturnDetail/QUERY'].post
$.paths['/resource/TimesheetPayReturnDetail/{id}'].get
$.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS'].get
$.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS'].post
$.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TimesheetPayReturnDetail/{id}/HISTORY'].get
$.paths['/resource/TimesheetPayReturnDetail/{id}/HISTORY/travel/{timestamp}'].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 Timesheet Pay Return Detail API
  version: 1.0.0
extends: openapi/deputy-timesheetpayreturndetail-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: 10
- target: $.paths['/resource/TimesheetPayReturnDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: List timesheet pay return details
      effect: read
      questions:
      - How do I see pay return details for timesheets I'm allowed to see?
      - Can I pull timesheet return records for payroll reconciliation?
      instructions:
      - text: List timesheet pay return detail records.
      - text: Show pay return details for timesheets.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe pay return detail fields
      effect: read
      questions:
      - What fields and types does pay return detail have?
      - Which pay return detail fields can I query?
      instructions:
      - text: Show the field metadata for pay return detail.
      - text: Describe the pay return detail resource fields and associations.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing pay return detail line
      effect: read
      questions:
      - Can I find an existing pay return detail line before creating one?
      - What pay return detail line matches a partial record?
      instructions:
      - text: Find the existing pay return detail line for {TimesheetPayReturnId} with pay rate {PayRate} and level {Level}.
        slots:
          TimesheetPayReturnId: requestBody.TimesheetPayReturnId
          PayRate: requestBody.PayRate
          Level: requestBody.Level
      - text: Predict a pay return detail line matching {TimesheetPayReturnId}, {PayRate}, {Level} and {RemunerationType}.
        slots:
          TimesheetPayReturnId: requestBody.TimesheetPayReturnId
          PayRate: requestBody.PayRate
          Level: requestBody.Level
          RemunerationType: requestBody.RemunerationType
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search pay return detail lines
      effect: read
      questions:
      - How do I search pay return detail lines?
      - Can I sort pay return detail records?
      instructions:
      - text: Search pay return detail lines where {search}.
        slots:
          search: requestBody.search
      - text: Find pay return detail lines matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay return detail line
      effect: read
      questions:
      - What pay rate and level does a pay return detail line have?
      - Can I fetch one pay return detail line by id?
      instructions:
      - text: Get pay return detail line {id}.
        slots:
          id: path.id
      - text: Show the pay return detail line with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pay return detail line
      effect: read
      questions:
      - What comments have been left on a pay return detail line?
      - Can I read the comment history on a pay return detail line?
      instructions:
      - text: List comments on pay return detail line {id}.
        slots:
          id: path.id
      - text: Show the comment history for pay return detail line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a pay return detail line
      effect: write
      questions:
      - Can I add a comment to a pay return detail line?
      - How do I annotate a pay return detail line?
      instructions:
      - text: Add comment {Comment} to pay return detail line {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Comment pay return detail line {id} saying {Comment}.
        slots:
          id: path.id
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pay return detail line
      effect: destructive
      questions:
      - Can I delete a comment on a pay return detail line?
      - How do I remove a comment from a pay return detail line?
      instructions:
      - text: Delete comment {commentId} from pay return detail line {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on pay return detail line {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a pay return detail line
      effect: read
      questions:
      - What changes have been made to a pay return detail line?
      - Can I see the change history of a pay return detail line?
      instructions:
      - text: Show the change history of pay return detail line {id}.
        slots:
          id: path.id
      - text: List every change made to pay return detail line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturnDetail/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a pay return detail line as it was at a past time
      effect: read
      questions:
      - What did a pay return detail line look like at a past time?
      - Can I travel back to a pay return detail line's state at a timestamp?
      instructions:
      - text: Show pay return detail line {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to pay return detail line {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-timesheetpayreturndetail-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.