# 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 API version: 1.0.0 extends: openapi/hint-health-customerinvoice-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: 10 - target: $.paths['/provider/customer_invoices'].get update: x-apievangelist-phrasing: intent: List customer invoices effect: read questions: - Which customer invoices has my practice created recently? - Can I pull only the customer invoices updated since a certain date? instructions: - text: List all customer invoices for the practice. - text: List customer invoices updated after {updated_at}. slots: updated_at: query.updated_at - text: Show customer invoices created on or after {created_at}. slots: created_at: query.created_at method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices'].post update: x-apievangelist-phrasing: intent: Create a customer invoice effect: write questions: - How do I create a new invoice for a patient through the API? - Can I link a newly created customer invoice to a record in my own system? instructions: - text: Create a customer invoice for patient {patient}. slots: patient: requestBody.patient - text: Start a new customer invoice owned by {owner} tied to integration record {integration_record_id}. slots: owner: requestBody.owner integration_record_id: requestBody.integration_record_id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{customer_invoice_id}/pdf'].post update: x-apievangelist-phrasing: intent: Generate a PDF link for a customer invoice effect: write questions: - Can I get a downloadable PDF of a customer invoice? - How long does a generated invoice PDF link stay valid? instructions: - text: Generate a PDF download link for customer invoice {customer_invoice_id}. slots: customer_invoice_id: path.customer_invoice_id - text: Make me a fresh PDF of invoice {customer_invoice_id} to share with the patient. slots: customer_invoice_id: path.customer_invoice_id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}'].get update: x-apievangelist-phrasing: intent: Look up one customer invoice effect: read questions: - What status is a specific customer invoice in, paid or disputed or still a draft? - Where can I see the full details of a single customer invoice? instructions: - text: Show customer invoice {id}. slots: id: path.id - text: Check whether invoice {id} has been paid yet. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a customer invoice effect: destructive questions: - Can I permanently delete a customer invoice I created by mistake? - Is deleting a customer invoice different from voiding it? instructions: - text: Delete customer invoice {id}. slots: id: path.id - text: Remove the customer invoice {id} entirely. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}'].patch update: x-apievangelist-phrasing: intent: Update a customer invoice effect: write questions: - Can I change which patient an existing customer invoice belongs to? - Is it possible to edit the owner on an invoice that already exists? instructions: - text: Change the patient on customer invoice {id} to {patient}. slots: id: path.id patient: requestBody.patient - text: Update invoice {id} so its owner is {owner}. slots: id: path.id owner: requestBody.owner - text: Set integration record {integration_record_id} on existing invoice {id}. slots: id: path.id integration_record_id: requestBody.integration_record_id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}/issue'].post update: x-apievangelist-phrasing: intent: Issue a draft customer invoice effect: write questions: - How do I finalize a draft invoice so it is issued to the patient? - What happens to a customer invoice when I issue it? instructions: - text: Issue customer invoice {id}. slots: id: path.id - text: Move draft invoice {id} to issued. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}/return_to_draft'].post update: x-apievangelist-phrasing: intent: Return a customer invoice to draft effect: write questions: - Can I put an issued invoice back into draft so I can fix it? - Why can't I return an invoice to draft once it has payments or a locked reporting period? instructions: - text: Return customer invoice {id} to draft. slots: id: path.id - text: Revert invoice {id} back to a draft and pull it out of revenue reports. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}/void'].post update: x-apievangelist-phrasing: intent: Void a customer invoice effect: destructive questions: - Can I void a customer invoice instead of deleting it? - What is the way to cancel an invoice that was already issued? instructions: - text: Void customer invoice {id}. slots: id: path.id - text: Cancel invoice {id} by voiding it. slots: id: path.id method: generated generated: '2026-10-01' - target: $.paths['/provider/customer_invoices/{id}/send_email'].post update: x-apievangelist-phrasing: intent: Email a customer invoice to the patient effect: write questions: - Can I email an API-generated invoice to the patient from Hint? - Why would sending an invoice email return a 422 error? instructions: - text: Email customer invoice {id} to its patient. slots: id: path.id - text: Send the invoice {id} to the patient by email. slots: id: path.id method: generated generated: '2026-10-01'