Get Public Quote

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

{
  "id": "<string>",
  "status": "DRAFT",
  "discountAmount": 123,
  "taxAmount": 123,
  "total": 123,
  "subtotal": 123,
  "title": "<string>",
  "description": "<string>",
  "terms": "<string>",
  "validUntilDate": "2023-11-07T05:31:56Z",
  "items": [],
  "createdDate": "2023-11-07T05:31:56Z",
  "viewedDate": "2023-11-07T05:31:56Z",
  "respondedDate": "2023-11-07T05:31:56Z"
}

GET

billing

quote

public

{quote_id}

Get Public Quote

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

{
  "id": "<string>",
  "status": "DRAFT",
  "discountAmount": 123,
  "taxAmount": 123,
  "total": 123,
  "subtotal": 123,
  "title": "<string>",
  "description": "<string>",
  "terms": "<string>",
  "validUntilDate": "2023-11-07T05:31:56Z",
  "items": [],
  "createdDate": "2023-11-07T05:31:56Z",
  "viewedDate": "2023-11-07T05:31:56Z",
  "respondedDate": "2023-11-07T05:31:56Z"
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

quote_id

string

required

Query Parameters

update_viewed_date

boolean

default:true

Whether to update the viewed date

Response

Successful Response

Public view of quote for patients.

string

required

Quote ID

status

enum<string>

required

Quote status

Available options:

DRAFT,

SENT,

VIEWED,

ACCEPTED,

DECLINED,

EXPIRED,

CONVERTED

discountAmount

integer

required

Total discount in cents

taxAmount

integer

required

Total tax in cents

total

integer

required

Final total in cents

subtotal

integer

required

Calculate subtotal from items after item-level discounts.

title

string | null

Title of the quote

description

string | null

Description of the quote

terms

string | null

Terms and conditions

validUntilDate

string<date-time> | null

When the quote expires

items

QuoteItem · object[]

Items and packages in the quote

Show child attributes

items.quoteId

string

required

ID of the quote

items.quantity

number

required

Quantity of the item/package

items.unitPrice

integer

required

Unit price in cents

items.discountAmount

integer

required

Discount amount in cents

items.discountPercentage

number

required

Discount percentage

items.taxAmount

integer

required

Tax amount in cents

items.totalPrice

integer

required

Total price for this quantity in cents

items.itemId

string | null

ID of the item (if this is an item)

items.packageId

string | null

ID of the package (if this is a package)

items.description

string | null

Custom description for this item/package

items.item

ItemTiny · object

Item details (if this is an item)

Show child attributes

items.item.name

string

required

Name of the item

items.item.price

integer

required

Price of the item in cents

items.item.id

string

Unique identifier for the item

items.item.brandName

string | null

Optional brand name of the item

items.item.description

string | null

Optional description of the item

items.item.category

string | null

Category name (references category.name)

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

items.item.isPhysical

boolean

default:true

Whether the item is physical

items.item.isArchived

boolean

default:false

Whether the item is archived

items.item.internalNotes

string | null

Optional internal notes for the item

items.item.taxable

boolean

default:false

Whether the item is subject to taxes

items.item.sortOrder

integer | null

Optional sort order for the item

items.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

items.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

items.package

PackageTiny · object

Package details (if this is a package)

Show child attributes

items.package.name

string

required

Name of the package

items.package.price

integer

required

Price of the package in cents

items.package.id

string

Unique identifier for the package

items.package.description

string | null

Optional description of the package

items.package.isArchived

boolean

default:false

Whether the package is archived

items.createdDate

string<date-time> | null

Date the item was added

items.updatedDate

string<date-time> | null

Date the item was last updated

createdDate

string<date-time> | null

Date the quote was created

viewedDate

string<date-time> | null

When the patient first viewed the quote

respondedDate

string<date-time> | null

When the patient responded to the quote

Get Payments Over Time Get Quote By Id

⌘I

Getting Started

API

Tenant

Webhook

Get Public Quote

Headers

Path Parameters

Query Parameters

Response