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>'

[
  {
    "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

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>'

[
  {
    "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

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

chargeId

string

required

Identifier of the charge this item is associated with

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

Show child attributes

charge.id

string

required

Unique identifier for the charge

charge.patientId

string

required

Identifier of the patient being charged

charge.total

integer

required

Total amount of the charge.

charge.totalOutstanding

integer

required

Total outstanding amount that is yet to be paid.

charge.status

enum<string>

required

Current status of the charge.

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

charge.description

string | null

Description of the charge.

charge.createdDate

string<date-time> | null

The date when the charge was created.

string | null

Unique identifier for the charge item

itemId

string | null

Optional unique identifier for the item

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)

Show child attributes

item.name

string

required

Name of the item

item.price

integer

required

Price of the item in cents

item.id

string

Unique identifier for the item

item.brandName

string | null

Optional brand name of the item

item.description

string | null

Optional description of the item

item.category

string | null

Category name (references category.name)

item.unit

enum<string> | null

Unit of measurement for the item

Available options:

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

item.isPhysical

boolean

default:true

Whether the item is physical

item.isArchived

boolean

default:false

Whether the item is archived

item.internalNotes

string | null

Optional internal notes for the item

item.taxable

boolean

default:false

Whether the item is subject to taxes

item.sortOrder

integer | null

Optional sort order for the item

item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

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

Get Shipment Get Stock

⌘I

Getting Started

API

Tenant

Webhook

Get Sold Package Charge Items

Headers

Path Parameters

Response