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

Huma Billing API

The Billing API from Huma — 40 operation(s) for billing.

Huma Billing API is one of 77 APIs that Huma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

This API exposes 46 operations across 40 paths, and defines 139 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://workspace-gcp-uk.api.huma.com/api/integration/v1.

46 operations 40 paths 139 schemas 5 DELETE17 GET3 PATCH18 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://workspace-gcp-uk.api.huma.com/api/integration/v1
Authentication
API Key, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Huma Billing API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (Hawk_Auth). It accepts HTTP bearer tokens (JWT) (JWT_Auth). It accepts HTTP bearer tokens (JWT) (jwtAuth).

  • Hawk_Auth — Hawk MAC authentication. Paste a full Authorization header value. Example: Authorization: Hawk id="userId:clientId", ts=" ", nonce=" ", mac=" "[, hash=" "][, e…
  • JWT_Auth — Use HTTP Bearer auth with a JWT. Send the token in the Authorization header: Authorization: Bearer The token should contain standard claims plus projectId and…

Paths & Operations 46

Across 40 paths, the API surfaces 46 operations — 5 DELETE, 17 GET, 3 PATCH, 18 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Billing 46
GET
/api/extensions/v1/billing/log-actions
Retrieve Billing Monitoring Log Action List
api_extensions_v1_billing_log_actions_retrieve_[retrieve_billing_monitoring_log_action_list] → 200
POST
/api/extensions/v1/billing/profiles
Retrieve Billing Alerts
api_extensions_v1_billing_profiles_create_[retrieve_billing_alerts] → 200
GET
/api/extensions/v1/billing/user/{user_id}
Calculate Cumulative Monitoring Time And Cpt Code
api_extensions_v1_billing_user_retrieve_[calculate_cumulative_monitoring_time_and_cpt_code] 1 param → 200
POST
/api/extensions/v1/billing/user/{user_id}
Create Billing Remote Time Tracking
api_extensions_v1_billing_user_create_[create_billing_remote_time_tracking] 1 param body → 201
POST
/api/extensions/v1/billing/user/{user_id}/log
Create Billing Monitoring Log
api_extensions_v1_billing_user_log_create_[create_billing_monitoring_log] 1 param → 200
PUT
/api/extensions/v1/billing/user/{user_id}/log/{log_id}
Update Billing Monitoring Log
api_extensions_v1_billing_user_log_update_[update_billing_monitoring_log] 2 params → 200
DELETE
/api/extensions/v1/billing/user/{user_id}/log/{log_id}
Delete Billing Monitoring Log
api_extensions_v1_billing_user_log_destroy_[delete_billing_monitoring_log] 2 params → 200
POST
/api/extensions/v1/billing/user/{user_id}/logs
Retrieve Billing Monitoring Logs
api_extensions_v1_billing_user_logs_create_[retrieve_billing_monitoring_logs] 1 param body → 200
GET
/api/extensions/v1/billing/user/{user_id}/report
Report Billing Records For Cpt
api_extensions_v1_billing_user_report_retrieve_[report_billing_records_for_cpt] 1 param → 200
POST
/api/extensions/v1/export/
Export
api_extensions_v1_export_create_[export] → 200
POST
/api/extensions/v1/export/deployment/{deployment_id}
Export Deployment
api_extensions_v1_export_deployment_create_[export_deployment] 1 param → 200
POST
/api/extensions/v1/integration/billing_test
Manually Run Billing
api_extensions_v1_integration_billing_test_create_[manually_run_billing] body → 200
POST
/api/extensions/v1/integration/fetch_referring_providers
Manually Fetch Referring Providers
api_extensions_v1_integration_fetch_referring_providers_create_[manually_fetch_referring_providers] body → 200
GET
/api/v1/billing-portal/bill/{billId}/charge/{chargeId}
Get Billing Charge Record
api_v1_billing_portal_bill_charge_retrieve_[get_billing_charge_record] 3 params → 200
DELETE
/api/v1/billing-portal/bill/{billId}/charges/delete
Delete Billing Charge Record
api_v1_billing_portal_bill_charges_delete_destroy_[delete_billing_charge_record] 1 param → 200
PATCH
/api/v1/billing-portal/bill/{bill_id}/{charge_id}
Update Billing Charge Record
api_v1_billing_portal_bill_partial_update_[update_billing_charge_record] 2 params body → 200
POST
/api/v1/billing-portal/bill/{bill_id}/charges
Create Billing Charges Records
api_v1_billing_portal_bill_charges_create_[create_billing_charges_records] 1 param body → 200
PUT
/api/v1/billing-portal/billing/{bill_id}/charge
Create Billing Charge Record
api_v1_billing_portal_billing_charge_update_[create_billing_charge_record] 1 param body → 200
POST
/api/v1/billing-portal/call-export-task
Call Export Task
api_v1_billing_portal_call_export_task_create_[call_export_task] 3 params → 202
GET
/api/v1/billing-portal/client-medical-records
Get Client Medical Record
api_v1_billing_portal_client_medical_records_retrieve_[get_client_medical_record] 3 params → 200
POST
/api/v1/billing-portal/clients
Add Client
api_v1_billing_portal_clients_create_[add_client] body → 201
POST
/api/v1/billing-portal/clients/filter
Get Clients Endpoint
api_v1_billing_portal_clients_filter_create_[get_clients_endpoint] body → 200
PATCH
/api/v1/billing-portal/cpt/billing/submitted
Update Billing Submitted Flag
api_v1_billing_portal_cpt_billing_submitted_partial_update_[update_billing_submitted_flag] body → 200
POST
/api/v1/billing-portal/cpt/months
Get Cpt Months
api_v1_billing_portal_cpt_months_create_[get_cpt_months] body → 200
GET
/api/v1/billing-portal/cpt/profiles
Get Cpt Profiles
api_v1_billing_portal_cpt_profiles_retrieve_[get_cpt_profiles] 8 params → 200
POST
/api/v1/billing-portal/deployment-client/
Add Deployment Client
api_v1_billing_portal_deployment_client_create_[add_deployment_client] body → 201
PUT
/api/v1/billing-portal/deployment-client/
Update Deployment Client
api_v1_billing_portal_deployment_client_update_[update_deployment_client] body → 200
DELETE
/api/v1/billing-portal/deployment-client/
Delete Deployment Client
api_v1_billing_portal_deployment_client_destroy_[delete_deployment_client] → 200
DELETE
/api/v1/billing-portal/export-data
Delete Export
api_v1_billing_portal_export_data_destroy_[delete_export] 3 params → 204
GET
/api/v1/billing-portal/export/cpt/profiles
Export Cpt Profile Overview
api_v1_billing_portal_export_cpt_profiles_retrieve_[export_cpt_profile_overview] 9 params → 200
POST
/api/v1/billing-portal/export/invoice/client
Export Invoice Details Csv
api_v1_billing_portal_export_invoice_client_create_[export_invoice_details_csv] body → 200
GET
/api/v1/billing-portal/export/invoice/overview
Export Invoices Overview To Csv
api_v1_billing_portal_export_invoice_overview_retrieve_[export_invoices_overview_to_csv] 8 params → 200
GET
/api/v1/billing-portal/generate/billing_and_invoices/
Generate Reports
api_v1_billing_portal_generate_billing_and_invoices_retrieve_[generate_reports] 1 param → 200
GET
/api/v1/billing-portal/get-clients-invoices
Get Clients Invoices
api_v1_billing_portal_get_clients_invoices_retrieve_[get_clients_invoices] 1 param → 200
POST
/api/v1/billing-portal/import/salesforce
Add Sales Force File
api_v1_billing_portal_import_salesforce_create_[add_sales_force_file] → 200
GET
/api/v1/billing-portal/import/salesforce/
Download Sales Force File
api_v1_billing_portal_import_salesforce_retrieve_[download_sales_force_file] 1 param → 200
POST
/api/v1/billing-portal/invoice/client
Get Client Invoice Details
api_v1_billing_portal_invoice_client_create_[get_client_invoice_details] body → 200
GET
/api/v1/billing-portal/invoice/overview
Get Invoices Overview
api_v1_billing_portal_invoice_overview_retrieve_[get_invoices_overview] 7 params → 200
GET
/api/v1/billing-portal/patient-medical-records
Get Patient Medical Record
api_v1_billing_portal_patient_medical_records_retrieve_[get_patient_medical_record] 3 params → 200
GET
/api/v1/billing-portal/patient-medical-records/all/pdf
Get Patient Medical Record All Pdf
api_v1_billing_portal_patient_medical_records_all_pdf_retrieve_[get_patient_medical_record_all_pdf] 2 params → 200
GET
/api/v1/billing-portal/patient-medical-records/pdf
Get Patient Medical Record Pdf
api_v1_billing_portal_patient_medical_records_pdf_retrieve_[get_patient_medical_record_pdf] 3 params → 200
GET
/api/v1/billing-portal/performance
Get Performance Overview
api_v1_billing_portal_performance_retrieve_[get_performance_overview] 7 params → 200
POST
/api/v1/billing-portal/record
Create Billing Record
api_v1_billing_portal_record_create_[create_billing_record] body → 200
GET
/api/v1/billing-portal/record/{bill_id}
Get Billing Record
api_v1_billing_portal_record_retrieve_[get_billing_record] 1 param → 200
PATCH
/api/v1/billing-portal/record/{bill_id}
Update Billing Record
api_v1_billing_portal_record_partial_update_[update_billing_record] 1 param body → 204
DELETE
/api/v1/billing-portal/record/{bill_id}
Delete Billing Record
api_v1_billing_portal_record_destroy_[delete_billing_record] 1 param → 200

Schemas 139

The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are UserDTODRF (79 properties), DeploymentDTODRF (56 properties), ProfileFieldsDRF (31 properties), FeaturesDRF (30 properties). Each schema is shown below with its type and property counts.

OffBoardingReasonsDRF
object
2 properties
UIWidgetDRF
object
5 properties 3 required
DeploymentStatsDRF
object
6 properties
RetrieveClientsRequestObjectDRF
object
4 properties
ModuleConfigDRF
object
25 properties 1 required
SurgeryDetailItemDRF
object
3 properties 2 required
RecentFlagsDRF
object
4 properties
GetBillingRecordResponseObjectDRF
object
20 properties
UserStatsDRF
object
2 properties
FeaturesDRF
object
30 properties
SsoDRF
object
3 properties
CreateBillingRequestBodyDRF
object
2 properties
SurgeryDetailsDRF
object
3 properties
CalculateCumulativeMonitoringTimeResponseObjectDRF
object
5 properties 5 required
PAMIntegrationConfigDRF
object
5 properties 5 required
RetrieveBillingMonitoringLogsRequestBodyDRF
object
2 properties
UpsertBillingRecordRequestObjectDRF
object
17 properties 2 required
RetrieveClientsResponseObjectDRF
object
4 properties
CPTProfileEntryDRF
object
18 properties
ClientDTODRF
object
3 properties
ManagerNotificationsDRF
object
1 property
RetrieveInvoiceOverviewResponseObjectDRF
object
4 properties
AddSalesForceFileResponseObjectDRF
object
2 properties
TriggerTaskResponseObjectDRF
object
1 property
UITabDRF
object
13 properties 5 required
UnseenFlagsDRF
object
4 properties
DeploymentLevelConfigurationDRF
object
4 properties
AddClientDeploymentRequestObjectDRF
object
2 properties
DeviceIntegrationDRF
object
1 property
AppendChargeToBillRequestObjectDRF
object
2 properties
FileFieldDRF
object
1 property 1 required
UserLabelDRF
object
3 properties
RetrieveClientsInvoicesResponseObjectDRF
object
4 properties
PeriodProgressDRF
object
5 properties
LabelDRF
object
8 properties
ResponseBillingMonitoringLogDTODRF
object
18 properties 3 required
BackgroundDRF
object
2 properties 2 required
PassedDueDateEventsAmountDRF
object
2 properties
SdkConfigDRF
object
5 properties
ThresholdRangeDRF
object
3 properties
PerformanceMonitoringOverviewResponseRowObjectDRF
object
10 properties
IntegrationDeviceDRF
object
7 properties 2 required
UserDTODRF
object
79 properties
KeyActionConfigDRF
object
18 properties 4 required
BuilderDRF
object
1 property
SsoInfoDRF
object
16 properties 4 required
EmailTemplateDRF
object
3 properties 2 required
PatientPersonalizationDRF
object
2 properties
DeviceManufacturerDRF
object
4 properties 1 required
ConsentDRF
object
13 properties 1 required
DeploymentInfoDRF
object
5 properties 2 required
AdditionalContactDetailsDRF
object
5 properties
TaskComplianceDRF
object
5 properties
MoveUserReasonsDRF
object
2 properties
AuthorisedRepDRF
object
4 properties 4 required
StaticEventDRF
object
4 properties 3 required
SecurityDRF
object
2 properties 2 required
FootnoteDRF
object
3 properties
OnboardingModuleConfigDTODRF
object
15 properties 2 required
TriggerTaskRequestObjectDRF
object
2 properties
FeedbackTextsDRF
object
2 properties
GenderOptionTypeDRF
object
3 properties 2 required
StudyProgressDRF
object
5 properties
S3ObjectDRF
object
3 properties 2 required
PerformanceReadingOverviewResponseRowObjectDRF
object
10 properties
SummaryReportDRF
object
1 property
UpdateChargeUnitRequestObjectDRF
object
3 properties 3 required
CPTReportResponseObjectDRF
object
9 properties 3 required
UnreadMessagesCountDRF
object
2 properties
ConsentSignatureDRF
object
7 properties 4 required
PatchedUpdateIsSubmittedRequestObjectDRF
object
2 properties
AdditionalConsentQuestionDRF
object
7 properties 4 required
UpdateIsSubmittedResponseObjectDRF
object
2 properties
MessagingDRF
object
5 properties
ModuleGoalCreatedByDRF
object
2 properties
LocationDRF
object
9 properties
ReasonDRF
object
3 properties 2 required
EmailConfigDRF
object
2 properties
RagThresholdDRF
object
8 properties 6 required
ClientInvoiceDetailsRequestObjectDRF
object
5 properties 1 required
SeverityFilterDRF
object
2 properties 2 required
FeedbackTextDRF
object
3 properties 2 required
ResearchTeamActionsDRF
object
1 property
ListIdResponseObjectDRF
object
1 property
ConsentReviewDRF
object
3 properties 2 required
SurgeryDetailDRF
object
4 properties 2 required
ResultIdResponseObjectDRF
object
1 property
DeploymentDTODRF
object
56 properties
ClinicianOnlyFieldsDRF
object
1 property
ProfileFieldsDRF
object
31 properties
DeleteChargeResponseObjectDRF
object
1 property
IntegrationConfigDRF
object
1 property
ProfileExtraIdsDRF
object
8 properties
AdditionalContactDetailsItemDRF
object
6 properties
StaticEventConfigDRF
object
3 properties 2 required
CptChargeUnitObjectDRF
object
6 properties
AddClientRequestObjectDRF
object
3 properties 2 required
StatDRF
object
2 properties 1 required
ClientMedicalRecordResponseObjectDRF
object
1 property
ModuleScheduleDRF
object
6 properties
DeleteBillingRecordResponseObjectDRF
object
2 properties
LearnSectionDRF
object
7 properties
BoardingStatusDRF
object
5 properties 1 required
PatchedChargeUnitRecordRequestObjectDRF
object
5 properties
EConsentSectionDRF
object
11 properties 2 required
LearnDRF
object
5 properties
ProfileDRF
object
3 properties
FeedbackConfigDRF
object
9 properties 1 required
FeedBacksGroupedByRagDRF
object
2 properties 2 required
ConsentSectionOptionsDRF
object
5 properties 2 required
ConsentSectionDRF
object
6 properties 1 required
PerformanceOverviewResponseObjectDRF
object
5 properties
PersonalDocumentDRF
object
6 properties 3 required
FeedbackNotificationDataDRF
object
5 properties
RoleDTODRF
object
5 properties
RetrieveAvailableMonthsResponseObjectDRF
object
4 properties
UpdateClientDeploymentRequestObjectDRF
object
2 properties
SurgeryDateRuleDRF
object
2 properties
GetCPTProfilesResponseObjectDRF
object
1 property
ChargeUnitRecordRequestObjectDRF
object
5 properties 2 required
EConsentDRF
object
16 properties 5 required
NotificationDataDRF
object
4 properties
RoleAssignmentDTODRF
object
4 properties 2 required
UserSurgeryDetailsDRF
object
3 properties
LearnArticleDRF
object
9 properties 2 required
ExportClientInvoiceDetailsRequestObjectDRF
object
6 properties 1 required
ClientInvoiceDetailRowObjectDRF
object
13 properties
EthnicityOptionDRF
object
3 properties 2 required
VariabilityFilterDRF
object
4 properties
LearnArticleContentDRF
object
12 properties 1 required
OkResponseDRF
object
1 property
UpsertBillingRecordResponseObjectDRF
object
2 properties
PatchedUpdateBillingRecordRequestObjectDRF
object
18 properties
MedicalRecordEntryDRF
object
6 properties
RetrieveAvailableMonthsRequestObjectDRF
object
7 properties
ModuleGoalDTODRF
object
9 properties
InvoiceOverViewReportRowDTODRF
object
9 properties 1 required
BillingMonitoringLogsResponseObjectDRF
object
4 properties 2 required
AddressObjectDRF
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huma-billing-api-openapi.yml Raw ↑

Other APIs Huma publishes across the network.

Huma Mobile & Web SDK
Huma AI Engine API
Huma Appointment API
Huma Assets API
Huma Audit Log API
Huma Auth API
Huma Authorization Admin API
Huma Autocomplete API
Huma Billing Portal Route API
Huma Builder API
Huma Calendar Route API
Huma CMS API
Where this information came from

This is an independent, third-party profile of Huma Billing 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.