Deputy · OpenAPI Overlay 1.0.0

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

17 actions 17 updates phrasing extends openapi/deputy-timesheetpayforecast-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/TimesheetPayForecast'].get
$.paths['/resource/TimesheetPayForecast'].put
$.paths['/resource/TimesheetPayForecast'].post
$.paths['/resource/TimesheetPayForecast/BULK'].post
$.paths['/resource/TimesheetPayForecast/INFO'].get
$.paths['/resource/TimesheetPayForecast/PREDICT'].post
$.paths['/resource/TimesheetPayForecast/QUERY'].post
$.paths['/resource/TimesheetPayForecast/{id}'].get
$.paths['/resource/TimesheetPayForecast/{id}'].put
$.paths['/resource/TimesheetPayForecast/{id}'].post
$.paths['/resource/TimesheetPayForecast/{id}'].delete
$.paths['/resource/TimesheetPayForecast/{id}/COMMENTS'].get
$.paths['/resource/TimesheetPayForecast/{id}/COMMENTS'].post
$.paths['/resource/TimesheetPayForecast/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TimesheetPayForecast/{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 Forecast API
  version: 1.0.0
extends: openapi/deputy-timesheetpayforecast-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/TimesheetPayForecast'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay forecasts for timesheets
      effect: read
      questions:
      - Which pay forecasts are set up for a given timesheet?
      - Can I see all timesheet pay forecasts at once?
      instructions:
      - text: List all timesheet pay forecasts.
      - text: Show every pay forecast record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a timesheet pay forecast
      effect: write
      questions:
      - How do I create a pay forecast for a timesheet and pay rule?
      - Can I overwrite an existing timesheet pay forecast record?
      instructions:
      - text: Create a timesheet pay forecast for timesheet {timesheet} and pay rule {pay_rule} with value {value}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
          value: requestBody.Value
      - text: Replace the existing pay forecast 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/TimesheetPayForecast'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a timesheet pay forecast
      effect: write
      questions:
      - Can I add a new pay forecast for a timesheet?
      - What do I need to create a timesheet pay forecast?
      instructions:
      - text: Create a timesheet pay forecast for timesheet {timesheet} and pay rule {pay_rule}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      - text: Add a new pay forecast record with value {value}.
        slots:
          value: requestBody.Value
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many timesheet pay forecasts
      effect: write
      questions:
      - Can I create or update several timesheet pay forecasts in one request?
      - How do I bulk load pay forecasts for a batch of timesheets?
      instructions:
      - text: Bulk create or update these timesheet pay forecasts.
      - text: Process this array of pay forecast records in one request.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field metadata for pay forecasts
      effect: read
      questions:
      - Which fields and associations does the timesheet pay forecast resource have?
      - What types are the fields on a pay forecast record?
      instructions:
      - text: Get the field metadata for timesheet pay forecasts.
      - text: Show the field list and associations for pay forecast records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing pay forecast
      effect: read
      questions:
      - Can I find the existing pay forecast for a timesheet and pay rule before creating one?
      - What matching pay forecast record already exists for this timesheet?
      instructions:
      - text: Predict-match a pay forecast for timesheet {timesheet} and pay rule {pay_rule}.
        slots:
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
      - text: Find the existing pay forecast 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/TimesheetPayForecast/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search timesheet pay forecasts
      effect: read
      questions:
      - Can I search pay forecasts by timesheet or pay rule?
      - How do I sort and page through timesheet pay forecasts?
      instructions:
      - text: Search timesheet pay forecasts matching {search}.
        slots:
          search: requestBody.search
      - text: Find pay forecasts sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a timesheet pay forecast
      effect: read
      questions:
      - What value and cost does a specific timesheet pay forecast have?
      - Can I fetch one pay forecast record by id?
      instructions:
      - text: Get timesheet pay forecast {id}.
        slots:
          id: path.id
      - text: Show the value and cost of pay forecast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a timesheet pay forecast
      effect: write
      questions:
      - How do I overwrite an existing pay forecast record?
      - Can I fully replace a timesheet pay forecast?
      instructions:
      - text: Replace pay forecast {id} with timesheet {timesheet}, pay rule {pay_rule} and value {value}.
        slots:
          id: path.id
          timesheet: requestBody.Timesheet
          pay_rule: requestBody.PayRule
          value: requestBody.Value
      - text: Overwrite the existing pay forecast record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a timesheet pay forecast
      effect: write
      questions:
      - Can I change just the value of an existing pay forecast?
      - How do I edit a timesheet pay forecast record?
      instructions:
      - text: Update pay forecast {id} with value {value}.
        slots:
          id: path.id
          value: requestBody.Value
      - text: Change the cost on pay forecast {id} to {cost}.
        slots:
          id: path.id
          cost: requestBody.Cost
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a timesheet pay forecast
      effect: destructive
      questions:
      - Can I delete a pay forecast I no longer need?
      - What removes a timesheet pay forecast record?
      instructions:
      - text: Delete timesheet pay forecast {id}.
        slots:
          id: path.id
      - text: Remove pay forecast record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pay forecast
      effect: read
      questions:
      - What comments have been left on a timesheet pay forecast?
      - Can I see the comment history for a pay forecast?
      instructions:
      - text: List comments on pay forecast {id}.
        slots:
          id: path.id
      - text: Show the comment history for timesheet pay forecast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a pay forecast
      effect: write
      questions:
      - Can I add a comment to a timesheet pay forecast?
      - How do I annotate a pay forecast record?
      instructions:
      - text: Add comment {comment} to pay forecast {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment on timesheet pay forecast {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pay forecast
      effect: destructive
      questions:
      - Can I remove a comment from a timesheet pay forecast?
      - What deletes a comment on a pay forecast record?
      instructions:
      - text: Delete comment {comment_id} from pay forecast {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on timesheet pay forecast {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a pay forecast
      effect: read
      questions:
      - Who changed a timesheet pay forecast and when?
      - Can I see the full change history of a pay forecast?
      instructions:
      - text: Show the change history of pay forecast {id}.
        slots:
          id: path.id
      - text: List every change made to timesheet pay forecast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TimesheetPayForecast/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a pay forecast as it was at a past time
      effect: read
      questions:
      - What did a timesheet pay forecast look like before a change?
      - Can I travel back to a prior version of a pay forecast?
      instructions:
      - text: Show pay forecast {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to timesheet pay forecast {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-timesheetpayforecast-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.