provider
billing

Add Item To Quote

Changed on

Add an item or package to a quote.

post/billing/quote/{quote_id}/items/add

Request

Path parameters

quote_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

itemIdstring nullable

ID of the item (required if not package)

packageIdstring nullable

ID of the package (required if not item)

quantitynumber

Quantity of the item/package

unitPriceinteger nullable

Custom unit price in cents (if different from item/package price)

discountAmountinteger

Discount amount in cents

discountPercentagenumber

Discount percentage (0-100)

descriptionstring nullable

Custom description for this item/package in the quote

Response

Successful Response

idstring required

Quote ID

patientIdstring required

Patient ID

creatorIdstring nullable

Creator ID

chargeIdstring nullable

Source draft charge 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

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status