Get Quotes

Get Quotes

curl --request GET \
  --url https://api.decodahealth.com/billing/quote/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "creatorId": "<string>",
      "cartId": "<string>",
      "title": "<string>",
      "itemCount": 0,
      "packageCount": 0,
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "validUntilDate": "2023-11-07T05:31:56Z",
      "sentDate": "2023-11-07T05:31:56Z",
      "viewedDate": "2023-11-07T05:31:56Z",
      "respondedDate": "2023-11-07T05:31:56Z",
      "internalNotes": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      }
    }
  ],
  "total": 123
}

GET

billing

quote

list

Get Quotes

curl --request GET \
  --url https://api.decodahealth.com/billing/quote/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "creatorId": "<string>",
      "cartId": "<string>",
      "title": "<string>",
      "itemCount": 0,
      "packageCount": 0,
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "validUntilDate": "2023-11-07T05:31:56Z",
      "sentDate": "2023-11-07T05:31:56Z",
      "viewedDate": "2023-11-07T05:31:56Z",
      "respondedDate": "2023-11-07T05:31:56Z",
      "internalNotes": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      }
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

patient_id

string | null

Filter by patient ID

creator_id

string | null

Filter by creator ID

cart_id

string | null

Filter by cart ID

status

enum<string> | null

Filter by quote status

Available options:

DRAFT,

SENT,

VIEWED,

ACCEPTED,

DECLINED,

EXPIRED,

CONVERTED

page

integer

default:1

Page number

Required range: x >= 1

size

integer

default:20

Page size

Required range: 1 <= x <= 100

Response

Successful Response

data

QuoteSummary · object[]

required

Show child attributes

data.id

string

required

Quote ID

data.patientId

string

required

Patient ID

data.status

enum<string>

required

Quote status

Available options:

DRAFT,

SENT,

VIEWED,

ACCEPTED,

DECLINED,

EXPIRED,

CONVERTED

data.discountAmount

integer

required

Total discount in cents

data.discountPercentage

number

required

Overall discount percentage

data.taxAmount

integer

required

Total tax in cents

data.total

integer

required

Final total in cents

data.creatorId

string | null

Creator ID

data.cartId

string | null

Source cart ID

data.title

string | null

Title/subject of the quote

data.itemCount

integer

default:0

Number of items in quote

data.packageCount

integer

default:0

Number of packages in quote

data.createdDate

string<date-time> | null

Date the quote was created

data.updatedDate

string<date-time> | null

Date the quote was last updated

data.validUntilDate

string<date-time> | null

When the quote expires

data.sentDate

string<date-time> | null

When the quote was sent

data.viewedDate

string<date-time> | null

When the patient first viewed the quote

data.respondedDate

string<date-time> | null

When the patient responded to the quote

data.internalNotes

string | null

Internal notes

data.creator

ProviderTiny · object

Creator details

Show child attributes

data.creator.id

string

required

data.creator.firstName

string

required

data.creator.lastName

string | null

data.creator.email

string | null

data.creator.createdDate

string<date-time> | null

data.patient

PatientSummary · object

Patient details

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

total

integer

required

Get Quote View Get Receipt

⌘I

Getting Started

API

Tenant

Webhook

Headers

Query Parameters

Response