Skip to main content
PUT
/
inventory
/
banked-items
/
{banked_item_id}
Update Banked Item
curl --request PUT \
  --url https://api.decodahealth.com/inventory/banked-items/{banked_item_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "quantity": 123,
  "quantityRemaining": 123,
  "comment": "<string>"
}
'
{
  "itemId": "<string>",
  "patientId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "id": "<string>",
  "createdByChargeItemId": "<string>",
  "comment": "<string>",
  "item": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "brandName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "unit": "AMPOULES",
    "isPhysical": true,
    "isArchived": false,
    "internalNotes": "<string>",
    "sortOrder": 123,
    "allowCustomPricing": false,
    "type": "PRODUCT",
    "externalId": "<string>",
    "exemptedTaxIds": [
      "<string>"
    ],
    "cost": 123
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

banked_item_id
string
required

Body

application/json
quantity
integer
required

Total quantity banked

quantityRemaining
integer
required

Quantity still available

comment
string | null

Optional comment about this banked item

Response

Successful Response

itemId
string
required

Item ID that was banked

patientId
string
required

Patient ID who purchased the item

quantity
integer
required

Total quantity banked

quantityRemaining
integer
required

Quantity still available

id
string

Unique identifier for the banked item

createdByChargeItemId
string | null

Charge item ID that created this banked item

comment
string | null

Optional comment about this banked item

item
ItemTiny · object

Details of the item

createdDate
string<date-time> | null

Date the item was banked (auto-set if not provided)

updatedDate
string<date-time> | null

Date the item was updated