Create Banked Item

curl --request POST \
  --url https://api.decodahealth.com/inventory/banked-items/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "id": "<string>",
  "item": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "brandName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "unit": "AMPOULES",
    "isPhysical": true,
    "isArchived": false,
    "internalNotes": "<string>",
    "taxable": false,
    "sortOrder": 123,
    "allowCustomPricing": false,
    "type": "PRODUCT"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z"
}
'

{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "id": "<string>",
  "item": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "brandName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "unit": "AMPOULES",
    "isPhysical": true,
    "isArchived": false,
    "internalNotes": "<string>",
    "taxable": false,
    "sortOrder": 123,
    "allowCustomPricing": false,
    "type": "PRODUCT"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z"
}

POST

inventory

banked-items

create

Create Banked Item

curl --request POST \
  --url https://api.decodahealth.com/inventory/banked-items/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "id": "<string>",
  "item": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "brandName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "unit": "AMPOULES",
    "isPhysical": true,
    "isArchived": false,
    "internalNotes": "<string>",
    "taxable": false,
    "sortOrder": 123,
    "allowCustomPricing": false,
    "type": "PRODUCT"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z"
}
'

{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "id": "<string>",
  "item": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "brandName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "unit": "AMPOULES",
    "isPhysical": true,
    "isArchived": false,
    "internalNotes": "<string>",
    "taxable": false,
    "sortOrder": 123,
    "allowCustomPricing": false,
    "type": "PRODUCT"
  },
  "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

Body

application/json

itemId

string

required

Item ID that was banked

patientId

string

required

Patient ID who purchased the item

createdByChargeItemId

string

required

Charge item ID that created this banked item

quantity

integer

required

Total quantity banked

quantityRemaining

integer

required

Quantity still available

string

Unique identifier for the banked item

item

ItemTiny · object

Details of the item

Show child attributes

item.name

string

required

Name of the item

item.price

integer

required

Price of the item in cents

item.id

string

Unique identifier for the item

item.brandName

string | null

Optional brand name of the item

item.description

string | null

Optional description of the item

item.category

string | null

Category name (references category.name)

item.unit

enum<string> | null

Unit of measurement for the item

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

item.isPhysical

boolean

default:true

Whether the item is physical

item.isArchived

boolean

default:false

Whether the item is archived

item.internalNotes

string | null

Optional internal notes for the item

item.taxable

boolean

default:false

Whether the item is subject to taxes

item.sortOrder

integer | null

Optional sort order for the item

item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

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

Response

Successful Response

itemId

string

required

Item ID that was banked

patientId

string

required

Patient ID who purchased the item

createdByChargeItemId

string

required

Charge item ID that created this banked item

quantity

integer

required

Total quantity banked

quantityRemaining

integer

required

Quantity still available

string

Unique identifier for the banked item

item

ItemTiny · object

Details of the item

Show child attributes

item.name

string

required

Name of the item

item.price

integer

required

Price of the item in cents

item.id

string

Unique identifier for the item

item.brandName

string | null

Optional brand name of the item

item.description

string | null

Optional description of the item

item.category

string | null

Category name (references category.name)

item.unit

enum<string> | null

Unit of measurement for the item

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

item.isPhysical

boolean

default:true

Whether the item is physical

item.isArchived

boolean

default:false

Whether the item is archived

item.internalNotes

string | null

Optional internal notes for the item

item.taxable

boolean

default:false

Whether the item is subject to taxes

item.sortOrder

integer | null

Optional sort order for the item

item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

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

Cancel Sold Package Create Commission Structure

⌘I

Getting Started

API

Tenant

Webhook

Create Banked Item

Headers

Body

Response