Hospital Inventory

The Hospital Inventory feature allows the user to  record, update and retrieve a the list of hospital inventory  items.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get list of inventory items

GET
/v1/{practiceid}/inventory/items
Retrieves a list of inventory items that are currently available.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
showdeleted boolean Whether to return deleted items.
vendorids array An array of Vendor IDs
externalinventorysystemids array An array of External Inventory System IDs.
skus array An array of SKUs
athenaids array An array of Athena IDs.

Output Parameters

Expand all
athenaid number The ID of the item in athena.
categoryid integer ID of the inventory category the item belongs to.
categoryname string The name of the inventory category the item belongs to.
categoryordering integer The order of the category
chargecode string Chargecode associated with the item
cost number Cost of item
deleted string If deleted it will be a date string of MM/DD/YYYY. If not deleted it should be null.
departmentid string ID of the athena department the item is used in
description string Description of the item
expenseaccount string The general ledger expense account associated with the item.
inventoryaccount string The general ledger inventory account associated with the item.
inventorysystemid integer ID of the item in the external inventory management system
manufacturerid string Manufacturer ID for the item
manufacturername string Manufacturer name for the item
name string The name of the item
sku string A unique ID for the item assigned by the vendor
unit string Unit of measurement for the item
vendorid string ID of the vendor for the item
vendorname string Vendor name for the item
Example Code

Add items to inventory list

POST
/v1/{practiceid}/inventory/items
Create a record of a new item in the hospital inventory list
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
inventoryitems array An array of JSON objects representing inventory items to add.

Output Parameters

Expand all
Example Code

Update items in inventory list

PUT
/v1/{practiceid}/inventory/items
Modifies the items in hospital inventory list. On success, API returns athena item-ids for items that were successfully updated.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
inventoryitems array An array of JSON objects representing inventory items to update.

Output Parameters

Expand all
Example Code

Delete items from inventory list

DELETE
/v1/{practiceid}/inventory/items
Deletes items matching the criteria from the inventory list. If the operation was successful, this contains the athena item ids that were deleted.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
athenainventoryitemids array Array of athena inventory item ids to delete

Output Parameters

Expand all
Example Code