Deputy · OpenAPI Overlay 1.0.0

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

17 actions 17 updates phrasing extends openapi/deputy-timesheetpayreturn-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/TimesheetPayReturn'].get
$.paths['/resource/TimesheetPayReturn'].put
$.paths['/resource/TimesheetPayReturn'].post
$.paths['/resource/TimesheetPayReturn/BULK'].post
$.paths['/resource/TimesheetPayReturn/INFO'].get
$.paths['/resource/TimesheetPayReturn/PREDICT'].post
$.paths['/resource/TimesheetPayReturn/QUERY'].post
$.paths['/resource/TimesheetPayReturn/{id}'].get
$.paths['/resource/TimesheetPayReturn/{id}'].put
$.paths['/resource/TimesheetPayReturn/{id}'].post
$.paths['/resource/TimesheetPayReturn/{id}'].delete
$.paths['/resource/TimesheetPayReturn/{id}/COMMENTS'].get
$.paths['/resource/TimesheetPayReturn/{id}/COMMENTS'].post
$.paths['/resource/TimesheetPayReturn/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TimesheetPayReturn/{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 Timesheet Pay Return API
  version: 1.0.0
extends: openapi/deputy-timesheetpayreturn-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/TimesheetPayReturn'].get
  update:
    x-apievangelist-phrasing:
      intent: List timesheet pay return records
      effect: read
      questions:
      - Which pay return records have been posted for a timesheet?
      - Can I page through all timesheet pay return records?
      instructions:
      - text: List all timesheet pay return records.
      - text: Show every pay return record for a timesheet.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a timesheet pay return
      effect: write
      questions:
      - How do I create a pay return record for a timesheet?
      - Can I replace a pay return record by its ID?
      instructions:
      - text: Create a timesheet pay return for timesheet {timesheet} under pay rule {pay_rule}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      - text: Replace pay return {id} for timesheet {timesheet} with value {value}.
        slots:
          id: requestBody.Id
          timesheet: requestBody.Timesheet
          value: requestBody.Value
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a pay return on a timesheet
      effect: write
      questions:
      - Can I record that a worker was paid back hours on their timesheet?
      - What pay rule and value do I set when creating a pay return?
      instructions:
      - text: Create a pay return of {value} on timesheet {timesheet} using pay rule {pay_rule}.
        slots:
          value: requestBody.Value
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      - text: Record a return of {value} hours from {timesheet}.
        slots:
          value: requestBody.Value
          timesheet: requestBody.Timesheet
      - text: Create a pay return for pay rule {pay_rule} on {timesheet} paid {value}.
        slots:
          pay_rule: requestBody.PayRule
          timesheet: requestBody.Timesheet
          value: requestBody.Value
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many timesheet pay returns
      effect: write
      questions:
      - Can I create or update several timesheet pay return records at once?
      - How do I bulk upsert pay return records?
      instructions:
      - text: Bulk create or update these timesheet pay return records.
      - text: Upsert many pay return records in one request.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field metadata for timesheet pay returns
      effect: read
      questions:
      - Which fields and associations does the timesheet pay return resource have?
      - What types and queryable fields exist on pay return records?
      instructions:
      - text: Show the field metadata for timesheet pay return records.
      - text: List the queryable fields of pay return records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing timesheet pay return
      effect: read
      questions:
      - Can I find the existing pay return record that matches a timesheet and pay rule?
      - Which pay return record would an upsert create for a timesheet?
      instructions:
      - text: Predict the existing pay return for timesheet {timesheet} under pay rule {pay_rule}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      - text: Find the matching pay return record for timesheet {timesheet} and pay rule {pay_rule}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search timesheet pay return records
      effect: read
      questions:
      - Can I search pay return records by timesheet or pay rule?
      - How do I sort and page through timesheet pay return records?
      instructions:
      - text: Search timesheet pay return records matching {search}.
        slots:
          search: requestBody.search
      - text: Find pay return records sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a timesheet pay return
      effect: read
      questions:
      - What pay rule and value does a specific pay return record have?
      - Can I fetch one timesheet pay return by ID?
      instructions:
      - text: Get timesheet pay return {id}.
        slots:
          id: path.id
      - text: Show the pay return record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recorded pay return
      effect: write
      questions:
      - Can I change a pay return I already recorded on a timesheet?
      - What can I edit on an existing pay return?
      instructions:
      - text: Update the existing pay return on timesheet {timesheet} to value {value}.
        slots:
          timesheet: requestBody.Timesheet
          value: requestBody.Value
      - text: Change return {id} on timesheet {timesheet} to use pay rule {pay_rule} and value {value}.
        slots:
          id: path.id
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
          value: requestBody.Value
      - text: Replace the pay return {id} on {timesheet}.
        slots:
          id: path.id
          timesheet: requestBody.Timesheet
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a timesheet pay return
      effect: write
      questions:
      - Can I change the value on an existing pay return record?
      - What's the POST way to update a timesheet pay return?
      instructions:
      - text: Update pay return {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.Value
      - text: Set the overridden flag on pay return {id} to {overridden}.
        slots:
          id: path.id
          overridden: requestBody.Overridden
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a timesheet pay return
      effect: destructive
      questions:
      - Can I delete a pay return record?
      - What happens to a timesheet pay return when I remove it?
      instructions:
      - text: Delete timesheet pay return {id}.
        slots:
          id: path.id
      - text: Remove pay return record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pay return
      effect: read
      questions:
      - What comments have been left on a timesheet pay return?
      - Can I see the comment history of a pay return?
      instructions:
      - text: List comments on pay return {id}.
        slots:
          id: path.id
      - text: Show the comment history for timesheet pay return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a pay return
      effect: write
      questions:
      - Can I add a comment to a timesheet pay return?
      - How do I annotate a pay return record?
      instructions:
      - text: Comment {comment} on pay return {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Add a comment to timesheet pay return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pay return
      effect: destructive
      questions:
      - Can I delete a comment from a timesheet pay return?
      - What removes a comment on a pay return record?
      instructions:
      - text: Delete comment {comment_id} from pay return {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on timesheet pay return {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a pay return
      effect: read
      questions:
      - Who changed a timesheet pay return and when?
      - Can I see the full change history of a pay return?
      instructions:
      - text: Show the change history of pay return {id}.
        slots:
          id: path.id
      - text: List every edit made to timesheet pay return {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayReturn/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a pay return as it was at a past time
      effect: read
      questions:
      - What did a pay return record look like at a specific moment in the past?
      - Can I travel back to a timesheet pay return as it existed before a change?
      instructions:
      - text: Show pay return {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to timesheet pay 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-timesheetpayreturn-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.