Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Practice Management

Retrieve an existing vaccine inventory

get/api/inventory_vaccines/{id}

Path parameters

idstring required

Query parameters

statusstring
cvx_codestring
sincestring
doctorinteger

Response

OK

categoryinteger

ID of /api/inventory_categories

lot_numberstring
manufacturer_codestring required
namestring required
original_quantityinteger

Default to zero

doctorinteger required
created_atstring
status'active' | 'inactive' | 'archived' | 'voided'

Status of vaccine, could be one of active, inactive, archived, voided, default to active

updated_atstring
price_with_taxnumber
expirystring

When will the vaccine expire

notestring
sales_tax_applicableboolean

Is sales tax applicable to this service/product? Default to false

costnumber

Base cost for consumables.

pricenumber
vaccination_typestring

Default to "standard vaccine"

idinteger
manufacturerstring
current_quantityinteger

This field can onlyu be changed by creating new patient vaccine record. Current quantity of an inventory vaccine is calculated by subtract number of records pointing to this inventory from the original quantity value.

cvx_codestring