v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Estimates

Update a single estimate line (quantity / price / billing flag / order / tier qtys).

put/Estimates/{id}/items/{lineId}

Path parameters

idstring required
lineIdstring required

Request body

markedForBillingboolean nullable
notestring nullable
qtyModestring nullable

Response

OK

idstring
serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Source BillableItem ("Charge") id when this line is a charge.

codestring
descriptionstring
qtyModestring
isTaxableboolean
notestring nullable
serviceTypestring

"Procedure" | "Inventory" | "Retail" — derived from the source FK.

inventoryItemCategorystring nullable

InventoryItemCategory ("Vaccine", "Medication", …) for an inventory-backed line; routes the perform flow (e.g. vaccine administration).

executionStatusstring

Pending | Performed | Declined.

dispositionstring nullable

Persisted dispense disposition: InHouse | TakeHomeLabelNow | TakeHomeLabelLater (null for non-dispensing lines).

requiresSigboolean

True when this performed take-home line still needs its SIG / medication details filled (blocks convert). Drives the per-line "Fill instructions" affordance. In-house lines are never required.

markedForBillingboolean
inventoryTransactionIdstring nullable

Set once an inventory line is dispensed in-visit. The void reversal anchors on this.

performedByIdstring nullable
performedByNamestring nullable
performedAtstring date-time nullable
declinedReasonstring nullable
declinedAtstring date-time nullable
isControlledSubstanceboolean

True for a controlled-substance inventory line (gates the void-reason requirement).