Skip to main content
GET
/
inventory
/
packages
/
sold-package
/
{sold_package_id}
/
charge-items
Get Sold Package Charge Items
curl --request GET \
  --url https://api.decodahealth.com/inventory/packages/sold-package/{sold_package_id}/charge-items \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "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>",
    "chargeId": "<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>",
      "sortOrder": 123,
      "allowCustomPricing": false,
      "type": "PRODUCT",
      "externalId": "<string>",
      "exemptedTaxIds": [
        "<string>"
      ]
    },
    "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

sold_package_id
string
required

Response

Successful Response

quantity
integer
required

Quantity of the item being charged

price
integer
required

Price of the item in cents

charge
ChargeSummaryForItem · object
required

Details of the charge

id
string | null

Unique identifier for the charge item

itemId
string | null

Optional unique identifier for the item

chargeId
string | null

Identifier of the charge this item is associated with (optional when creating charge)

name
string | null

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

description
string | null

Description of the item

discountAmount
integer | null

Discount amount for the item

discountPercentage
number | null

Discount percentage for the item

discountReason
string | null

Reason for discount

soldPackageId
string | null

Unique identifier for the sold package usage

bankedQuantity
integer | null

Quantity to bank for later use

bankedItemId
string | null

ID of banked item being used (for tracking usage)

issuedDiscountId
string | null

Unique identifier for the specific issued discount instance used

soldByProviderId
string | null

Unique identifier for the provider who sold the item

taxAmount
integer | null

Tax amount for the item in cents

pricingId
string | null

Unique identifier for the pricing for the item

shipmentIds
string[] | null

Optional list of shipment IDs to reduce the stock quantity of

item
ItemTiny · object

Details of the item (None for custom charge items)

locationId
string | null

Location ID where the sale occurred

locationName
string | null

Location name where the sale occurred

saleDate
string<date-time> | null

Date when the sale occurred