Huma Billing API

openapi: 3.2.0
info:
  title: Huma Platform Billing API
  version: 1.0.0
  description: Huma Platform
servers:
- url: https://workspace-gcp-uk.api.huma.com/api/integration/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Billing
paths:
  /api/extensions/v1/billing/log-actions:
    get:
      operationId: api_extensions_v1_billing_log_actions_retrieve_[retrieve_billing_monitoring_log_action_list]
      summary: Retrieve Billing Monitoring Log Action List
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/billing/profiles:
    post:
      operationId: api_extensions_v1_billing_profiles_create_[retrieve_billing_alerts]
      summary: Retrieve Billing Alerts
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/billing/user/{user_id}:
    get:
      operationId: api_extensions_v1_billing_user_retrieve_[calculate_cumulative_monitoring_time_and_cpt_code]
      summary: Calculate Cumulative Monitoring Time And Cpt Code
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateCumulativeMonitoringTimeResponseObjectDRF'
          description: ''
    post:
      operationId: api_extensions_v1_billing_user_create_[create_billing_remote_time_tracking]
      summary: Create Billing Remote Time Tracking
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBillingRequestBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateBillingRequestBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateBillingRequestBodyDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateCumulativeMonitoringTimeResponseObjectDRF'
          description: ''
  /api/extensions/v1/billing/user/{user_id}/log:
    post:
      operationId: api_extensions_v1_billing_user_log_create_[create_billing_monitoring_log]
      summary: Create Billing Monitoring Log
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/billing/user/{user_id}/log/{log_id}:
    put:
      operationId: api_extensions_v1_billing_user_log_update_[update_billing_monitoring_log]
      summary: Update Billing Monitoring Log
      parameters:
      - in: path
        name: log_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
    delete:
      operationId: api_extensions_v1_billing_user_log_destroy_[delete_billing_monitoring_log]
      summary: Delete Billing Monitoring Log
      parameters:
      - in: path
        name: log_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/billing/user/{user_id}/logs:
    post:
      operationId: api_extensions_v1_billing_user_logs_create_[retrieve_billing_monitoring_logs]
      summary: Retrieve Billing Monitoring Logs
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetrieveBillingMonitoringLogsRequestBodyDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingMonitoringLogsResponseObjectDRF'
          description: ''
  /api/extensions/v1/billing/user/{user_id}/report:
    get:
      operationId: api_extensions_v1_billing_user_report_retrieve_[report_billing_records_for_cpt]
      summary: Report Billing Records For Cpt
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CPTReportResponseObjectDRF'
          description: ''
  /api/extensions/v1/export/:
    post:
      operationId: api_extensions_v1_export_create_[export]
      summary: Export
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/export/deployment/{deployment_id}:
    post:
      operationId: api_extensions_v1_export_deployment_create_[export_deployment]
      summary: Export Deployment
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/integration/billing_test:
    post:
      operationId: api_extensions_v1_integration_billing_test_create_[manually_run_billing]
      summary: Manually Run Billing
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerTaskResponseObjectDRF'
          description: ''
  /api/extensions/v1/integration/fetch_referring_providers:
    post:
      operationId: api_extensions_v1_integration_fetch_referring_providers_create_[manually_fetch_referring_providers]
      summary: Manually Fetch Referring Providers
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TriggerTaskRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerTaskResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/bill/{billId}/charge/{chargeId}:
    get:
      operationId: api_v1_billing_portal_bill_charge_retrieve_[get_billing_charge_record]
      summary: Get Billing Charge Record
      parameters:
      - in: path
        name: authzUser
        schema:
          type: string
        required: true
      - in: path
        name: billId
        schema:
          type: string
        required: true
      - in: path
        name: chargeId
        schema:
          type: string
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CptChargeUnitObjectDRF'
          description: ''
  /api/v1/billing-portal/bill/{billId}/charges/delete:
    delete:
      operationId: api_v1_billing_portal_bill_charges_delete_destroy_[delete_billing_charge_record]
      summary: Delete Billing Charge Record
      parameters:
      - in: path
        name: billId
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChargeResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/bill/{bill_id}/{charge_id}:
    patch:
      operationId: api_v1_billing_portal_bill_partial_update_[update_billing_charge_record]
      summary: Update Billing Charge Record
      parameters:
      - in: path
        name: bill_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: charge_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedChargeUnitRecordRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/bill/{bill_id}/charges:
    post:
      operationId: api_v1_billing_portal_bill_charges_create_[create_billing_charges_records]
      summary: Create Billing Charges Records
      parameters:
      - in: path
        name: bill_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AppendChargeToBillRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/billing/{bill_id}/charge:
    put:
      operationId: api_v1_billing_portal_billing_charge_update_[create_billing_charge_record]
      summary: Create Billing Charge Record
      parameters:
      - in: path
        name: bill_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateChargeUnitRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/call-export-task:
    post:
      operationId: api_v1_billing_portal_call_export_task_create_[call_export_task]
      description: 'Call the export task for the Billing Portal.

        This endpoint is used to trigger the export of billing data.

        Month and year are taken from the request query parameters.'
      summary: Call Export Task
      parameters:
      - in: query
        name: deploymentId
        schema:
          type: string
      - in: query
        name: exportMonth
        schema:
          type: integer
      - in: query
        name: exportYear
        schema:
          type: integer
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponseDRF'
          description: ''
  /api/v1/billing-portal/client-medical-records:
    get:
      operationId: api_v1_billing_portal_client_medical_records_retrieve_[get_client_medical_record]
      description: 'Get client medical records for the Billing Portal.

        This endpoint is used to retrieve client medical records.'
      summary: Get Client Medical Record
      parameters:
      - in: query
        name: clientId
        schema:
          type: string
      - in: query
        name: reportEndDate
        schema:
          type: string
          format: date-time
      - in: query
        name: yearMonth
        schema:
          type: string
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientMedicalRecordResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/clients:
    post:
      operationId: api_v1_billing_portal_clients_create_[add_client]
      description: Add a single client for the Billing Portal.
      summary: Add Client
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddClientRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddClientRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddClientRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/clients/filter:
    post:
      operationId: api_v1_billing_portal_clients_filter_create_[get_clients_endpoint]
      summary: Get Clients Endpoint
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetrieveClientsRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveClientsResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/cpt/billing/submitted:
    patch:
      operationId: api_v1_billing_portal_cpt_billing_submitted_partial_update_[update_billing_submitted_flag]
      summary: Update Billing Submitted Flag
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUpdateIsSubmittedRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIsSubmittedResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/cpt/months:
    post:
      operationId: api_v1_billing_portal_cpt_months_create_[get_cpt_months]
      summary: Get Cpt Months
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetrieveAvailableMonthsRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveAvailableMonthsResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/cpt/profiles:
    get:
      operationId: api_v1_billing_portal_cpt_profiles_retrieve_[get_cpt_profiles]
      description: 'Get Billing Portal profiles.

        Returns CPT profiles for the given year-month, filtered by accessible deployments and optional client/search.'
      summary: Get Cpt Profiles
      parameters:
      - in: query
        name: clientId
        schema:
          type: string
      - in: query
        name: filter
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: requester
        schema:
          type: string
        required: true
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: skip
        schema:
          type: integer
      - in: query
        name: submitted
        schema:
          type: string
      - in: query
        name: yearMonth
        schema:
          type: string
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCPTProfilesResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/deployment-client/:
    post:
      operationId: api_v1_billing_portal_deployment_client_create_[add_deployment_client]
      description: Add a deployment to a client for the Billing Portal.
      summary: Add Deployment Client
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddClientDeploymentRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
    put:
      operationId: api_v1_billing_portal_deployment_client_update_[update_deployment_client]
      description: Update a deployment for a client for the Billing Portal.
      summary: Update Deployment Client
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateClientDeploymentRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponseDRF'
          description: ''
    delete:
      operationId: api_v1_billing_portal_deployment_client_destroy_[delete_deployment_client]
      description: Delete a deployment for a client for the Billing Portal.
      summary: Delete Deployment Client
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponseDRF'
          description: ''
  /api/v1/billing-portal/export-data:
    delete:
      operationId: api_v1_billing_portal_export_data_destroy_[delete_export]
      description: 'Delete the export data for the Billing Portal.

        This endpoint is used to remove the export of billing data.

        Month and year are taken from the request query parameters.'
      summary: Delete Export
      parameters:
      - in: query
        name: deploymentId
        schema:
          type: string
      - in: query
        name: exportMonth
        schema:
          type: integer
      - in: query
        name: exportYear
        schema:
          type: integer
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/v1/billing-portal/export/cpt/profiles:
    get:
      operationId: api_v1_billing_portal_export_cpt_profiles_retrieve_[export_cpt_profile_overview]
      description: 'Get Billing Portal profiles.

        Returns CPT profiles for the given year-month, filtered by accessible deployments and optional client/search.'
      summary: Export Cpt Profile Overview
      parameters:
      - in: query
        name: clientId
        schema:
          type: string
      - in: query
        name: file_name
        schema:
          type: string
      - in: query
        name: filter
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: requester
        schema:
          type: string
        required: true
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: skip
        schema:
          type: integer
      - in: query
        name: submitted
        schema:
          type: string
      - in: query
        name: yearMonth
        schema:
          type: string
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/billing-portal/export/invoice/client:
    post:
      operationId: api_v1_billing_portal_export_invoice_client_create_[export_invoice_details_csv]
      summary: Export Invoice Details Csv
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExportClientInvoiceDetailsRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/billing-portal/export/invoice/overview:
    get:
      operationId: api_v1_billing_portal_export_invoice_overview_retrieve_[export_invoices_overview_to_csv]
      summary: Export Invoices Overview To Csv
      parameters:
      - in: query
        name: authzUser
        schema:
          type: string
      - in: query
        name: clientId
        schema:
          type: string
      - in: query
        name: file_name
        schema:
          type: string
      - in: query
        name: format
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: skip
        schema:
          type: integer
      - in: query
        name: yearMonth
        schema:
          type: string
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/billing-portal/generate/billing_and_invoices/:
    get:
      operationId: api_v1_billing_portal_generate_billing_and_invoices_retrieve_[generate_reports]
      description: Generate billing and invoice reports for the Billing Portal.
      summary: Generate Reports
      parameters:
      - in: query
        name: monthYear
        schema:
          type: string
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponseDRF'
          description: ''
  /api/v1/billing-portal/get-clients-invoices:
    get:
      operationId: api_v1_billing_portal_get_clients_invoices_retrieve_[get_clients_invoices]
      description: 'Get all clients'' invoices for the Billing Portal.

        This endpoint is used to retrieve all clients'' invoices as a CSV file.

        If no report_end_date is provided, all reports from all dates will be included.

        If a report_end_date is provided, only reports for that date will be included.'
      summary: Get Clients Invoices
      parameters:
      - in: query
        name: reportEndDate
        schema:
          type: string
          format: date-time
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/billing-portal/import/salesforce:
    post:
      operationId: api_v1_billing_portal_import_salesforce_create_[add_sales_force_file]
      summary: Add Sales Force File
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddSalesForceFileResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/import/salesforce/:
    get:
      operationId: api_v1_billing_portal_import_salesforce_retrieve_[download_sales_force_file]
      description: Downloads the sales force file for the Billing Portal.
      summary: Download Sales Force File
      parameters:
      - in: query
        name: version
        schema:
          type: integer
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/v1/billing-portal/invoice/client:
    post:
      operationId: api_v1_billing_portal_invoice_client_create_[get_client_invoice_details]
      summary: Get Client Invoice Details
      tags:
      - Billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ClientInvoiceDetailsRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveClientsInvoicesResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/invoice/overview:
    get:
      operationId: api_v1_billing_portal_invoice_overview_retrieve_[get_invoices_overview]
      summary: Get Invoices Overview
      parameters:
      - in: query
        name: authzUser
        schema:
          type: string
      - in: query
        name: clientId
        schema:
          type: string
      - in: query
        name: format
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: search
        schema:
          type: string
      - in: query
        name: skip
        schema:
          type: integer
      - in: query
        name: yearMonth
        schema:
          type: string
        required: true
      tags:
      - Billing
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInvoiceOverviewResponseObjectDRF'
          description: ''
  /api/v1/billing-portal/patient-medical-records:
    get:
      operationId: api_v1_billing_portal_patient_medical_records_retrieve_[get_patient_medical_record]
      description: 'Get patient medical records for the Billing Portal.

        This endpoint is used to retrieve client medical records.'
      summary: Get Patient Medical Record
      parameters:
      - in: query
        name: reportEndDate
        schema:
          type: string
          format: date-time
      - in: query
        name: userId
        schema:
          type: string
      - in: query
        name: yea

# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-billing-api-openapi.yml