Sign in
provider
billing

Create Quote

Create a new quote with items and packages.

This endpoint creates a quote for patient review, generating a unique quote number for sharing.

post/billing/quote

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring nullable

Quote ID (auto-generated if not provided)

patientIdstring required

ID of the patient

cartIdstring required

ID of source cart if creating from cart

creatorIdstring required

ID of the user creating the quote

titlestring nullable

Title/subject of the quote

descriptionstring nullable

Description of the quote

validUntilDatestring date-time nullable

When the quote expires

termsstring nullable

Terms and conditions

internalNotesstring nullable

Internal notes

requiresPatientVerificationboolean

Require patient verification to view

Response

Successful Response

idstring required

Quote ID

patientIdstring required

Patient ID

creatorIdstring nullable

Creator ID

cartIdstring nullable

Source cart ID

status'DRAFT' | 'SENT' | 'VIEWED' | 'ACCEPTED' | 'DECLINED' | 'EXPIRED' | 'CONVERTED' required

Status of a quote.

titlestring nullable

Title/subject of the quote

discountAmountinteger required

Total discount in cents

discountPercentagenumber required

Overall discount percentage

taxAmountinteger required

Total tax in cents

totalinteger required

Final total in cents

itemCountinteger

Number of items in quote

packageCountinteger

Number of packages in quote

createdDatestring date-time nullable

Date the quote was created

updatedDatestring date-time nullable

Date the quote was last updated

validUntilDatestring date-time nullable

When the quote expires

sentDatestring date-time nullable

When the quote was sent

viewedDatestring date-time nullable

When the patient first viewed the quote

respondedDatestring date-time nullable

When the patient responded to the quote

internalNotesstring nullable

Internal notes

descriptionstring nullable

Description of the quote

termsstring nullable

Terms and conditions

convertedChargeIdstring nullable

ID of charge if quote was converted

subtotalinteger required

Calculate subtotal from items after item-level discounts.

Changes

No recorded changes to this endpoint across all 1 revision of this API.