Get token

Auth

Create billing note

Billing Notes

Get contract

Get all contracts

Creates a new contract within the user's current organization

Create contract

Delete contract

Update contract

Contracts

Get all custom schemas

Get custom schema

Create custom schema with a set of typed keys. Schema keys can be referenced as inputs in user-configurable rules in the Rules
Engine, and key-value pairs can be attached to claims via the Encounters API.

Create a custom schema

Update the name, description, or keys on a preexisting schema.

Update custom schema

Custom Schemas

Submit encounter eligibility check

Submit encounter eligibility check (Availity)

Submit encounter eligibility check (Availity Post)

Eligibility

Update Referring Provider

Update Initial Referring Provider

Update Supervising Provider

Update Ordering Provider

Create Referring Provider

Create Initial Referring Provider

Create Supervising Provider

Create Ordering Provider

Delete Referring Provider

Delete Initial Referring Provider

Delete Supervising Provider

Delete Ordering Provider

Encounter Providers

Get all encounters

Get encounter

Create encounter

Create encounter from pre-encounter patient and appointment

Update encounter

Encounters

Computes the expected network status given the provided information.

Compute network status

Computes the expected network status for a given rendering provider.
This endpoint is not available to all customers. Reach out to the Candid sales team
to discuss enabling this endpoint if it is not available for your organization.

Compute for rendering provider

Computes all the in network providers for a given set of inputs.
This endpoint is not available to all customers. Reach out to the Candid sales team
to discuss enabling this endpoint if it is not available for your organization.

Compute for all in-network providers

Expected Network Status

Get exports

Exports

Get Multi

External Payment Account Config

Gets the rate that matches a service line. No result means no rate exists matching the service line's dimensions.

Get Match

Tests a service line against a rate to see if it matches.

Test Match

Gets a list of dimensions with their rates. The rates returned will always be the most recent versions of those rates.

Gets unique values for a dimension based on other selection criteria. The response is a list of dimensions with your criteria and the unique values populated. This API is useful for driving pivots on dimension values.

Get Unique Values For Dimension

Get Rate History

Uploads a new fee schedule.\n Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.\n If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will be returned.\n Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will be saved to the system.

Upload a fee schedule (a collection of rates)

Soft deletes a rate from the system. Only the most recent version of a rate can be deleted.

Delete a rate

Get Payer Thresholds Default

Gets a list of payers and thresholds by their uuids

Get Payer Thresholds

Sets the threshold information for a payer

Set Payer Threshold

Fee Schedules

Creates a new guarantor and returns the newly created Guarantor object.

Create guarantor

Get guarantor

Update guarantor

Guarantor

Import an existing invoice from a third party service to reflect state in Candid.

Import Invoice

Returns all Invoices for the authenticated user's organziation with all filters applied.

Update the information on the imported invoice

Update

Get insurance adjudication

Creates a new insurance adjudication record and returns the newly created InsuranceAdjudication object.

Create insurance adjudication

Delete insurance adjudication

Insurance Adjudications

Returns all non-ERA originated insurance payments satisfying the search criteria

Get insurance payments

Get insurance payment

Create insurance payment

Delete insurance payment

Insurance Payments

Get insurance refunds

Get insurance refund

Create insurance refund

Delete insurance refund

Insurance Refunds

Medication Dispense Create

Medication Dispense

Get non-insurance payer payments

Get non-insurance payer payment

Create non-insurance payer payment

Delete non-insurance payer payment

Non Insurance Payer Payments

Returns all non-insurance payer refunds satisfying the search criteria

Get non-insurance payer refunds refunds

Get non-insurance payer refund

Create non-insurance payer refund

Delete non-insurance payer refund

Non Insurance Payer Refunds

Create

Toggle Enablement

Delete

Non Insurance Payers

Get organization service facility

Get all organization service facilities

Create organization service facility

Update organization service facility

Delete organization service facility

Organization Service Facilities

Get organization provider

Get all organization providers

Create organization provider

Update organization provider

Organization Providers

Get patient payments

Get patient payment

Creates a new patient payment record and returns the newly created PatientPayment object.
The allocations can describe whether the payment is being applied toward a specific service line,
claim, or billing provider.

Create patient payment

Delete patient payment

Patient Payments

Get patient refunds

Get patient refund

Creates a new patient refund record and returns the newly created PatientRefund object.
The allocations can describe whether the refund is being applied toward a specific service line,
claim, or billing provider.

Create patient refund

Delete patient refund

Patient Refunds

Get payer

Get all payers

Payers

Create Service Line

Update Service Line

Delete Service Line

Service Lines

Get task actions

Get all tasks

Get task

Create task

Update task

Tasks

Get third party payer payments

Get third party payer payment

Create third party payer payment

Delete third party payer payment

Third Party Payer Payments

Returns all third party payer refunds satisfying the search criteria

Get third party payer refunds refunds

Get third party payer refund

Create third party payer refund

Delete third payer refund

Third Party Payer Refunds

Third Party Payers

Returns all write-offs satisfying the search criteria.

Get all write-offs

Get write-off

Creates one or many write-offs applied toward a specific service line,
claim, or billing provider.

Create write-off

Revert write-off

Write Offs

Appointments

Coverages

Lists

Patients

Pre Encounter

Service Facility

AuthGetTokenResponse

TooManyRequestsErrorType

BillingNote

BillingNoteBase

BillingNoteId

ClaimFrequencyTypeCode

ClaimSubmissionRecordCreate

When the claim was submitted to the payer.

The medium by which the claim was submitted to the payer: paper or electronic.
If omitted, defaults to electronic.

ExternalClaimSubmissionCreate

When the claim was created in the external system.

The Patient Control Number sent on the claim to the payer. To guarantee compatibility with all payers, this field must consist
only of uppercase letters and numbers and be no more than 14 characters long.

A successful claim submission record will be created for each value provided.
An empty list may be provided for cases where the claim originated in an external system but was never submitted to a payer.

Claim

ClaimStatus

AppointmentId

ClaimAdjustmentGroupCodes

ClaimId

ClaimSubmissionPayerResponsibilityType

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

Date

DateRangeOptionalEnd

String representation of a Decimal that can be parsed by most libraries.

Decimal

Code indicating the reason why a request was delayed

DelayReasonCode

Proof of Eligibility Unknown or Unavailable

Candid | API Reference

1	curl -G https://api.joincandidhealth.com/api/import-invoice/v1 \
2	-H "Authorization: Bearer <token>" \
3	-d patient_external_id=string \
4	-d encounter_external_id=string

1	{
2	"items": [
3	{
4	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"created_at": "2023-01-01T00:00:00Z",
6	"updated_at": "2023-01-01T00:00:00Z",
7	"items": {
8	"claim_invoice_items": {
9	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
10	"claim_invoice_item": {
11	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12	"amount_cents": 0
13	},
14	"service_line_invoice_items": {
15	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
16	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17	"amount_cents": 0
18	}
19	}
20	}
21	},
22	"unattributed_items": [
23	{
24	"amount_cents": 0
25	}
26	]
27	},
28	"patient_external_id": "string",
29	"external_customer_identifier": "string",
30	"status": "DRAFT",
31	"external_identifier": "string",
32	"note": "string",
33	"customer_invoice_url": "string",
34	"due_date": "2023-01-01",
35	"amount_cents": 0
36	}
37	],
38	"prev_page_token": "string",
39	"next_page_token": "string"
40	}

Query parameters

Response