Get Banked Item

curl --request GET \
  --url https://api.decodahealth.com/inventory/banked-items/{banked_item_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "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"
  },
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>"
  },
  "createdByChargeItem": {
    "chargeId": "<string>",
    "quantity": 123,
    "price": 123,
    "id": "<string>",
    "itemId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "discountAmount": 123,
    "discountPercentage": 123,
    "discountReason": "<string>",
    "soldPackageId": "<string>",
    "bankedQuantity": 123,
    "bankedItemId": "<string>",
    "issuedDiscountId": "<string>",
    "soldByProviderId": "<string>",
    "taxAmount": 123,
    "pricingId": "<string>",
    "shipmentIds": [
      "<string>"
    ]
  },
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "items": [
    {
      "chargeId": "<string>",
      "quantity": 123,
      "price": 123,
      "charge": {
        "id": "<string>",
        "patientId": "<string>",
        "total": 123,
        "totalOutstanding": 123,
        "status": "OUTSTANDING",
        "description": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "itemId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "discountAmount": 123,
      "discountPercentage": 123,
      "discountReason": "<string>",
      "soldPackageId": "<string>",
      "bankedQuantity": 123,
      "bankedItemId": "<string>",
      "issuedDiscountId": "<string>",
      "soldByProviderId": "<string>",
      "taxAmount": 123,
      "pricingId": "<string>",
      "shipmentIds": [
        "<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"
      },
      "locationId": "<string>",
      "locationName": "<string>",
      "saleDate": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

inventory

banked-items

{banked_item_id}

Get Banked Item

curl --request GET \
  --url https://api.decodahealth.com/inventory/banked-items/{banked_item_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "itemId": "<string>",
  "patientId": "<string>",
  "createdByChargeItemId": "<string>",
  "quantity": 123,
  "quantityRemaining": 123,
  "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"
  },
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>"
  },
  "createdByChargeItem": {
    "chargeId": "<string>",
    "quantity": 123,
    "price": 123,
    "id": "<string>",
    "itemId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "discountAmount": 123,
    "discountPercentage": 123,
    "discountReason": "<string>",
    "soldPackageId": "<string>",
    "bankedQuantity": 123,
    "bankedItemId": "<string>",
    "issuedDiscountId": "<string>",
    "soldByProviderId": "<string>",
    "taxAmount": 123,
    "pricingId": "<string>",
    "shipmentIds": [
      "<string>"
    ]
  },
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "items": [
    {
      "chargeId": "<string>",
      "quantity": 123,
      "price": 123,
      "charge": {
        "id": "<string>",
        "patientId": "<string>",
        "total": 123,
        "totalOutstanding": 123,
        "status": "OUTSTANDING",
        "description": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "itemId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "discountAmount": 123,
      "discountPercentage": 123,
      "discountReason": "<string>",
      "soldPackageId": "<string>",
      "bankedQuantity": 123,
      "bankedItemId": "<string>",
      "issuedDiscountId": "<string>",
      "soldByProviderId": "<string>",
      "taxAmount": 123,
      "pricingId": "<string>",
      "shipmentIds": [
        "<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"
      },
      "locationId": "<string>",
      "locationName": "<string>",
      "saleDate": "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

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

item

ItemTiny · object

required

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

patient

PatientSummary · object

required

Details of the patient

Show child attributes

patient.id

string

required

The unique identifier for the user.

patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.createdDate

string<date-time>

required

The date and time when the user was created.

patient.firstName

string | null

The user's first name.

patient.lastName

string | null

The user's last name.

patient.phoneNumber

string | null

The user's phone number.

patient.email

string | null

The user's email address.

patient.locationId

string | null

The location of the user.

patient.externalId

string | null

The user's external identifier if available.

patient.address

string | null

The user's primary address.

patient.addressLineTwo

string | null

Additional address information.

patient.city

string | null

The city of the user's address.

patient.state

string | null

The state of the user's address.

patient.zipCode

string | null

The postal code of the user's address.

patient.country

string | null

The country of the user's address.

patient.addressValid

boolean | null

Whether the user's address is valid.

patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

patient.isArchived

boolean | null

Whether the user is archived.

patient.primaryLocationId

string | null

The primary location of the user.

patient.gender

string | null

The gender of the patient.

patient.dateOfBirth

string<date> | null

The date of birth of the patient.

patient.patientMedications

string[] | null

List of patient's self-reported medications.

patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

patient.tags.id

string

required

Unique identifier for the patient tag

patient.tags.name

string

required

Name of the patient tag

patient.tags.isActive

boolean

required

Whether the tag is active

patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

patient.tags.emoji

string | null

Emoji associated with the tag

patient.tags.color

string | null

Color code for the tag (hex format)

patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

patient.creditBalance

integer | null

Patient's credit balance in cents.

patient.preferredProviderId

string | null

The preferred provider ID for this patient.

createdByChargeItem

ChargeItem · object

required

Details of the charge item that created this banked item

Show child attributes

createdByChargeItem.chargeId

string

required

Identifier of the charge this item is associated with

createdByChargeItem.quantity

integer

required

Quantity of the item being charged

createdByChargeItem.price

integer

required

Price of the item in cents

createdByChargeItem.id

string | null

Unique identifier for the charge item

createdByChargeItem.itemId

string | null

Optional unique identifier for the item

createdByChargeItem.name

string | null

Name of the item (None for items with associated inventory item)

createdByChargeItem.description

string | null

Description of the item

createdByChargeItem.discountAmount

integer | null

Discount amount for the item

createdByChargeItem.discountPercentage

number | null

Discount percentage for the item

createdByChargeItem.discountReason

string | null

Reason for discount

createdByChargeItem.soldPackageId

string | null

Unique identifier for the sold package usage

createdByChargeItem.bankedQuantity

integer | null

Quantity to bank for later use

createdByChargeItem.bankedItemId

string | null

ID of banked item being used (for tracking usage)

createdByChargeItem.issuedDiscountId

string | null

Unique identifier for the specific issued discount instance used

createdByChargeItem.soldByProviderId

string | null

Unique identifier for the provider who sold the item

createdByChargeItem.taxAmount

integer | null

Tax amount for the item in cents

createdByChargeItem.pricingId

string | null

Unique identifier for the pricing for the item

createdByChargeItem.shipmentIds

string[] | null

Optional list of shipment IDs to reduce the stock quantity of

string

Unique identifier for the banked 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

items

ChargeItemDetailWithCharge · object[]

Charge items that used this banked item

Show child attributes

items.chargeId

string

required

Identifier of the charge this item is associated with

items.quantity

integer

required

Quantity of the item being charged

items.price

integer

required

Price of the item in cents

items.charge

ChargeSummaryForItem · object

required

Details of the charge

Show child attributes

items.charge.id

string

required

Unique identifier for the charge

items.charge.patientId

string

required

Identifier of the patient being charged

items.charge.total

integer

required

Total amount of the charge.

items.charge.totalOutstanding

integer

required

Total outstanding amount that is yet to be paid.

items.charge.status

enum<string>

required

Current status of the charge.

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

items.charge.description

string | null

Description of the charge.

items.charge.createdDate

string<date-time> | null

The date when the charge was created.

items.id

string | null

Unique identifier for the charge item

items.itemId

string | null

Optional unique identifier for the item

items.name

string | null

Name of the item (None for items with associated inventory item)

items.description

string | null

Description of the item

items.discountAmount

integer | null

Discount amount for the item

items.discountPercentage

number | null

Discount percentage for the item

items.discountReason

string | null

Reason for discount

items.soldPackageId

string | null

Unique identifier for the sold package usage

items.bankedQuantity

integer | null

Quantity to bank for later use

items.bankedItemId

string | null

ID of banked item being used (for tracking usage)

items.issuedDiscountId

string | null

Unique identifier for the specific issued discount instance used

items.soldByProviderId

string | null

Unique identifier for the provider who sold the item

items.taxAmount

integer | null

Tax amount for the item in cents

items.pricingId

string | null

Unique identifier for the pricing for the item

items.shipmentIds

string[] | null

Optional list of shipment IDs to reduce the stock quantity of

items.item

ItemTiny · object

Details of the item (None for custom charge items)

Show child attributes

items.item.name

string

required

Name of the item

items.item.price

integer

required

Price of the item in cents

items.item.id

string

Unique identifier for the item

items.item.brandName

string | null

Optional brand name of the item

items.item.description

string | null

Optional description of the item

items.item.category

string | null

Category name (references category.name)

items.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

items.item.isPhysical

boolean

default:true

Whether the item is physical

items.item.isArchived

boolean

default:false

Whether the item is archived

items.item.internalNotes

string | null

Optional internal notes for the item

items.item.taxable

boolean

default:false

Whether the item is subject to taxes

items.item.sortOrder

integer | null

Optional sort order for the item

items.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

items.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

items.locationId

string | null

Location ID where the sale occurred

items.locationName

string | null

Location name where the sale occurred

items.saleDate

string<date-time> | null

Date when the sale occurred

Generate Commission Report Get Banked Item Charge Items

⌘I

Getting Started

API

Tenant

Webhook

Get Banked Item

Headers

Path Parameters

Response