Getting Started
API
- POSTArchive Banked Item
- PUTArchive Commission Report
- DELArchive Membership
- DELArchive Stock
- DELArchive Supplier
- POSTAssign Provider To Structure
- POSTBill Members
- POSTBulk Assign Providers To Structure
- DELBulk Remove Providers From Structure
- PUTCancel Sold Package
- POSTCreate Banked Item
- POSTCreate Commission Structure
- POSTCreate Item
- POSTCreate Membership
- POSTCreate Package
- POSTCreate Shipments
- POSTCreate Stock
- POSTCreate Stock From Csv
- POSTCreate Stock From Image
- POSTCreate Suppliers
- DELDelete Commission Structure
- DELDelete Item
- DELDelete Package
- DELDelete Shipment
- POSTDrawdown Stock
- POSTDuplicate Commission Structure
- POSTEnroll Member Deferred Billing
- POSTGenerate Commission Report
- GETGet Banked Item
- GETGet Banked Item Charge Items
- GETGet Commission Report
- GETGet Commission Structure
- GETGet Commissions For Provider
- GETGet Inventory Logs
- GETGet Issued Discounts
- GETGet Item Brand Names
- GETGet Member
- GETGet Member Logs
- GETGet Membership
- GETGet Package
- GETGet Package Usage
- GETGet Provider Commission Structures
- GETGet Shipment
- GETGet Sold Package Charge Items
- GETGet Stock
- GETGet Supplier
- POSTLink Stock To Item
- GETList Commission Reports
- GETList Commission Structures
- GETList Item
- GETList Membership Usage
- GETList Memberships
- GETList Packages
- GETList Patient Banked Items
- GETList Patient Packages
- GETList Providers With Commission Structures
- GETList Shipments
- GETList Stocks
- GETList Suppliers
- POSTManual Payment
- DELRemove Provider From Structure
- POSTSave Commission Report
- GETSearch Stocks
- POSTUnfreeze Members
- POSTUnlink Stock From Item
- POSTUpdate Billing Date
- PUTUpdate Commission Structure
- POSTUpdate Discount
- PUTUpdate Item
- POSTUpdate Member Sold By Provider
- PUTUpdate Membership
- PUTUpdate Package
- POSTUpdate Payment Method
- PUTUpdate Shipments
- POSTUpdate Status
- PUTUpdate Stock
- PUTUpdate Supplier
- POST
Tenant
curl --request GET \
--url https://api.decodahealth.com/inventory/packages/usage/{package_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"packageId": "<string>",
"patientId": "<string>",
"chargeItemId": "<string>",
"status": "USED",
"package": {
"name": "<string>",
"price": 123,
"id": "<string>",
"description": "<string>",
"isArchived": false,
"internalNotes": "<string>",
"items": [
{
"packageId": "<string>",
"itemId": "<string>",
"price": 123,
"id": "<string>",
"quantity": 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"
}
}
],
"category": "<string>",
"numberOfActivePatients": 0,
"numberOfPatients": 0,
"createdDate": "2023-11-07T05:31:56Z"
},
"createdDate": "2023-11-07T05:31:56Z",
"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>"
},
"chargeItem": {
"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>",
"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 Package Usage
Get the usage of a package with optional filtering and sorting.
curl --request GET \
--url https://api.decodahealth.com/inventory/packages/usage/{package_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"packageId": "<string>",
"patientId": "<string>",
"chargeItemId": "<string>",
"status": "USED",
"package": {
"name": "<string>",
"price": 123,
"id": "<string>",
"description": "<string>",
"isArchived": false,
"internalNotes": "<string>",
"items": [
{
"packageId": "<string>",
"itemId": "<string>",
"price": 123,
"id": "<string>",
"quantity": 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"
}
}
],
"category": "<string>",
"numberOfActivePatients": 0,
"numberOfPatients": 0,
"createdDate": "2023-11-07T05:31:56Z"
},
"createdDate": "2023-11-07T05:31:56Z",
"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>"
},
"chargeItem": {
"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>",
"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
The tenant you are making this request on behalf of
Your api key
Path Parameters
Query Parameters
Filter by patient name
Filter by last activity date
Filter by purchased date
Filter by package status
Sort field
Sort direction (asc or desc)
Response
Successful Response
Package ID that was sold
Patient ID who purchased the package
Charge item ID associated with the package purchase
Status of the sold package
USED, ACTIVE, CANCELLED Details of the package
Show child attributes
Show child attributes
Name of the package
Price of the package in cents
Unique identifier for the package
Optional description of the package
Whether the package is archived
Optional internal notes for the package
Items included in the package
Show child attributes
Show child attributes
Package ID this item belongs to
Item ID for this package item
Price of the item in the package in cents
Unique identifier for the package item
Quantity of the item in the package
Details of the item
Show child attributes
Show child attributes
Name of the item
Price of the item in cents
Unique identifier for the item
Optional brand name of the item
Optional description of the item
Category name (references category.name)
Unit of measurement for the item
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 Whether the item is physical
Whether the item is archived
Optional internal notes for the item
Whether the item is subject to taxes
Optional sort order for the item
Whether custom pricing is allowed for this item
Type of item (PRODUCT, MEDICATION, etc.)
ITEM, PRODUCT, MEDICATION, SERVICE, PACKAGE, MEMBERSHIP Category name (references category.name)
Number of active patients on this package
Total number of patients who have purchased this package
Date the package was created
Date the package was created
Details of the patient
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Show child attributes
Show child attributes
Unique identifier for the patient tag
Name of the patient tag
Whether the tag is active
Date and time when the tag was created
Emoji associated with the tag
Color code for the tag (hex format)
Date and time when the tag was last updated
Patient's credit balance in cents.
The preferred provider ID for this patient.
Details of the charge item
Show child attributes
Show child attributes
Identifier of the charge this item is associated with
Quantity of the item being charged
Price of the item in cents
Unique identifier for the charge item
Optional unique identifier for the item
Name of the item (None for items with associated inventory item)
Description of the item
Discount amount for the item
Discount percentage for the item
Reason for discount
Unique identifier for the sold package usage
Quantity to bank for later use
ID of banked item being used (for tracking usage)
Unique identifier for the specific issued discount instance used
Unique identifier for the provider who sold the item
Tax amount for the item in cents
Unique identifier for the pricing for the item
Optional list of shipment IDs to reduce the stock quantity of
Unique identifier for the sold package
Date the package was updated
Items used in the package
Show child attributes
Show child attributes
Identifier of the charge this item is associated with
Quantity of the item being charged
Price of the item in cents
Details of the charge
Show child attributes
Show child attributes
Unique identifier for the charge
Identifier of the patient being charged
Total amount of the charge.
Total outstanding amount that is yet to be paid.
Current status of the charge.
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Description of the charge.
The date when the charge was created.
Unique identifier for the charge item
Optional unique identifier for the item
Name of the item (None for items with associated inventory item)
Description of the item
Discount amount for the item
Discount percentage for the item
Reason for discount
Unique identifier for the sold package usage
Quantity to bank for later use
ID of banked item being used (for tracking usage)
Unique identifier for the specific issued discount instance used
Unique identifier for the provider who sold the item
Tax amount for the item in cents
Unique identifier for the pricing for the item
Optional list of shipment IDs to reduce the stock quantity of
Details of the item (None for custom charge items)
Show child attributes
Show child attributes
Name of the item
Price of the item in cents
Unique identifier for the item
Optional brand name of the item
Optional description of the item
Category name (references category.name)
Unit of measurement for the item
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 Whether the item is physical
Whether the item is archived
Optional internal notes for the item
Whether the item is subject to taxes
Optional sort order for the item
Whether custom pricing is allowed for this item
Type of item (PRODUCT, MEDICATION, etc.)
ITEM, PRODUCT, MEDICATION, SERVICE, PACKAGE, MEMBERSHIP Location ID where the sale occurred
Location name where the sale occurred
Date when the sale occurred