Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
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 49 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 9 operations across 6 paths, and defines 33 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

9 operations 6 paths 33 schemas 1 DELETE2 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Hint Health CustomerInvoice API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Practice access token or Partner API key (Bearer authentication)

Paths & Operations 9

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

CustomerInvoice 9
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

Schemas 33

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

Public.MembershipBlueprint_min
object
1 property
Public.LocationBlueprint_one
object
14 properties
Public.CompanySponsorshipBlueprint_for_patient
object
6 properties
Public.PatientBlueprint_min
object
2 properties
Public.CategoryBlueprint_one
object
4 properties
Public.MembershipMemberBlueprint_for_patient
object
8 properties
Public.LocationGroupBlueprint_leaf
object
5 properties
Public.ExternalRecordBlueprint_min
object
2 properties
Public.CompanyAccountBlueprint_min
object
1 property
Public.LocationBlueprint_shared
object
8 properties
Public.ChargeBlueprint_one
object
19 properties
Public.NpiBlueprint_shared
object
5 properties
Public.PractitionerBlueprint_one
object
21 properties
Public.ChargeItemBlueprint_one
object
10 properties
Public.PhoneBlueprint_leaf
object
2 properties
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.SpecialtyBlueprint_all
array
Public.KnownPracticeBlueprint_min
object
2 properties
Public.EmployeeDivisionBlueprint_leaf
object
2 properties
Public.CustomerInvoiceBlueprint_all
array
Common.PhoneBlueprint_shared
object
3 properties
Public.CompanyBlueprint_leaf
object
2 properties
Association
object
1 property 1 required
Public.PatientBlueprint_account
object
2 properties
Public.PdfBlueprint_one
object
1 property
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
Common.EmergencyContactBlueprint_shared
object
7 properties
Public.CustomerInvoiceBlueprint_one
object
24 properties
Public.LeadSourceBlueprint_one
object
4 properties
Public.MembershipPatientBlueprint_one
object
11 properties
Common.SocialSecurityNumberBlueprint_masked
object
1 property
Public.PlanBlueprint_min
object
3 properties
Public.PatientBlueprint_one
object
67 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