provider

inventory

Get Banked Item Charge Items

Get all charge items associated with a specific banked item.

get/inventory/banked-items/{banked_item_id}/charge-items

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/inventory/banked-items/:banked_item_id/charge-items/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

banked_item_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring nullable

Unique identifier for the charge item

itemIdstring nullable

Optional unique identifier for the item

chargeIdstring required

Identifier of the charge this item is associated with

namestring nullable

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

descriptionstring nullable

Description of the item

quantityinteger required

Quantity of the item being charged

discountAmountinteger nullable

Discount amount for the item

discountPercentagenumber nullable

Discount percentage for the item

discountReasonstring nullable

Reason for discount

priceinteger required

Price of the item in cents

soldPackageIdstring nullable

Unique identifier for the sold package usage

bankedQuantityinteger nullable

Quantity to bank for later use

bankedItemIdstring nullable

ID of banked item being used (for tracking usage)

issuedDiscountIdstring nullable

Unique identifier for the specific issued discount instance used

soldByProviderIdstring nullable

Unique identifier for the provider who sold the item

taxAmountinteger nullable

Tax amount for the item in cents

pricingIdstring nullable

Unique identifier for the pricing for the item

shipmentIdsstring[] nullable

Optional list of shipment IDs to reduce the stock quantity of

locationIdstring nullable

Location ID where the sale occurred

locationNamestring nullable

Location name where the sale occurred

saleDatestring date-time nullable

Date when the sale occurred

Changes

No recorded changes to this operation across all 2 revisions of this API.