Hint Health CustomerInvoice API

The CustomerInvoice API from Hint Health — 6 operation(s) for customerinvoice.

Documentation GitHub OpenAPI

Business capability

Accounts Receivable Management BC-200.30

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /provider/customer_invoices Create a customer invoice · Create Customer Invoice #

Ask an LLM

“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?”

Tell an agent

Create a customer invoice for patient {patient}.

Start a new customer invoice owned by {owner} tied to integration record {integration_record_id}.

GET /provider/customer_invoices List customer invoices · List All Customer Invoices #

Ask an LLM

“Which customer invoices has my practice created recently?”

“Can I pull only the customer invoices updated since a certain date?”

Tell an agent

List all customer invoices for the practice.

List customer invoices updated after {updated_at}.

POST /provider/customer_invoices/{customer_invoice_id}/pdf Generate a PDF link for a customer invoice · Generate PDF for Customer Invoice #

Ask an LLM

“Can I get a downloadable PDF of a customer invoice?”

“How long does a generated invoice PDF link stay valid?”

Tell an agent

Generate a PDF download link for customer invoice {customer_invoice_id}.

Make me a fresh PDF of invoice {customer_invoice_id} to share with the patient.

DELETE /provider/customer_invoices/{id} Delete a customer invoice · Delete Customer Invoice #

Ask an LLM

“Can I permanently delete a customer invoice I created by mistake?”

“Is deleting a customer invoice different from voiding it?”

Tell an agent destructive · confirm first

Delete customer invoice {id}.

Remove the customer invoice {id} entirely.

GET /provider/customer_invoices/{id} Look up one customer invoice · Show Customer Invoice #

Ask an LLM

“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?”

Tell an agent

Show customer invoice {id}.

Check whether invoice {id} has been paid yet.

PATCH /provider/customer_invoices/{id} Update a customer invoice · Update Customer Invoice #

Ask an LLM

“Can I change which patient an existing customer invoice belongs to?”

“Is it possible to edit the owner on an invoice that already exists?”

Tell an agent

Change the patient on customer invoice {id} to {patient}.

Update invoice {id} so its owner is {owner}.

POST /provider/customer_invoices/{id}/issue Issue a draft customer invoice · Issue Customer Invoice #

Ask an LLM

“How do I finalize a draft invoice so it is issued to the patient?”

“What happens to a customer invoice when I issue it?”

Tell an agent

Issue customer invoice {id}.

Move draft invoice {id} to issued.

POST /provider/customer_invoices/{id}/return_to_draft Return a customer invoice to draft · Return Customer Invoice To Draft #

Ask an LLM

“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?”

Tell an agent

Return customer invoice {id} to draft.

Revert invoice {id} back to a draft and pull it out of revenue reports.

POST /provider/customer_invoices/{id}/void Void a customer invoice · Void Customer Invoice #

Ask an LLM

“Can I void a customer invoice instead of deleting it?”

“What is the way to cancel an invoice that was already issued?”

Tell an agent destructive · confirm first

Void customer invoice {id}.

Cancel invoice {id} by voiding it.

POST /provider/customer_invoices/{id}/send_email Email a customer invoice to the patient · Email Customer Invoice #

Ask an LLM

“Can I email an API-generated invoice to the patient from Hint?”

“Why would sending an invoice email return a 422 error?”

Tell an agent

Email customer invoice {id} to its patient.

Send the invoice {id} to the patient by email.

Hint Health CustomerInvoice API

Operations 10

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification