> ## 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.

# List Sold Packages

> Get sold packages with optional filtering by patient_id or package_id and other filters.



## OpenAPI

````yaml get /inventory/packages/sold
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/sold:
    get:
      tags:
        - Packages
      summary: List Sold Packages
      description: >-
        Get sold packages with optional filtering by patient_id or package_id
        and other filters.
      operationId: list_sold_packages_inventory_packages_sold_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: patient_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by patient ID
            title: Patient Id
          description: Filter by patient ID
        - name: package_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by package ID
            title: Package Id
          description: Filter by 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: location_ids
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by purchase location IDs
            title: Location Ids
          description: Filter by purchase location IDs
        - 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 List Sold Packages Inventory Packages Sold 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
        cancellationReason:
          anyOf:
            - type: string
            - type: 'null'
          title: Cancellationreason
          description: Reason for cancellation if the package is cancelled
        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
        discounts:
          items:
            $ref: '#/components/schemas/DiscountDetailWithSource'
          type: array
          title: Discounts
          description: Discounts applied to the sold package
        patient:
          $ref: '#/components/schemas/PatientSummary'
          description: Details of the patient
        chargeItem:
          $ref: '#/components/schemas/ChargeItemTiny'
          description: Simplified 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
        allowCustomPricing:
          type: boolean
          title: Allowcustompricing
          description: Whether staff may override the package price at checkout or in carts
          default: false
        commissionable:
          type: boolean
          title: Commissionable
          description: Whether this package is eligible for commissions
          default: true
        showInCheckOut:
          type: boolean
          title: Showincheckout
          description: Whether this package appears in checkout product search
          default: true
        hiddenInOnlineShop:
          type: boolean
          title: Hiddeninonlineshop
          description: Whether this package is hidden from the online shop
          default: true
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
          description: Optional external ID for the package
        defaultCptCode:
          anyOf:
            - type: string
            - type: 'null'
          title: Defaultcptcode
          description: Default CPT / HCPCS code for Super Bill autofill
        defaultModifiers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Defaultmodifiers
          description: Default procedure modifiers for Super Bill autofill
        defaultIcd10Codes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Defaulticd10Codes
          description: Default ICD-10 codes for Super Bill autofill
        internalNotes:
          anyOf:
            - type: string
            - type: 'null'
          title: Internalnotes
          description: Optional internal notes for the package
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Category name (references category.name)
        discountTemplates:
          anyOf:
            - items:
                $ref: '#/components/schemas/PackageDiscountTemplate'
              type: array
            - type: 'null'
          title: Discounttemplates
          description: Discount templates for the package
        exemptedTaxIds:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Exemptedtaxids
          description: List of tax IDs this package is exempt from
        expiryDays:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Expirydays
          description: Days until a sold copy expires. None = never expires.
        expiryAnchor:
          $ref: '#/components/schemas/PackageExpiryAnchor'
          description: Whether the expiry clock starts at purchase or at first redemption.
          default: PURCHASE
        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
    DiscountDetailWithSource:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the discount
        discountTemplateId:
          anyOf:
            - type: string
            - type: 'null'
          title: Discounttemplateid
          description: ID of the template this discount was created from
        patientId:
          anyOf:
            - type: string
            - type: 'null'
          title: Patientid
          description: ID of the patient who owns this discount
        memberId:
          anyOf:
            - type: string
            - type: 'null'
          title: Memberid
          description: ID of the member this discount belongs to
        soldPackageId:
          anyOf:
            - type: string
            - type: 'null'
          title: Soldpackageid
          description: ID of the sold package that created this discount
        createdByChargeItemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Createdbychargeitemid
          description: ID of the charge item that created this discount (for saved items)
        discountChoiceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Discountchoiceid
          description: ID of the discount choice group
        type:
          $ref: '#/components/schemas/DiscountType'
          description: Type of discount (CATEGORY, PRODUCT, SERVICE, ALL)
        itemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Itemid
          description: ID of the specific item for this discount
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Category name this discount applies to
        itemType:
          anyOf:
            - $ref: '#/components/schemas/ItemType'
            - type: 'null'
          description: Type of item this discount applies to
        percentage:
          anyOf:
            - type: number
              maximum: 100
              minimum: 0
            - type: 'null'
          title: Percentage
          description: Discount percentage (0-100)
        amount:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Amount
          description: Discount amount in cents
        quantity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantity
          description: Total quantity for this discount (None = infinite)
        quantityRemaining:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantityremaining
          description: Quantity remaining in the discount
        expiryDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expirydate
          description: When this discount expires
        uses:
          items:
            $ref: >-
              #/components/schemas/decoda__schemas__billing__discounts__discount_use__DiscountUse
          type: array
          title: Uses
          description: Usages of this discount
        isStackable:
          type: boolean
          title: Isstackable
          description: Whether this discount can be combined with other discounts
          default: true
        isPrepayment:
          type: boolean
          title: Isprepayment
          description: Whether this is a prepayment (commissions on full price)
          default: false
        isChosen:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Ischosen
          description: Whether this discount was chosen from a choice group
        isArchived:
          type: boolean
          title: Isarchived
          description: Whether the discount is archived
          default: false
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
          description: Optional comment for custom discounts
        group:
          anyOf:
            - type: string
            - type: 'null'
          title: Group
          description: Group for choice-based discounts
        member:
          anyOf:
            - $ref: '#/components/schemas/MemberTiny'
            - type: 'null'
          description: Member this discount belongs to
        soldPackage:
          anyOf:
            - $ref: '#/components/schemas/DiscountSoldPackageTiny'
            - type: 'null'
          description: Sold package this discount belongs to
        item:
          anyOf:
            - $ref: '#/components/schemas/DiscountItemTiny'
            - type: 'null'
          description: Item this discount applies to
        discountTemplate:
          anyOf:
            - $ref: '#/components/schemas/DiscountTemplateTiny'
            - type: 'null'
          description: Discount template this discount was created from
      type: object
      required:
        - type
      title: DiscountDetailWithSource
    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:
            - additionalProperties: true
              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.
        pronouns:
          anyOf:
            - type: string
            - type: 'null'
          title: Pronouns
          description: The patient's pronouns (e.g., 'he/him', 'she/her', 'they/them').
        preferredName:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Preferredname
          description: The patient's preferred name or nickname.
        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.
        patientSource:
          anyOf:
            - $ref: '#/components/schemas/PatientSource'
            - type: 'null'
          description: The source of the patient.
        leadSource:
          anyOf:
            - type: string
            - type: 'null'
          title: Leadsource
          description: Flexible lead source for tracking patient acquisition.
        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.
        optedInToSmsMarketing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Optedintosmsmarketing
          description: Whether the patient has opted in to marketing SMS messages.
        optedInToEmailMarketing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Optedintoemailmarketing
          description: Whether the patient has opted in to marketing email messages.
        optedInToSocialMedia:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Optedintosocialmedia
          description: >-
            Whether the patient has consented to appear on the practice's social
            media / marketing channels.
        aiScribeConsent:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Aiscribeconsent
          description: >-
            Whether the patient consents to AI scribe recording during visits.
            False auto-disables AI note generation 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.
        dosespotPatientId:
          anyOf:
            - type: string
            - type: 'null'
          title: Dosespotpatientid
          description: DoseSpot Patient ID for e-prescribing integration
      type: object
      required:
        - id
        - type
        - createdDate
      title: PatientSummary
    ChargeItemTiny:
      properties:
        id:
          type: string
          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
        quantity:
          type: number
          title: Quantity
          description: Quantity of the item being charged
        price:
          type: integer
          title: Price
          description: Price of the item in cents
        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
      type: object
      required:
        - id
        - chargeId
        - quantity
        - price
      title: ChargeItemTiny
      description: >-
        Simplified charge item schema for SoldPackageDetail to avoid loading
        nested relationships.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PackageDiscountTemplate:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the discount template
        createdByItemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Createdbyitemid
          description: ID of the item (membership or package) that creates this discount
        discountChoiceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Discountchoiceid
          description: ID of the discount choice group
        itemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Itemid
          description: ID of the specific item for this discount
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Category name for items in this discount (references category.name)
        itemType:
          anyOf:
            - $ref: '#/components/schemas/ItemType'
            - type: 'null'
          description: Type of item this discount applies to (PRODUCT, SERVICE, etc.)
        type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
          description: Type of discount template
        percentage:
          anyOf:
            - type: number
            - type: 'null'
          title: Percentage
          description: Discount percentage (0-100)
        amount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Amount
          description: Discount amount in cents
        quantity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantity
          description: Quantity for this discount (null = unlimited)
        expiryTimeDays:
          anyOf:
            - type: integer
            - type: 'null'
          title: Expirytimedays
          description: Days until discounts expire after issuance (null = never expires)
        renewalCycleInterval:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Renewalcycleinterval
          description: >-
            Number of billing cycles between re-issuances. null = every billing
            cycle.
        isStackable:
          type: boolean
          title: Isstackable
          description: Whether this discount can be combined with other discounts
          default: true
        isPrepayment:
          type: boolean
          title: Isprepayment
          description: Whether this is a prepayment (commissions on full price)
          default: false
        group:
          anyOf:
            - type: string
            - type: 'null'
          title: Group
          description: Group name for discount choices (resolved to discount_choice_id)
        isArchived:
          type: boolean
          title: Isarchived
          description: Whether the discount is archived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
          description: When the template was created
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
          description: When the template was last updated
        item:
          anyOf:
            - $ref: '#/components/schemas/DiscountItemTiny'
            - type: 'null'
          description: Item this template applies to
      type: object
      title: PackageDiscountTemplate
      description: |-
        Package benefit template with its target item embedded.

        Package responses carry the target item inline so the console can
        resolve benefit targets — including archived ones — straight from the
        package payload instead of issuing a second items query. Loaders that
        serialize this schema must selectinload the template's `item` relation.
    PackageExpiryAnchor:
      type: string
      enum:
        - PURCHASE
        - FIRST_REDEMPTION
      title: PackageExpiryAnchor
    DiscountType:
      type: string
      enum:
        - GLOBAL
        - CUSTOM
        - MEMBERSHIP
        - PACKAGE
        - SAVED_ITEM
        - PROMOTION
      title: DiscountType
    ItemType:
      type: string
      enum:
        - ITEM
        - SERVICE
        - PRODUCT
        - PACKAGE
        - MEMBERSHIP
        - MEDICATION
        - SERVICE_FEE
        - GIFT_CARD
      title: ItemType
    decoda__schemas__billing__discounts__discount_use__DiscountUse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the discount use
        discountId:
          type: string
          title: Discountid
          description: ID of the discount that was used
        createdDate:
          type: string
          format: date-time
          title: Createddate
          description: When the discount use was created
        chargeItemId:
          type: string
          title: Chargeitemid
          description: ID of the charge item that the discount was used on
        amount:
          type: integer
          title: Amount
          description: Amount of the discount in cents
        order:
          type: integer
          title: Order
          description: Order in which the discount was applied (0-based)
        quantity:
          type: integer
          title: Quantity
          description: Number of units the discount applies to
      type: object
      required:
        - id
        - discountId
        - createdDate
        - chargeItemId
        - amount
        - order
        - quantity
      title: DiscountUse
      description: Schema for a usage of a discount.
    MemberTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the member
        membership:
          $ref: '#/components/schemas/MembershipTiny'
          description: Membership details
        startDate:
          type: string
          format: date-time
          title: Startdate
          description: When the patient joined the membership
        status:
          $ref: '#/components/schemas/MemberStatus'
          description: Current status of the membership
        freezeDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Freezedate
          description: When the membership should be automatically frozen
        unfreezeDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Unfreezedate
          description: When the membership should be automatically unfrozen
      type: object
      required:
        - id
        - membership
        - startDate
        - status
      title: MemberTiny
    DiscountSoldPackageTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the sold package
        packageId:
          type: string
          title: Packageid
          description: Package ID that was sold
        package:
          anyOf:
            - $ref: '#/components/schemas/DiscountPackageTiny'
            - type: 'null'
          description: Package details
      type: object
      required:
        - id
        - packageId
      title: DiscountSoldPackageTiny
      description: Minimal sold package info for discount source display
    DiscountItemTiny:
      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
        price:
          anyOf:
            - type: integer
            - type: 'null'
          title: Price
          description: Price of the item in cents
        cashPrice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cashprice
          description: Cash price of the item in cents (for dual pricing)
        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
        type:
          anyOf:
            - $ref: '#/components/schemas/ItemType'
            - type: 'null'
          description: Type of item (PRODUCT, SERVICE, etc.)
        isPhysical:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isphysical
          description: Whether the item is physical
        isArchived:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isarchived
          description: Whether the item is archived
        allowCustomPricing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Allowcustompricing
          description: Whether custom pricing is allowed for this item
        showInCheckOut:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Showincheckout
          description: Whether this item appears in checkout
      type: object
      required:
        - id
        - name
      title: DiscountItemTiny
      description: |-
        Minimal item info for discount display.

        Carries enough scalar item detail for the console to append an archived
        benefit target to its active-only catalog list without a second items
        query. Scalar columns only — no relationships — so any loader that
        selectinloads the item row alone can serialize this schema.
    DiscountTemplateTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the discount template
        itemId:
          anyOf:
            - type: string
            - type: 'null'
          title: Itemid
          description: ID of the item this template applies to
        item:
          anyOf:
            - $ref: '#/components/schemas/DiscountItemTiny'
            - type: 'null'
          description: Item this template applies to
      type: object
      required:
        - id
      title: DiscountTemplateTiny
      description: Minimal discount template info for discount display
    UserType:
      type: string
      enum:
        - PROVIDER
        - PATIENT
        - ASSISTANT
      title: UserType
    PatientSource:
      type: string
      enum:
        - SELF_SCHEDULING
        - CALL
        - TEXT
        - MANUALLY_CREATED
        - UPLOADED_FROM_FILE
        - FORM
        - SEED_DATA
        - DEMO
        - EXTERNAL_INTEGRATION
        - REFERRAL
        - WEB_CHAT
        - META_ADS
        - GOOGLE_ADS
        - WEB_FORM
        - IMPORTED_CRM
        - OTHER
      title: PatientSource
    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
    MembershipTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the membership
        name:
          type: string
          title: Name
          description: Name of the membership
        textColor:
          anyOf:
            - type: string
            - type: 'null'
          title: Textcolor
          description: Text color of the membership
      type: object
      required:
        - id
        - name
      title: MembershipTiny
    MemberStatus:
      type: string
      enum:
        - ACTIVE
        - EXPIRED
        - CANCELLED
        - DELINQUENT
        - FROZEN
        - INACTIVE
        - PENDING
        - AWAITING_FORM
      title: MemberStatus
    DiscountPackageTiny:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the package
        name:
          type: string
          title: Name
          description: Name of the package
      type: object
      required:
        - id
        - name
      title: DiscountPackageTiny
      description: Minimal package info for discount source display
    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
        - TROCHES
        - TUBES
        - UNITS
        - VIALS
        - TREATMENTS
        - SESSIONS
        - PULSES
        - JOULES
        - CENTIMETERS
        - THREAD_COUNT
        - INJECTIONS
        - WRINKLE_UNITS
        - POUNDS
        - FEET
        - INCHES
      title: Unit

````