Starter Kit

Support

Create a new `RuleSet` with associated `Rule`s.

Rule Set Create

CommunicationMethod

Amountgreaterthan

Amountlessthan

Number of days to delay before applying the rule.

Delayindays

Lessthanorequalto

Message to be sent when applying this rule, must contain the {url} and {first_name} placeholders.

Message

Communication method to be used for this rule.

Name

RuleCreateWithoutId

Message to be sent when applying this rule.

Identifier of the rule set this rule belongs to.

Rulesetid

RuleSummary

Location

Error Type

ValidationError

RuleSetCreate

RuleSetSummary

HTTPValidationError

Comprehensive Healthcare Payment Solutions

Introduction

Charge Create

Get a `Charge` by ID. Also returns any `Adjustments`, `Payments` or `Refunds` for the `Charge`.

Charge Get

Get a `Charge` by its external ID (i.e. the ID in your system).

Charge Get By External Id

Get a list of `Charge`s. You can filter by `patientId`, `total`, `totalOutstanding`, `description`, `status`, and `external_id`.

Charge List

Create a new `Adjustment` for an existing `Charge`. This is used in the event that a balance owed by a `Patient` needs to change (i.e. a write off or a mistake)

Charge Adjust

Create a new `Invoice` for all `Patient` balances based on a Patient's `Charge`.

Create Invoice

Get Invoice

Get a list of `Invoices`s. You can filter by `patient_id`, `status`, and `external_id`.

List Invoices

Item Create

Item Get

Item Update

Item Delete

Item List

Create a new `Patient`.

Also creates a new `Chat` for the patient.

Patient Create

Patient Get

Get a `Patient` by its external ID (i.e. the ID in your system).

Patient Get By External Id

Patient Update

Search for a `Patient` by name or phone number.

If no `search_term` query parameter is provided, returns `n=10` `Patients` in descending order by `createdDate`.

Patient List

Provider Create

Provider Get

Get a `Provider` by its external ID (i.e. the ID in your system).

Provider Get By External Id

Provider Update

Provider List

Rule Create

Rule Get

Rule Update

Rule List

Get a list of all `RuleSet`s with their associated `Rule`s.

Rule Set List

Webhook Create

Webhook Get

Webhook Update

Webhook Delete

Get a list of all webhooks connected to the tenant

Webhook List

Webhook Event Get

Send a `WebhookDeliveryAttempt` event to the `Webhook`. This is useful if you want to manually retry a webhook event that failed to deliver.

Webhook Event Send

List and search for attempts to *deliver* `Events` for a particular `Webhook` (i.e. `WebhookDeliveryAttempts`).

Webhook Events List

Get a list of all available `Roles` for `Providers`.

Get Started

API Reference

Rule Set Create

Headers

Body

Response