# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Employee Payroll Runs API
  version: 1.0.0
extends: openapi/bindbee-employee-payroll-runs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/api/hris/v1/employee-payroll-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees' payroll results
      effect: read
      questions:
      - What did a specific employee get paid in each payroll run?
      - Can I list every employee's pay results within one payroll run?
      - Which employee payroll runs have check dates in a given range?
      instructions:
      - text: List payroll results for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show per-employee results for payroll run {payroll_run_id}.
        slots:
          payroll_run_id: query.payroll_run_id
      - text: Find employee payroll runs with check dates between {check_date_from} and {check_date_to}.
        slots:
          check_date_from: query.check_date_from
          check_date_to: query.check_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employee-payroll-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employee payroll run record
      effect: write
      questions:
      - How do I write an employee's payroll result into the connected system?
      - Can I send an idempotency key when creating an employee payroll run?
      instructions:
      - text: Create an employee payroll run with idempotency key {idempotency_key}.
        slots:
          idempotency_key: header.x-idempotency-key
      - text: Record a new employee payroll run on connector {connector}.
        slots:
          connector: header.x-connector-token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employee-payroll-runs/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employee payroll run request schema
      effect: read
      questions:
      - What request body does creating an employee payroll run expect?
      - Can I see the schema for POST employee payroll run before sending one?
      instructions:
      - text: Get the employee payroll run request schema for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Show the fields needed to create an employee payroll run.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employee-payroll-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee payroll run
      effect: read
      questions:
      - What earnings, deductions and taxes are in one employee's payroll run?
      - Can I fetch a single employee payroll run by id?
      instructions:
      - text: Get employee payroll run {id}.
        slots:
          id: path.id
      - text: Open employee payroll run {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'