CLclinicos
Inventory

POST /Inventory

Changed on

Request

Request body

namestring
invoiceNamestring nullable
skustring nullable
barcodestring nullable
descriptionstring nullable
defaultSigstring nullable

Default prescription instructions (SIG) for rx-required items. See PAW-671.

compoundFormulastring nullable

Compounding formula / preparation details for compounded items. See PAW-671.

categorystring
vaccineTypeIdstring nullable
vendorIdstring nullable
vendorItemNumberstring nullable
drugFormstring nullable
unitOfMeasurestring nullable

Per-item dispensing-unit label override (e.g. "dose", "applicator"). Null = derive the label from DrugForm (ITE-390).

strengthstring nullable
ndcstring nullable
isCompoundedboolean
rxRequiredboolean
allowedSpeciesIdsstring[] nullable
weightBandUnitstring nullable

Weight unit code (kg, g, lb, oz; "lbs" and similar are accepted). Required with either bound.

deaBookIdstring nullable
deaSchedulestring nullable
distributionCategorystring nullable
cascadeEligibleboolean
isAntimicrobialboolean
antimicrobialTypestring nullable
requiresUnderCareboolean
requiresPhysicalExamboolean
foodProducingboolean
requiresWithdrawalPeriodboolean
pricePolicystring
isFlatRateboolean nullable

Bill unitPrice once per administration, whatever amount is given. Requires a set price (Manual / Fixed). Ignored unless the FlatRateInventoryPricing flag is on.

isTaxableboolean
vatCategorystring nullable
trackLotsboolean

Response

OK

idstring
namestring
invoiceNamestring nullable
skustring nullable
barcodestring nullable
descriptionstring nullable
defaultSigstring nullable

Default prescription instructions (SIG) for rx-required items. See PAW-671.

compoundFormulastring nullable

Compounding formula / preparation details for compounded items. See PAW-671.

categorystring
vaccineTypeIdstring nullable
statusstring
vendorIdstring nullable
vendorItemNumberstring nullable
drugFormstring nullable
unitOfMeasurestring nullable

Per-item dispensing-unit label override (e.g. "dose", "applicator"). Null = derive the label from DrugForm (ITE-390).

strengthstring nullable
ndcstring nullable
isCompoundedboolean
rxRequiredboolean
allowedSpeciesIdsstring[] nullable
weightBandUnitstring nullable

Weight unit code the bounds are in: kg, g, lb, oz.

deaBookIdstring nullable
deaSchedulestring nullable
requiresWitnessboolean

Server-computed: does dispensing this item require a witness on submit? Mirrors the predicate in DispenseValidator so UI gating stays in lockstep with backend validation.

distributionCategorystring nullable
cascadeEligibleboolean
isAntimicrobialboolean
antimicrobialTypestring nullable
requiresUnderCareboolean
requiresPhysicalExamboolean
foodProducingboolean
requiresWithdrawalPeriodboolean
pricePolicystring
isFlatRateboolean

Bills unitPrice once per administration, whatever amount is given.

isTaxableboolean
vatCategorystring nullable
trackLotsboolean
earliestExpirationstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

  • 099cf36186e0Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+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)

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

  • f7ab358172d0Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+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)