Candid Health

Candid Health Billing Notes API

The Billing Notes API from Candid Health — 2 operation(s) for billing notes.

GitHub OpenAPI

Operations 3

POST /api/billing_notes/v2 Create billing note #
DELETE /api/billing_notes/v2/{billing_note_id} Delete billing note #
PATCH /api/billing_notes/v2/{billing_note_id} Update #

Documentation

📖
Documentation
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
📖
Documentation
https://docs.joincandidhealth.com/api-reference/encounters/v-4
📖
Documentation
https://docs.joincandidhealth.com/api-reference/encounters/v-4/get-all
📖
APIReference
https://docs.joincandidhealth.com/api-reference/encounters/v-4/create
📖
Documentation
https://docs.joincandidhealth.com/api-reference/eligibility/v-2/submit-eligibility-check
📖
APIReference
https://docs.joincandidhealth.com/api-reference/pre-encounter/coverages/v-1/check-eligibility
📖
Documentation
https://docs.joincandidhealth.com/api-reference/charge-capture/v-1/create
📖
Documentation
https://docs.joincandidhealth.com/api-reference/payers/v-3/get
📖
APIReference
https://docs.joincandidhealth.com/api-reference/fee-schedules/v-3/get-match
📖
Documentation
https://docs.joincandidhealth.com/api-reference/insurance-adjudications/v-1/get
📖
Documentation
https://docs.joincandidhealth.com/api-reference/events/v-1/get

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/openapi/candid-health-billing-notes-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/collections/candidhealth.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/collections/candidhealth.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/candid-health-billing-notes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

candid-health-billing-notes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Billing Notes API
  version: 1.0.0
servers:
- url: https://pre-api.joincandidhealth.com
  description: Production
- url: https://pre-api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-pre-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-pre-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:4000
  description: Local
- url: https://api.joincandidhealth.com
  description: Production
- url: https://api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:5050
  description: Local
tags:
- name: Billing Notes
paths:
  /api/billing_notes/v2:
    post:
      operationId: create
      summary: Create billing note
      tags:
      - Billing Notes
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_billing-notes_v2_BillingNote'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: Empty string not allowed.
                encounter_id:
                  $ref: '#/components/schemas/type_commons_EncounterId'
              required:
              - text
              - encounter_id
  /api/billing_notes/v2/{billing_note_id}:
    delete:
      operationId: delete
      summary: Delete billing note
      tags:
      - Billing Notes
      parameters:
      - name: billing_note_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - OrganizationNotAuthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_OrganizationNotAuthorizedErrorMessage'
                required:
                - errorName
                - content
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
    patch:
      operationId: update
      summary: Update
      tags:
      - Billing Notes
      parameters:
      - name: billing_note_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_billing-notes_v2_BillingNote'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - OrganizationNotAuthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_OrganizationNotAuthorizedErrorMessage'
                required:
                - errorName
                - content
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnauthorizedError
                  content:
                    $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage'
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - HttpRequestValidationsError
                  content:
                    type: array
                    items:
                      $ref: '#/components/schemas/type_commons_RequestValidationError'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: Empty string not allowed.
              required:
              - text
components:
  schemas:
    type_commons_EntityNotFoundErrorMessage:
      type: object
      properties:
        id:
          type: string
      required:
      - id
      title: EntityNotFoundErrorMessage
    type_billing-notes_v2_BillingNote:
      type: object
      properties:
        text:
          type: string
          description: Empty string not allowed.
        billing_note_id:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId'
        encounter_id:
          $ref: '#/components/schemas/type_commons_EncounterId'
        created_at:
          type: string
          format: date-time
          description: 'An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/).

            For example, 2017-07-21T17:32:28Z.'
        author_auth0_id:
          type: string
        author_name:
          type: string
        billing_note_type:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteType'
        billing_note_metadata:
          $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteMetadata'
      required:
      - text
      - billing_note_id
      - encounter_id
      - created_at
      title: BillingNote
    type_commons_UnauthorizedErrorMessage:
      type: object
      properties:
        message:
          type: string
      title: UnauthorizedErrorMessage
    type_commons_EncounterId:
      type: string
      format: uuid
      title: EncounterId
    type_commons_RequestValidationError:
      type: object
      properties:
        fieldName:
          type: string
        humanReadableMessage:
          type: string
      required:
      - fieldName
      title: RequestValidationError
    type_billing-notes_v2_BillingNoteId:
      type: string
      format: uuid
      title: BillingNoteId
    type_billing-notes_v2_BillingNoteType:
      type: string
      enum:
      - manual
      - system
      - queue_added
      - queue_moved
      - task_created
      title: BillingNoteType
    type_billing-notes_v2_BillingNoteMetadata:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - queue_added
            description: 'Discriminator value: queue_added'
          queue_id:
            type: string
          queue_name:
            type: string
        required:
        - type
        - queue_id
        - queue_name
      - type: object
        properties:
          type:
            type: string
            enum:
            - queue_moved
            description: 'Discriminator value: queue_moved'
          from_queue_id:
            type: string
          from_queue_name:
            type: string
          to_queue_id:
            type: string
          to_queue_name:
            type: string
        required:
        - type
        - from_queue_id
        - from_queue_name
        - to_queue_id
        - to_queue_name
      - type: object
        properties:
          type:
            type: string
            enum:
            - task_created
            description: 'Discriminator value: task_created'
          task_id:
            type: string
            format: uuid
          task_type:
            type: string
        required:
        - type
        - task_id
        - task_type
      discriminator:
        propertyName: type
      title: BillingNoteMetadata
    type_commons_OrganizationNotAuthorizedErrorMessage:
      type: object
      properties:
        message:
          type: string
      required:
      - message
      title: OrganizationNotAuthorizedErrorMessage
  securitySchemes:
    OAuthScheme:
      type: http
      scheme: bearer
      description: OAuth 2.0 authentication