ClinicConfig

PATCH /clinic-config/inventory - Update inventory settings

Changed on Oct 28, 2026

patch/clinic-config/inventory

Request

Base URL
https://api.clinicos.vet/backend/business
Auth
HTTP bearer
TypeScript
https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/clinic-config/inventory/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

expiryTrackingEnabledboolean

valuationMethodstring

defaultVendorstring nullable

preferredShippingMethodstring

vendorAccountIdstring nullable

backorderSubstitutionsEnabledboolean

vetcoveEnabledboolean

vetcoveApiKeystring nullable

Write-only: a new Vetcove API key to store in Secrets Manager. Never returned.

vetcoveApiKeyConfiguredboolean

Read-only: whether a Vetcove API key is stored.

vetcoveApiKeyArnstring nullable

Deprecated (ITE-1467): always null in responses. Clients from before ITE-1467 send the raw key here; it is treated like string? InventorySettingsDto.VetcoveApiKey.

covetrusEnabledboolean

covetrusApiKeystring nullable

Write-only: a new Covetrus API key to store in Secrets Manager. Never returned.

covetrusApiKeyConfiguredboolean

Read-only: whether a Covetrus API key is stored.

covetrusApiKeyArnstring nullable

Deprecated (ITE-1467); see string? InventorySettingsDto.VetcoveApiKeyArn.

transmissionMethodstring

defaultOnlinePharmacystring

clientPharmacyOverridesAllowedboolean

defaultDispenseUnitstring

genericSubstitutionAllowedboolean

showDispenseFeesSeparatelyboolean

labelBrandingstring nullable

multiLanguageLabelsEnabledboolean

autoLogDeaRegisterboolean

mfaForControlledRxboolean

barcodeScanBeforeDispenseboolean

refrigeratedMedSensorsboolean

enforceVcprCheckboolean

negativeInventoryModestring nullable

"Strict" (the default), "Warn" or "Allow" — whether a lot-tracked item may be dispensed past its stock on hand (ITE-1410). Only honoured while the NegativeInventory feature flag is on. GET always populates it; on PATCH, null leaves the stored value unchanged.

overdraftSettlementModestring nullable

"Automatic" (the default) or "Review" — whether a receive pays off an item's overdraft lot at once, or files an overdraft-settlement approval that a person approves (ITE-1410). GET always populates it; on PATCH, null leaves the stored value unchanged.

allowAppointmentDispenseWithoutWitnessboolean nullable

When true, appointment-close dispenses of controlled drugs don't need a separate witness (see InventorySettings.AllowAppointmentDispenseWithoutWitness). Nullable so a PATCH that omits it keeps the stored value (null = unchanged); GET always populates it, resolving a missing stored key to true.

automatedCountsEnabledboolean

countFrequencystring

salesVelocityReportEnabledboolean

Response

OK

expiryTrackingEnabledboolean

valuationMethodstring

defaultVendorstring nullable

preferredShippingMethodstring

vendorAccountIdstring nullable

backorderSubstitutionsEnabledboolean

vetcoveEnabledboolean

vetcoveApiKeystring nullable

Write-only: a new Vetcove API key to store in Secrets Manager. Never returned.

vetcoveApiKeyConfiguredboolean

Read-only: whether a Vetcove API key is stored.

vetcoveApiKeyArnstring nullable

Deprecated (ITE-1467): always null in responses. Clients from before ITE-1467 send the raw key here; it is treated like string? InventorySettingsDto.VetcoveApiKey.

covetrusEnabledboolean

covetrusApiKeystring nullable

Write-only: a new Covetrus API key to store in Secrets Manager. Never returned.

covetrusApiKeyConfiguredboolean

Read-only: whether a Covetrus API key is stored.

covetrusApiKeyArnstring nullable

Deprecated (ITE-1467); see string? InventorySettingsDto.VetcoveApiKeyArn.

transmissionMethodstring

defaultOnlinePharmacystring

clientPharmacyOverridesAllowedboolean

defaultDispenseUnitstring

genericSubstitutionAllowedboolean

showDispenseFeesSeparatelyboolean

labelBrandingstring nullable

multiLanguageLabelsEnabledboolean

autoLogDeaRegisterboolean

mfaForControlledRxboolean

barcodeScanBeforeDispenseboolean

refrigeratedMedSensorsboolean

enforceVcprCheckboolean

negativeInventoryModestring nullable

"Strict" (the default), "Warn" or "Allow" — whether a lot-tracked item may be dispensed past its stock on hand (ITE-1410). Only honoured while the NegativeInventory feature flag is on. GET always populates it; on PATCH, null leaves the stored value unchanged.

overdraftSettlementModestring nullable

"Automatic" (the default) or "Review" — whether a receive pays off an item's overdraft lot at once, or files an overdraft-settlement approval that a person approves (ITE-1410). GET always populates it; on PATCH, null leaves the stored value unchanged.

allowAppointmentDispenseWithoutWitnessboolean nullable

When true, appointment-close dispenses of controlled drugs don't need a separate witness (see InventorySettings.AllowAppointmentDispenseWithoutWitness). Nullable so a PATCH that omits it keeps the stored value (null = unchanged); GET always populates it, resolving a missing stored key to true.

automatedCountsEnabledboolean

countFrequencystring

salesVelocityReportEnabledboolean

Changes

Oct 28, 2026099cf36186e0 Revision 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 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)
Oct 21, 202685ee96c0bb96 Revision changes
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the optional property from the response with the status (media type: text/plain)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: text/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 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)

Operation history