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

Candid Health subpackage_write-offs.subpackage_write-offs/v1 API

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

Candid Health subpackage_write-offs.subpackage_write-offs/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_write-offs.subpackage_write-offs/v1. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 8 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.

6 operations 5 paths 8 schemas 2 GET4 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_write-offs.subpackage_write-offs/v1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 6

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

subpackage_write-offs.subpackage_write-offs/v1 6
GET
/api/write-offs/v1
Get all write-offs
get-multi 11 params → 200
POST
/api/write-offs/v1
Create write-off
create 1 param body → 200
GET
/api/write-offs/v1/{write_off_id}
Get write-off
get 2 params → 200
POST
/api/write-offs/v1/{write_off_id}/revert
Revert write-off
revert 2 params → 200
POST
/api/write-offs/v1/{adjustment_id}/revert
Revert Insurance Balance Adjustment
revert-insurance-balance-adjustment 2 params → 200
POST
/api/write-offs/v1/{adjustment_id}/revert-era-originated
Revert ERA-originated Insurance Balance Adjustment
revert-era-originated-insurance-balance-adjustment 2 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

type_commons:PageToken
string
type_commons:PatientExternalId
string
type_commons:ClaimId
string
type_commons:ProviderId
string
type_commons:SortDirection
string
type_financials:AccountType
string
type_commons:ServiceLineId
string
type_commons:AdjustmentId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-write-offs-subpackage-write-offs-v1-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
Candid Health Charge Capture API
Candid Health Exports API
Candid Health Patients API
Candid Health Credentialing API
Candid Health Auth API
Candid Health subpackage_auth.subpackage_auth/default API
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API
Candid Health subpackage_contracts.subpackage_contracts/v2 API
Candid Health subpackage_contracts.subpackage_contracts/v3 API