CLclinicos
Estimates

Add a single line (procedure / inventory / retail) to an estimate.

Changed on
post/Estimates/{id}/items

Request

Path parameters

idstring required

Request body

serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

A BillableItem ("Charge") — a priced bundle that fans out to its components on perform.

qtyModestring
isTaxableboolean nullable
notestring nullable
markedForBillingboolean
createdByAiboolean

Set by the chronicle's AI treatment-suggestion strip when a suggestion is accepted, so the line records that provenance (ITE-871). Defaults to false for every other caller.

Response

Created

idstring
serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

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

codestring
descriptionstring
qtyModestring
isFlatRateboolean

Flat-rate inventory line: bills one administration at UnitPrice whatever amount is given.

isTaxableboolean
vatCategorystring nullable

The source item's VAT category ("standard" | "reduced" | "zero" | "exempt"; null is standard). Prices the line in VAT mode, at the rate convert bills it at (ITE-1539).

notestring nullable
groupIdstring nullable

The EstimateLineGroupDto this line sits under; null when ungrouped.

createdByAiboolean

True when the line came from an accepted AI treatment suggestion (ITE-871).

groupCodeIdstring nullable

The kit this line was expanded from; null for a line added on its own.

groupCodeNamestring nullable

The kit's name when it was added.

kitInstanceIdstring nullable

Shared by every line one add of a kit produced.

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

discountSetByIdstring nullable
discountSetByNamestring nullable
discountSetAtstring date-time nullable
priceOverriddenByIdstring nullable
priceOverriddenByNamestring nullable
priceOverriddenAtstring date-time nullable

Changes

  • 099cf36186e0Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

  • 85ee96c0bb96Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)