Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Customer Invoice Payment API

4 actions 4 updates phrasing extends openapi/hint-health-customerinvoicepayment-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Hint Health's API. It is a proposal applied on top of the contract, not a document Hint Health publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/provider/customer_invoices/{customer_invoice_id}/payments'].get

$.paths['/provider/customer_invoices/{customer_invoice_id}/payments'].post

$.paths['/provider/customer_invoices/{customer_invoice_id}/payments/{id}'].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 Hint Health Customer Invoice Payment API
  version: 1.0.0
extends: openapi/hint-health-customerinvoicepayment-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/customer_invoices/{customer_invoice_id}/payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a customer invoice
      effect: read
      questions:
      - What payments have been made against a customer invoice?
      - Can I see the payment history for one invoice?
      instructions:
      - text: List payments on customer invoice {customer_invoice_id}.
        slots:
          customer_invoice_id: path.customer_invoice_id
      - text: Show all payments recorded for invoice {customer_invoice_id}.
        slots:
          customer_invoice_id: path.customer_invoice_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/customer_invoices/{customer_invoice_id}/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a payment on a customer invoice
      effect: write
      questions:
      - How do I record a payment the patient made outside the system?
      - Can I apply a partial payment amount to a customer invoice?
      instructions:
      - text: Record a payment of {amount_in_cents} cents on invoice {customer_invoice_id}.
        slots:
          amount_in_cents: requestBody.amount_in_cents
          customer_invoice_id: path.customer_invoice_id
      - text: Log an external payment on invoice {customer_invoice_id} paid at {paid_at} with memo {memo}.
        slots:
          customer_invoice_id: path.customer_invoice_id
          paid_at: requestBody.paid_at
          memo: requestBody.memo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/customer_invoices/{customer_invoice_id}/payments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one invoice payment
      effect: read
      questions:
      - What are the details of a specific payment on an invoice?
      - When was a particular invoice payment made?
      instructions:
      - text: Show payment {id} on customer invoice {customer_invoice_id}.
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
      - text: Get details of payment {id} for invoice {customer_invoice_id}.
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
      method: generated
      generated: '2026-10-01'