Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employee Paycycle API
11 actions
11 updates
phrasing
extends
openapi/deputy-employeepaycycle-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/resource/EmployeePaycycle'].get
$.paths['/resource/EmployeePaycycle/INFO'].get
$.paths['/resource/EmployeePaycycle/PREDICT'].post
$.paths['/resource/EmployeePaycycle/QUERY'].post
$.paths['/resource/EmployeePaycycle/{id}'].get
$.paths['/resource/EmployeePaycycle/{id}/COMMENTS'].get
$.paths['/resource/EmployeePaycycle/{id}/COMMENTS'].post
$.paths['/resource/EmployeePaycycle/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeePaycycle/{id}/HISTORY'].get
$.paths['/resource/EmployeePaycycle/{id}/HISTORY/travel/{timestamp}'].get
OpenAPI Overlay
# 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 API
version: 1.0.0
extends: openapi/deputy-employeepaycycle-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/EmployeePaycycle'].get
update:
x-apievangelist-phrasing:
intent: List employee pay cycles
effect: read
questions:
- Which pay cycles have been processed for my employees?
- Can I see every employee pay cycle record?
instructions:
- text: List all employee pay cycles.
- text: Show every pay cycle record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get field metadata for employee pay cycles
effect: read
questions:
- What fields and types does an employee pay cycle record have?
- Which employee pay cycle fields can I query?
instructions:
- text: Show the field metadata for employee pay cycles.
- text: List the queryable fields on employee pay cycle records.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing employee pay cycle
effect: read
questions:
- Can I find an employee pay cycle that matches a partial record?
- Which existing pay cycle would a new record upsert against?
instructions:
- text: Find the existing employee pay cycle matching employee {employeeId} on agreement {employeeAgreementId} for period {periodId}.
slots:
employeeId: requestBody.EmployeeId
employeeAgreementId: requestBody.EmployeeAgreementId
periodId: requestBody.PeriodId
- text: Predict the employee pay cycle for {employeeId} on {employeeAgreementId} in {periodId} with pay approved {payApproved}.
slots:
employeeId: requestBody.EmployeeId
employeeAgreementId: requestBody.EmployeeAgreementId
periodId: requestBody.PeriodId
payApproved: requestBody.TimesheetsPayApproved
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search employee pay cycles
effect: read
questions:
- Can I search employee pay cycles by pay cycle rules?
- How do I find pay cycles exported to payroll?
instructions:
- text: Search employee pay cycles where pay cycle rules are {rules}.
slots:
rules: requestBody.search
- text: Find employee pay cycles exported to payroll with {exportId}.
slots:
exportId: requestBody.search
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee pay cycle
effect: read
questions:
- What are the details of one employee pay cycle?
- Can I fetch a single pay cycle record by id?
instructions:
- text: Get employee pay cycle {id}.
slots:
id: path.id
- text: Show the pay cycle record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an employee pay cycle
effect: read
questions:
- What comments have been left on an employee pay cycle?
- Can I read the notes on a pay cycle?
instructions:
- text: List comments on employee pay cycle {id}.
slots:
id: path.id
- text: Show the notes on pay cycle {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on an employee pay cycle
effect: write
questions:
- Can I add a comment to an employee pay cycle?
- How do I annotate a pay cycle record?
instructions:
- text: Comment {comment} on employee pay cycle {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: 'Add a note to pay cycle {id}: {comment}.'
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an employee pay cycle
effect: destructive
questions:
- Can I remove a comment from an employee pay cycle?
- How do I delete a note on a pay cycle?
instructions:
- text: Delete comment {commentId} from employee pay cycle {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove note {commentId} on pay cycle {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of an employee pay cycle
effect: read
questions:
- What changes have been made to an employee pay cycle?
- Can I see the edit history of a pay cycle?
instructions:
- text: Show the change history of employee pay cycle {id}.
slots:
id: path.id
- text: List edits made to pay cycle {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeePaycycle/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See an employee pay cycle as it was at a past time
effect: read
questions:
- What did an employee pay cycle look like before a change?
- Can I view a pay cycle as it existed at a past timestamp?
instructions:
- text: Show employee pay cycle {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to pay cycle {id} at {timestamp} and show it.
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employeepaycycle-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.