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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Candid Health

Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API

The subpackage_charge-capture.subpackage_charge-capture/v1 API from Candid Health — 5 operation(s) for subpackage_charge-capture.subpackage_charge-capture/v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API is one of 54 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_charge-capture.subpackage_charge-capture/v1. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 10 base URLs: https://pre-api.joincandidhealth.com, https://pre-api-staging.joincandidhealth.com, https://sandbox-pre-api.joincandidhealth.com, https://staging-pre-api.joincandidhealth.com, http://localhost:4000, https://api.joincandidhealth.com, https://api-staging.joincandidhealth.com, https://sandbox-api.joincandidhealth.com, https://staging-api.joincandidhealth.com, http://localhost:5050.

7 operations 5 paths 12 schemas 2 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.joincandidhealth.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 7

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

subpackage_charge-capture.subpackage_charge-capture/v1 7
POST
/api/charge_captures/v1
Create a Charge Capture
create 1 param body → 200403404409422
GET
/api/charge_captures/v1
Get all Charge Captures
get-all 46 params → 200
POST
/api/charge_captures/v1/create-from-pre-encounter
Create a Charge Capture from pre-encounter patient and appointment
create-from-pre-encounter-patient 1 param body → 200403404409422
PATCH
/api/charge_captures/v1/changes
Update a ChargeCapturePostBilledChange
update-post-billed-changes 1 param body → 200403404
PATCH
/api/charge_captures/v1/{charge_capture_id}
Update Charge Capture
update 2 params body → 200403404422
GET
/api/charge_captures/v1/{charge_capture_id}
Get Charge Capture
get 2 params → 200
POST
/api/charge_captures/v1/find-by-metadata
Find Charge Captures by Metadata
find-by-metadata 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are type_commons:UnauthorizedErrorMessage (1 property), type_commons:UnprocessableEntityErrorMessage (1 property), type_commons:EntityNotFoundErrorMessage (1 property). Each schema is shown below with its type and property counts.

type_commons:ChargeCapturePostBilledChangeId
string
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:PreEncounterPatientId
string
type_commons:PageToken
string
type_commons:PreEncounterAppointmentId
string
type_commons:ChargeCaptureId
string
type_commons:UnprocessableEntityErrorMessage
object
1 property
type_claims:ClaimStatus
string
type_commons:SortDirection
string
type_commons:UnauthorizedErrorMessage
object
1 property
type_commons:EncounterId
string
type_commons:ChargeCaptureClaimCreationId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-charge-capture-subpackage-charge-capture-v1-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
AE Profile APIs.io
Candid Health Charge Capture API
AE Profile APIs.io
Candid Health Exports API
AE Profile APIs.io
Candid Health Patients API
AE Profile APIs.io
Candid Health Credentialing API
AE Profile APIs.io
Candid Health Auth API
AE Profile APIs.io
Candid Health subpackage_auth.subpackage_auth/default API
AE Profile APIs.io
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
AE Profile APIs.io
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v2 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v3 API
AE Profile APIs.io
Candid Health subpackage_credentialing.subpackage_credentialing/v2 API
AE Profile APIs.io
#subpackage_charge-capture.subpackage_charge-capture/v1
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-charge-capture-subpackage-charge-capture-v1-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network