# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Payroll Runs API
  version: 1.0.0
extends: openapi/bindbee-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: 2
- target: $.paths['/api/hris/v1/payroll-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List company payroll runs
      effect: read
      questions:
      - Which payroll runs were processed for a pay group?
      - Can I filter payroll runs by type, like regular or off-cycle, or by state?
      - Which payroll runs had check dates in a given range?
      instructions:
      - text: List payroll runs for pay group {pay_group_id}.
        slots:
          pay_group_id: query.pay_group_id
      - text: Show {run_type} payroll runs in state {run_state}.
        slots:
          run_type: query.run_type
          run_state: query.run_state
      - text: Find 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/payroll-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one payroll run
      effect: read
      questions:
      - What are the dates and status of one payroll run?
      - Can I fetch a single company payroll run by id?
      instructions:
      - text: Get payroll run {id}.
        slots:
          id: path.id
      - text: Retrieve payroll run {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'