Get Package Usage

Get the usage of a package with optional filtering and sorting.

get/inventory/packages/usage/{package_id}

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/packages/usage/:package_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

package_idstring required

Query parameters

patient_namestring nullable

Filter by patient name

last_activity_datestring nullable

Filter by last activity date

purchased_datestring nullable

Filter by purchased date

statusstring[] nullable

Filter by package status

sort_bystring nullable

Sort field

sort_directionstring nullable

Sort direction (asc or desc)

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring

Unique identifier for the sold package

packageIdstring required

Package ID that was sold

patientIdstring required

Patient ID who purchased the package

chargeItemIdstring required

Charge item ID associated with the package purchase

status'USED' | 'ACTIVE' | 'CANCELLED' required

createdDatestring date-time required

Date the package was created

updatedDatestring date-time nullable

Date the package was updated

Changes

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