> ## Documentation Index > Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Package Usage > Get the usage of a package with optional filtering and sorting. ## OpenAPI ````yaml get /inventory/packages/usage/{package_id} openapi: 3.1.0 info: title: Decoda API description: External API documentation for the Decoda Health platform. version: '1.0' servers: [] security: [] paths: /inventory/packages/usage/{package_id}: get: tags: - provider - inventory summary: Get Package Usage description: Get the usage of a package with optional filtering and sorting. operationId: get_package_usage_inventory_packages_usage__package_id__get parameters: - name: TENANT in: header required: true schema: type: string title: Tenant description: The tenant you are making this request on behalf of - name: API-KEY in: header required: true schema: type: string title: Api-Key description: Your api key - name: package_id in: path required: true schema: type: string title: Package Id - name: patient_name in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by patient name title: Patient Name description: Filter by patient name - name: last_activity_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by last activity date title: Last Activity Date description: Filter by last activity date - name: purchased_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by purchased date title: Purchased Date description: Filter by purchased date - name: status in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: Filter by package status title: Status description: Filter by package status - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' description: Sort field default: created_date title: Sort By description: Sort field - name: sort_direction in: query required: false schema: anyOf: - type: string - type: 'null' description: Sort direction (asc or desc) default: desc title: Sort Direction description: Sort direction (asc or desc) responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/SoldPackageDetail' title: >- Response Get Package Usage Inventory Packages Usage Package Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: SoldPackageDetail: properties: id: type: string title: Id description: Unique identifier for the sold package packageId: type: string title: Packageid description: Package ID that was sold patientId: type: string title: Patientid description: Patient ID who purchased the package chargeItemId: type: string title: Chargeitemid description: Charge item ID associated with the package purchase status: $ref: '#/components/schemas/PackageStatus' description: Status of the sold package package: $ref: '#/components/schemas/PackageDetail' description: Details of the package createdDate: type: string format: date-time title: Createddate description: Date the package was created updatedDate: anyOf: - type: string format: date-time - type: 'null' title: Updateddate description: Date the package was updated items: items: $ref: '#/components/schemas/ChargeItemDetailWithCharge' type: array title: Items description: Items used in the package patient: $ref: '#/components/schemas/PatientSummary' description: Details of the patient chargeItem: $ref: '#/components/schemas/ChargeItem' description: Details of the charge item type: object required: - packageId - patientId - chargeItemId - status - package - createdDate - patient - chargeItem title: SoldPackageDetail HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PackageStatus: type: string enum: - USED - ACTIVE - CANCELLED title: PackageStatus PackageDetail: properties: id: type: string title: Id description: Unique identifier for the package name: type: string title: Name description: Name of the package description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the package isArchived: type: boolean title: Isarchived description: Whether the package is archived default: false price: type: integer title: Price description: Price of the package in cents internalNotes: anyOf: - type: string - type: 'null' title: Internalnotes description: Optional internal notes for the package items: anyOf: - items: $ref: '#/components/schemas/PackageItem-Output' type: array - type: 'null' title: Items description: Items included in the package category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) numberOfActivePatients: type: integer title: Numberofactivepatients description: Number of active patients on this package default: 0 numberOfPatients: type: integer title: Numberofpatients description: Total number of patients who have purchased this package default: 0 createdDate: anyOf: - type: string format: date-time - type: 'null' title: Createddate description: Date the package was created type: object required: - name - price title: PackageDetail ChargeItemDetailWithCharge: properties: id: anyOf: - type: string - type: 'null' title: Id description: Unique identifier for the charge item itemId: anyOf: - type: string - type: 'null' title: Itemid description: Optional unique identifier for the item chargeId: type: string title: Chargeid description: Identifier of the charge this item is associated with name: anyOf: - type: string - type: 'null' title: Name description: Name of the item (None for items with associated inventory item) description: anyOf: - type: string - type: 'null' title: Description description: Description of the item quantity: type: integer title: Quantity description: Quantity of the item being charged discountAmount: anyOf: - type: integer - type: 'null' title: Discountamount description: Discount amount for the item discountPercentage: anyOf: - type: number - type: 'null' title: Discountpercentage description: Discount percentage for the item discountReason: anyOf: - type: string - type: 'null' title: Discountreason description: Reason for discount price: type: integer title: Price description: Price of the item in cents soldPackageId: anyOf: - type: string - type: 'null' title: Soldpackageid description: Unique identifier for the sold package usage bankedQuantity: anyOf: - type: integer - type: 'null' title: Bankedquantity description: Quantity to bank for later use bankedItemId: anyOf: - type: string - type: 'null' title: Bankeditemid description: ID of banked item being used (for tracking usage) issuedDiscountId: anyOf: - type: string - type: 'null' title: Issueddiscountid description: Unique identifier for the specific issued discount instance used soldByProviderId: anyOf: - type: string - type: 'null' title: Soldbyproviderid description: Unique identifier for the provider who sold the item taxAmount: anyOf: - type: integer - type: 'null' title: Taxamount description: Tax amount for the item in cents pricingId: anyOf: - type: string - type: 'null' title: Pricingid description: Unique identifier for the pricing for the item shipmentIds: anyOf: - items: type: string type: array - type: 'null' title: Shipmentids description: Optional list of shipment IDs to reduce the stock quantity of item: anyOf: - $ref: '#/components/schemas/ItemTiny' - type: 'null' description: Details of the item (None for custom charge items) locationId: anyOf: - type: string - type: 'null' title: Locationid description: Location ID where the sale occurred locationName: anyOf: - type: string - type: 'null' title: Locationname description: Location name where the sale occurred saleDate: anyOf: - type: string format: date-time - type: 'null' title: Saledate description: Date when the sale occurred charge: $ref: '#/components/schemas/ChargeSummaryForItem' description: Details of the charge type: object required: - chargeId - quantity - price - charge title: ChargeItemDetailWithCharge PatientSummary: properties: id: type: string title: Id description: The unique identifier for the user. firstName: anyOf: - type: string - type: 'null' title: Firstname description: The user's first name. lastName: anyOf: - type: string - type: 'null' title: Lastname description: The user's last name. phoneNumber: anyOf: - type: string - type: 'null' title: Phonenumber description: The user's phone number. email: anyOf: - type: string - type: 'null' title: Email description: The user's email address. type: $ref: '#/components/schemas/UserType' description: The type of user. locationId: anyOf: - type: string - type: 'null' title: Locationid description: The location of the user. externalId: anyOf: - type: string - type: 'null' title: Externalid description: The user's external identifier if available. address: anyOf: - type: string - type: 'null' title: Address description: The user's primary address. addressLineTwo: anyOf: - type: string - type: 'null' title: Addresslinetwo description: Additional address information. city: anyOf: - type: string - type: 'null' title: City description: The city of the user's address. state: anyOf: - type: string - type: 'null' title: State description: The state of the user's address. zipCode: anyOf: - type: string - type: 'null' title: Zipcode description: The postal code of the user's address. country: anyOf: - type: string - type: 'null' title: Country description: The country of the user's address. createdDate: type: string format: date-time title: Createddate description: The date and time when the user was created. addressValid: anyOf: - type: boolean - type: 'null' title: Addressvalid description: Whether the user's address is valid. meta: anyOf: - type: object - type: 'null' title: Meta description: Any additional metadata about the user relevant to your system. isArchived: anyOf: - type: boolean - type: 'null' title: Isarchived description: Whether the user is archived. primaryLocationId: anyOf: - type: string - type: 'null' title: Primarylocationid description: The primary location of the user. gender: anyOf: - type: string - type: 'null' title: Gender description: The gender of the patient. dateOfBirth: anyOf: - type: string format: date - type: 'null' title: Dateofbirth description: The date of birth of the patient. patientMedications: anyOf: - items: type: string type: array - type: 'null' title: Patientmedications description: List of patient's self-reported medications. onSchedulingBlacklist: anyOf: - type: boolean - type: 'null' title: Onschedulingblacklist description: Whether the patient is on the scheduling blacklist. surchargeDisabled: anyOf: - type: boolean - type: 'null' title: Surchargedisabled description: Whether surcharges are disabled for this patient. tags: anyOf: - items: $ref: '#/components/schemas/PatientTagSummary' type: array - type: 'null' title: Tags description: List of patient tags creditBalance: anyOf: - type: integer - type: 'null' title: Creditbalance description: Patient's credit balance in cents. preferredProviderId: anyOf: - type: string - type: 'null' title: Preferredproviderid description: The preferred provider ID for this patient. type: object required: - id - type - createdDate title: PatientSummary ChargeItem: properties: id: anyOf: - type: string - type: 'null' title: Id description: Unique identifier for the charge item itemId: anyOf: - type: string - type: 'null' title: Itemid description: Optional unique identifier for the item chargeId: type: string title: Chargeid description: Identifier of the charge this item is associated with name: anyOf: - type: string - type: 'null' title: Name description: Name of the item (None for items with associated inventory item) description: anyOf: - type: string - type: 'null' title: Description description: Description of the item quantity: type: integer title: Quantity description: Quantity of the item being charged discountAmount: anyOf: - type: integer - type: 'null' title: Discountamount description: Discount amount for the item discountPercentage: anyOf: - type: number - type: 'null' title: Discountpercentage description: Discount percentage for the item discountReason: anyOf: - type: string - type: 'null' title: Discountreason description: Reason for discount price: type: integer title: Price description: Price of the item in cents soldPackageId: anyOf: - type: string - type: 'null' title: Soldpackageid description: Unique identifier for the sold package usage bankedQuantity: anyOf: - type: integer - type: 'null' title: Bankedquantity description: Quantity to bank for later use bankedItemId: anyOf: - type: string - type: 'null' title: Bankeditemid description: ID of banked item being used (for tracking usage) issuedDiscountId: anyOf: - type: string - type: 'null' title: Issueddiscountid description: Unique identifier for the specific issued discount instance used soldByProviderId: anyOf: - type: string - type: 'null' title: Soldbyproviderid description: Unique identifier for the provider who sold the item taxAmount: anyOf: - type: integer - type: 'null' title: Taxamount description: Tax amount for the item in cents pricingId: anyOf: - type: string - type: 'null' title: Pricingid description: Unique identifier for the pricing for the item shipmentIds: anyOf: - items: type: string type: array - type: 'null' title: Shipmentids description: Optional list of shipment IDs to reduce the stock quantity of type: object required: - chargeId - quantity - price title: ChargeItem ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError PackageItem-Output: properties: id: type: string title: Id description: Unique identifier for the package item packageId: type: string title: Packageid description: Package ID this item belongs to itemId: type: string title: Itemid description: Item ID for this package item quantity: anyOf: - type: integer - type: 'null' title: Quantity description: Quantity of the item in the package price: type: integer title: Price description: Price of the item in the package in cents item: anyOf: - $ref: '#/components/schemas/ItemTiny' - type: 'null' description: Details of the item type: object required: - packageId - itemId - price title: PackageItem ItemTiny: properties: id: type: string title: Id description: Unique identifier for the item name: type: string title: Name description: Name of the item brandName: anyOf: - type: string - type: 'null' title: Brandname description: Optional brand name of the item description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the item price: type: integer title: Price description: Price of the item in cents category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) unit: anyOf: - $ref: '#/components/schemas/Unit' - type: 'null' description: Unit of measurement for the item isPhysical: type: boolean title: Isphysical description: Whether the item is physical default: true isArchived: type: boolean title: Isarchived description: Whether the item is archived default: false internalNotes: anyOf: - type: string - type: 'null' title: Internalnotes description: Optional internal notes for the item taxable: type: boolean title: Taxable description: Whether the item is subject to taxes default: false sortOrder: anyOf: - type: integer - type: 'null' title: Sortorder description: Optional sort order for the item allowCustomPricing: type: boolean title: Allowcustompricing description: Whether custom pricing is allowed for this item default: false type: $ref: '#/components/schemas/ItemType' description: Type of item (PRODUCT, MEDICATION, etc.) default: PRODUCT type: object required: - name - price title: ItemTiny ChargeSummaryForItem: properties: id: type: string title: Id description: Unique identifier for the charge patientId: type: string title: Patientid description: Identifier of the patient being charged total: type: integer title: Total description: Total amount of the charge. totalOutstanding: type: integer title: Totaloutstanding description: Total outstanding amount that is yet to be paid. description: anyOf: - type: string - type: 'null' title: Description description: Description of the charge. status: $ref: '#/components/schemas/ChargeStatus' description: Current status of the charge. createdDate: anyOf: - type: string format: date-time - type: 'null' title: Createddate description: The date when the charge was created. type: object required: - id - patientId - total - totalOutstanding - status title: ChargeSummaryForItem UserType: type: string enum: - PROVIDER - PATIENT - ASSISTANT title: UserType PatientTagSummary: properties: id: type: string title: Id description: Unique identifier for the patient tag name: type: string title: Name description: Name of the patient tag emoji: anyOf: - type: string - type: 'null' title: Emoji description: Emoji associated with the tag color: anyOf: - type: string - type: 'null' title: Color description: Color code for the tag (hex format) isActive: type: boolean title: Isactive description: Whether the tag is active createdDate: type: string format: date-time title: Createddate description: Date and time when the tag was created updatedDate: anyOf: - type: string format: date-time - type: 'null' title: Updateddate description: Date and time when the tag was last updated type: object required: - id - name - isActive - createdDate title: PatientTagSummary Unit: type: string enum: - 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 title: Unit ItemType: type: string enum: - ITEM - PRODUCT - MEDICATION - SERVICE - PACKAGE - MEMBERSHIP title: ItemType ChargeStatus: type: string enum: - OUTSTANDING - PAID - EXTERNAL_SETTLEMENT - VOID - WRITE_OFF - REFUNDED - CHARGEBACK - PAYMENT_PLAN - COLLECTIONS title: ChargeStatus ````