How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hint Health CustomerInvoice API

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

Hint Health CustomerInvoice API is one of 67 APIs that Hint Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CustomerInvoice. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.hint.com/api, https://api.sandbox.hint.com/api.

10 operations 7 paths 39 schemas 1 DELETE2 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.hint.com
Authentication
HTTP Bearer, API Key
License
Private
Terms of Service
Resource Areas
1

Authentication & Security 2

Hint Health CustomerInvoice API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as AUTHORIZATION (hint_api_key).

  • BearerAuth — Practice access token or Partner API key (Bearer authentication)
  • hint_api_key — Enter your token in the format: Bearer {yourapikey}

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

CustomerInvoice 10
POST
/provider/customer_invoices
Create Customer Invoice
CustomerInvoice.CreateCustomerInvoice body → 200
GET
/provider/customer_invoices
List All Customer Invoices
CustomerInvoice.ListAllCustomerInvoices 2 params → 200
POST
/provider/customer_invoices/{customer_invoice_id}/pdf
Generate PDF for Customer Invoice
CustomerInvoice.CreatePDF 1 param → 200
DELETE
/provider/customer_invoices/{id}
Delete Customer Invoice
CustomerInvoice.DeleteCustomerInvoice 1 param → 204
GET
/provider/customer_invoices/{id}
Show Customer Invoice
CustomerInvoice.ShowCustomerInvoice 1 param → 200
PATCH
/provider/customer_invoices/{id}
Update Customer Invoice
CustomerInvoice.UpdateCustomerInvoice 1 param body → 200
POST
/provider/customer_invoices/{id}/issue
Issue Customer Invoice
CustomerInvoice.IssueCustomerInvoice 1 param → 200
POST
/provider/customer_invoices/{id}/return_to_draft
Return Customer Invoice To Draft
CustomerInvoice.ReturnToDraft 1 param → 200
POST
/provider/customer_invoices/{id}/void
Void Customer Invoice
CustomerInvoice.VoidCustomerInvoice 1 param → 200
POST
/provider/customer_invoices/{id}/send_email
Email Customer Invoice
CustomerInvoice.SendCustomerInvoiceEmail 1 param → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Public.PatientBlueprint_one (67 properties), Public.CustomerInvoiceBlueprint_one_2 (25 properties), Public.CustomerInvoiceBlueprint_one (24 properties), Public.PractitionerBlueprint_one (21 properties). Each schema is shown below with its type and property counts.

Public.CompanySponsorshipBlueprint_for_patient
object
6 properties
Public.SpecialtyBlueprint_all
array
Public.PatientBlueprint_one
object
67 properties
Public.PatientBlueprint_account
object
2 properties
Public.ExternalRecordBlueprint_min
object
2 properties
Public.MembershipMemberBlueprint_for_patient
object
8 properties
Public.CompanyAccountBlueprint_min
object
1 property
Public.ChargeItemBlueprint_one
object
10 properties
Public.MembershipBlueprint_min
object
1 property
Public.CategoryBlueprint_one
object
4 properties
Common.SocialSecurityNumberBlueprint_masked
object
1 property
Provider.CustomerInvoicesController.create_body
object
Owner or patient or both must be provided. If you do not specify owner, we will either use the patient's last payer, or the patient themselves
3 properties
Public.CustomerInvoiceBlueprint_all
array
Public.ChargeBlueprint_one
object
19 properties
Public.LeadSourceBlueprint_one
object
4 properties
Public.PhoneBlueprint_leaf
object
2 properties
Public.PatientBlueprint_min
object
2 properties
Association
object
1 property 1 required
Public.CustomerInvoiceBlueprint_one
object
24 properties
Public.NpiBlueprint_shared
object
5 properties
Public.KnownPracticeBlueprint_min
object
2 properties
Public.LocationBlueprint_shared
object
8 properties
Public.CompanyBlueprint_leaf
object
2 properties
Public.LocationBlueprint_one
object
14 properties
Public.PdfBlueprint_one
object
1 property
Common.PhoneBlueprint_shared
object
3 properties
Public.MembershipPatientBlueprint_one
object
11 properties
Public.PlanBlueprint_min
object
3 properties
Common.EmergencyContactBlueprint_shared
object
7 properties
Public.PractitionerBlueprint_one
object
21 properties
Provider.CustomerInvoicesController.update_body
object
Owner or patient or both must be provided. If you do not specify owner, we will either use the patient's last payer, or the patient themselves
3 properties
Public.LocationGroupBlueprint_leaf
object
5 properties
Public.EmployeeDivisionBlueprint_leaf
object
2 properties
Public.MembershipMemberBlueprint_for_patient_2
object
9 properties
Provider.CustomerInvoicesController.create_body_2
object
Owner or patient or both must be provided. If you do not specify owner, we will either use the patient's last payer, or the patient themselves
4 properties
Public.CustomerInvoiceBlueprint_all_2
array
Public.CustomerInvoiceBlueprint_one_2
object
25 properties
Common.EmergencyContactBlueprint_shared_2
object
8 properties
Provider.CustomerInvoicesController.update_body_2
object
Owner or patient or both must be provided. If you do not specify owner, we will either use the patient's last payer, or the patient themselves
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hint-health-customerinvoice-api-openapi.yml Raw ↑

Other APIs Hint Health publishes across the network.

Hint Health AccountAccessToken API
Hint Health Affiliate API
Hint Health AffiliateBill API
Hint Health AffiliatePatient API
Hint Health CancellationReason API
Hint Health Charge API
Hint Health ChargeItem API
Hint Health ClinicalNoteInteraction API
Hint Health Company API
Hint Health CompanyPlan API
Hint Health Coupon API
Hint Health Credit API
Where this information came from

This is an independent, third-party profile of Hint Health CustomerInvoice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.