# 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 Charge API
  version: 1.0.0
extends: openapi/hint-health-customerinvoicecharge-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}/charges'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a line charge to a customer invoice
      effect: write
      questions:
      - How do I add a charge line to a patient's customer invoice?
      - Can I tag an invoice charge with a practitioner, location or category?
      instructions:
      - text: Add {quantity} x {name} at {price_in_cents} cents to customer invoice {customer_invoice_id}.
        slots:
          quantity: requestBody.quantity
          name: requestBody.name
          price_in_cents: requestBody.price_in_cents
          customer_invoice_id: path.customer_invoice_id
      - text: Charge {name}, quantity {quantity} at {price_in_cents} cents, on invoice {customer_invoice_id} for patient {patient}.
        slots:
          name: requestBody.name
          quantity: requestBody.quantity
          price_in_cents: requestBody.price_in_cents
          customer_invoice_id: path.customer_invoice_id
          patient: requestBody.patient
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/customer_invoices/{customer_invoice_id}/charges/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a charge from a customer invoice
      effect: destructive
      questions:
      - Can I delete a wrong line item from a customer invoice?
      - Can I take a charge off an invoice before it is paid?
      instructions:
      - text: Delete charge {id} from customer invoice {customer_invoice_id}.
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
      - text: Remove line item {id} on invoice {customer_invoice_id}.
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/customer_invoices/{customer_invoice_id}/charges/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a charge on a customer invoice
      effect: write
      questions:
      - How do I change the price or quantity of a charge already on an invoice?
      - Can I fix the name of an existing invoice line item?
      instructions:
      - text: Update charge {id} on customer invoice {customer_invoice_id} to {quantity} x {name} at {price_in_cents} cents.
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
          quantity: requestBody.quantity
          name: requestBody.name
          price_in_cents: requestBody.price_in_cents
      - text: 'Reprice existing line {id} on invoice {customer_invoice_id}: {name}, quantity {quantity}, {price_in_cents} cents each.'
        slots:
          id: path.id
          customer_invoice_id: path.customer_invoice_id
          name: requestBody.name
          quantity: requestBody.quantity
          price_in_cents: requestBody.price_in_cents
      method: generated
      generated: '2026-10-01'