Get Carts

Get Carts

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

{
  "data": [
    {
      "id": "<string>",
      "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>"
      },
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "subtotal": 123,
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "items": [],
      "quotes": [
        {
          "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>"
          }
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "expiresDate": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "convertedChargeId": "<string>"
    }
  ],
  "total": 123
}

GET

billing

cart

Get Carts

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

{
  "data": [
    {
      "id": "<string>",
      "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>"
      },
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "subtotal": 123,
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "items": [],
      "quotes": [
        {
          "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>"
          }
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "expiresDate": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "convertedChargeId": "<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

statuses

enum<string>[] | null

Filter by cart statuses

Status of a patient cart.

Available options:

DRAFT,

ABANDONED,

ACCEPTED,

REJECTED,

CONVERTED,

EXPIRED

page

integer

default:1

Page number

Required range: x >= 1

size

integer

default:20

Page size

Required range: 1 <= x <= 100

sort_by

string | null

Sort by field

sort_direction

string | null

Sort direction (asc/desc)

string | null

Search across patient name, cart ID, patient ID, creator name, status, and item names

Response

Successful Response

data

CartSummary · object[]

required

Show child attributes

data.id

string

required

Cart ID

data.patient

PatientSummary · object

required

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.

data.status

enum<string>

required

Cart status

Available options:

DRAFT,

ABANDONED,

ACCEPTED,

REJECTED,

CONVERTED,

EXPIRED

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.subtotal

integer

required

Calculate subtotal from items after item-level discounts.

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.items

CartItem · object[]

Items and packages in the cart

Show child attributes

data.items.id

string

required

Cart item ID

data.items.cartId

string

required

ID of the cart

data.items.quantity

number

required

Quantity of the item/package

data.items.unitPrice

integer

required

Unit price in cents

data.items.discountAmount

integer

required

Discount amount in cents

data.items.discountPercentage

number

required

Discount percentage

data.items.taxAmount

integer

required

Tax amount in cents

data.items.totalPrice

integer

required

Total price for this quantity in cents

data.items.itemId

string | null

ID of the item

data.items.packageId

string | null

ID of the package

data.items.notes

string | null

Notes about this item/package

data.items.item

ItemTiny · object

Item details

Show child attributes

data.items.item.name

string

required

Name of the item

data.items.item.price

integer

required

Price of the item in cents

data.items.item.id

string

Unique identifier for the item

data.items.item.brandName

string | null

Optional brand name of the item

data.items.item.description

string | null

Optional description of the item

data.items.item.category

string | null

Category name (references category.name)

data.items.item.unit

enum<string> | null

Unit of measurement for the item

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

data.items.item.isPhysical

boolean

default:true

Whether the item is physical

data.items.item.isArchived

boolean

default:false

Whether the item is archived

data.items.item.internalNotes

string | null

Optional internal notes for the item

data.items.item.taxable

boolean

default:false

Whether the item is subject to taxes

data.items.item.sortOrder

integer | null

Optional sort order for the item

data.items.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

data.items.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

data.items.package

PackageTiny · object

Package details

Show child attributes

data.items.package.name

string

required

Name of the package

data.items.package.price

integer

required

Price of the package in cents

data.items.package.id

string

Unique identifier for the package

data.items.package.description

string | null

Optional description of the package

data.items.package.isArchived

boolean

default:false

Whether the package is archived

data.items.createdDate

string<date-time> | null

Date the item was added

data.items.updatedDate

string<date-time> | null

Date the item was last updated

data.quotes

QuoteSummary · object[]

Quotes created from this cart

Show child attributes

data.quotes.id

string

required

Quote ID

data.quotes.patientId

string

required

Patient ID

data.quotes.status

enum<string>

required

Quote status

Available options:

DRAFT,

SENT,

VIEWED,

ACCEPTED,

DECLINED,

EXPIRED,

CONVERTED

data.quotes.discountAmount

integer

required

Total discount in cents

data.quotes.discountPercentage

number

required

Overall discount percentage

data.quotes.taxAmount

integer

required

Total tax in cents

data.quotes.total

integer

required

Final total in cents

data.quotes.creatorId

string | null

Creator ID

data.quotes.cartId

string | null

Source cart ID

data.quotes.title

string | null

Title/subject of the quote

data.quotes.itemCount

integer

default:0

Number of items in quote

data.quotes.packageCount

integer

default:0

Number of packages in quote

data.quotes.createdDate

string<date-time> | null

Date the quote was created

data.quotes.updatedDate

string<date-time> | null

Date the quote was last updated

data.quotes.validUntilDate

string<date-time> | null

When the quote expires

data.quotes.sentDate

string<date-time> | null

When the quote was sent

data.quotes.viewedDate

string<date-time> | null

When the patient first viewed the quote

data.quotes.respondedDate

string<date-time> | null

When the patient responded to the quote

data.quotes.internalNotes

string | null

Internal notes

data.quotes.creator

ProviderTiny · object

Creator details

Show child attributes

data.quotes.creator.id

string

required

data.quotes.creator.firstName

string

required

data.quotes.creator.lastName

string | null

data.quotes.creator.email

string | null

data.quotes.creator.createdDate

string<date-time> | null

data.quotes.patient

PatientSummary · object

Patient details

Show child attributes

data.quotes.patient.id

string

required

The unique identifier for the user.

data.quotes.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.quotes.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.quotes.patient.firstName

string | null

The user's first name.

data.quotes.patient.lastName

string | null

The user's last name.

data.quotes.patient.phoneNumber

string | null

The user's phone number.

data.quotes.patient.email

string | null

The user's email address.

data.quotes.patient.locationId

string | null

The location of the user.

data.quotes.patient.externalId

string | null

The user's external identifier if available.

data.quotes.patient.address

string | null

The user's primary address.

data.quotes.patient.addressLineTwo

string | null

Additional address information.

data.quotes.patient.city

string | null

The city of the user's address.

data.quotes.patient.state

string | null

The state of the user's address.

data.quotes.patient.zipCode

string | null

The postal code of the user's address.

data.quotes.patient.country

string | null

The country of the user's address.

data.quotes.patient.addressValid

boolean | null

Whether the user's address is valid.

data.quotes.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.quotes.patient.isArchived

boolean | null

Whether the user is archived.

data.quotes.patient.primaryLocationId

string | null

The primary location of the user.

data.quotes.patient.gender

string | null

The gender of the patient.

data.quotes.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.quotes.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.quotes.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.quotes.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.quotes.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.quotes.patient.tags.id

string

required

Unique identifier for the patient tag

data.quotes.patient.tags.name

string

required

Name of the patient tag

data.quotes.patient.tags.isActive

boolean

required

Whether the tag is active

data.quotes.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.quotes.patient.tags.emoji

string | null

Emoji associated with the tag

data.quotes.patient.tags.color

string | null

Color code for the tag (hex format)

data.quotes.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.quotes.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.quotes.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.createdDate

string<date-time> | null

Date the cart was created

data.updatedDate

string<date-time> | null

Date the cart was last updated

data.expiresDate

string<date-time> | null

When the cart expires

data.notes

string | null

Notes about the cart

data.convertedChargeId

string | null

ID of charge if cart was converted

total

integer

required

Get Cart By Id Get Carts List

⌘I

Getting Started

API

Tenant

Webhook

Headers

Query Parameters

Response