CLclinicos
Invoices

Add a dispensed inventory item to an estimate as a line item

Changed on
post/Invoices/{id}/items/from-dispense

Request

Path parameters

idstring required

The estimate ID

Request body

transactionIdstring
notesstring nullable

Response

Created

idstring
invoiceIdstring
serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Source BillableItem ("Charge") when this line was added from the charge catalog.

billableItemNamestring nullable

Display name of the source BillableItem (snapshot, response-only).

isFulfilledboolean

True when a BillableItem charge line has been fulfilled — its inventory components dispensed (derived from linked transactions, response-only).

inventoryTransactionIdstring nullable
codestring nullable
descriptionstring
isFlatRateboolean

Flat-rate inventory line: billed as one administration whatever amount was given.

discountSetByIdstring nullable

Audit: who last set a manual discount on this line, and when.

discountSetAtstring date-time nullable
priceOverriddenByIdstring nullable
priceOverriddenAtstring date-time nullable
appliedDiscountPolicyIdstring nullable
appliedDiscountCodestring nullable
isTaxableboolean
vatCategorystring nullable
providerIdstring nullable
notesstring nullable
groupCodeIdstring nullable

Kit this line came from, when emitted via GroupCode expansion.

groupCodeNamestring nullable

Snapshot of the kit's display name at time of add.

kitInstanceIdstring nullable

Which add of the kit this line came from (shared by that add's lines). Server-owned and read-only, like string? InvoiceLineItemDto.SectionKey: invoice saves never write it.

sectionKeystring nullable

The estimate line group this line was billed under (EstimateLineGroups), snapshotted at convert; null when ungrouped or added to the bill directly. Read-only: invoice saves ignore it. List<InvoiceLineItemDto> InvoiceDto.Items already comes in section order.

sectionTitlestring nullable

Heading of string? InvoiceLineItemDto.SectionKey's section.

patientIdstring nullable

The pet this line is attributed to on a combined multi-pet bill (ITE-1157) — the resolved attribution, not the raw column. Set only on bills that carry patientShares; null there means no pet could be resolved.

patientIdLockedboolean

True when the line's pet can't be changed: it was dispensed for a pet, or a pet's plan benefit paid for it. The pet comes from that record.

patientIdLockReasonstring nullable

Why bool InvoiceLineItemDto.PatientIdLocked is set, for the UI's tooltip.

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)

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

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