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_import-invoice.subpackage_import-invoice/v1 API

The subpackage_import-invoice.subpackage_import-invoice/v1 API from Candid Health — 2 operation(s) for subpackage_import-invoice.subpackage_import-invoice/v1.

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

This API exposes 4 operations across 2 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.

4 operations 2 paths 8 schemas 2 GET1 PATCH1 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_import-invoice.subpackage_import-invoice/v1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 4

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

subpackage_import-invoice.subpackage_import-invoice/v1 4
POST
/api/import-invoice/v1
Import Invoice
import-invoice 1 param body → 200409422
GET
/api/import-invoice/v1
Get Multi
get-multi 11 params → 200
GET
/api/import-invoice/v1/{invoice_id}
Get
get 2 params → 200404
PATCH
/api/import-invoice/v1/{invoice_id}
Update
update 2 params body → 200404

Schemas 8

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

type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:EntityConflictErrorMessage
object
1 property 1 required
type_commons:PageToken
string
type_commons:PatientExternalId
string
type_commons:UnprocessableEntityErrorMessage
object
1 property
type_commons:SortDirection
string
type_commons:EncounterExternalId
string
type_commons:InvoiceId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-import-invoice-subpackage-import-invoice-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