# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Invoice Payment API
  version: 1.0.0
extends: openapi/hint-health-invoicepayment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/provider/companies/{company_id}/invoices/{invoice_id}/payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a company invoice
      effect: read
      questions:
      - Which payments have been applied to an employer company's invoice?
      - What is the payment history of a company invoice?
      instructions:
      - text: List payments on invoice {invoice_id} for company {company_id}.
        slots:
          invoice_id: path.invoice_id
          company_id: path.company_id
      - text: Show all payments made against company {company_id}'s invoice {invoice_id}.
        slots:
          company_id: path.company_id
          invoice_id: path.invoice_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/invoices/{invoice_id}/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a payment on a company invoice
      effect: write
      questions:
      - How do I record a check or external payment against a company invoice?
      - Can I process a payment on a company invoice instead of just recording it?
      instructions:
      - text: Record a payment of {amount_in_cents} cents on invoice {invoice_id} for company {company_id}.
        slots:
          amount_in_cents: requestBody.amount_in_cents
          invoice_id: path.invoice_id
          company_id: path.company_id
      - text: Log an external payment paid at {paid_at} on company {company_id}'s invoice {invoice_id} with memo {memo}.
        slots:
          paid_at: requestBody.paid_at
          company_id: path.company_id
          invoice_id: path.invoice_id
          memo: requestBody.memo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/invoices/{invoice_id}/payments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one payment on a company invoice
      effect: read
      questions:
      - Can I look up a single payment applied to a company invoice?
      - What amount and date are on a specific invoice payment?
      instructions:
      - text: Show payment {id} on invoice {invoice_id} for company {company_id}.
        slots:
          id: path.id
          invoice_id: path.invoice_id
          company_id: path.company_id
      - text: Get details of payment {id} against company {company_id}'s invoice {invoice_id}.
        slots:
          id: path.id
          company_id: path.company_id
          invoice_id: path.invoice_id
      method: generated
      generated: '2026-10-01'