---
title: "Get Alert"
method: GET
path: "/alerts/{alert_id}"
tags: ["provider", "alert"]
---

# Get Alert

`GET /alerts/{alert_id}`

## Path parameters

- `alert_id` string, required

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- AlertSummary
  - `id` string, required
  - `type` 'PATIENT_CREATED' | 'PATIENT_UPDATED' | 'APPOINTMENT_CANCELLED' | 'APPOINTMENT_UPDATED' | 'APPOINTMENT_REQUEST' | 'APPOINTMENT_SCHEDULED' | 'SELF_SCHEDULED_APPOINTMENT' | 'SELF_SCHEDULED_APPOINTMENT_CANCELLED' | 'SELF_SCHEDULED_APPOINTMENT_UPDATED' | 'BLOCK_CREATED' | 'BLOCK_CANCELLED' | 'BLOCK_UPDATED' | 'SHIFT_CREATED' | 'SHIFT_CANCELLED' | 'SHIFT_UPDATED' | 'PAYMENT_CREATED' | 'PAYMENT_FAILED' | 'PAYMENT_SUCCEEDED' | 'PLANNED_PAYMENT_FAILED' | 'PLANNED_PAYMENT_SUCCEEDED' | 'CHARGE_CREATED' | 'REFUND_CREATED' | 'REFUND_FAILED' | 'REFUND_SUCCEEDED' | 'ADJUSTMENT_CREATED' | 'ADJUSTMENT_FAILED' | 'ADJUSTMENT_SUCCEEDED' | 'INVOICE_UPDATED' | 'INVOICE_STATUS_UPDATE' | 'INVOICE_SET_UPDATED' | 'CHARGE_PAYMENT_CREATED' | 'CALL_RECEIVED' | 'CALL_MADE' | 'CALL_ONGOING' | 'MESSAGE_RECEIVED' | 'MESSAGE_SENT' | 'MESSAGE_DELIVERED' | 'MESSAGE_FAILED' | 'EMAIL_RECEIVED' | 'EMAIL_SENT' | 'MAIL_SENT' | 'MAIL_DELIVERY_FAILED' | 'FORM_SUBMITTED' | 'APPOINTMENT_CHECKLIST_FILLED_FORM' | 'APPOINTMENT_CHECKLIST_CHECKED_IN' | 'APPOINTMENT_CHECKLIST_WITH_MA' | 'APPOINTMENT_CHECKLIST_MEASUREMENT_TAKEN' | 'APPOINTMENT_CHECKLIST_DOSE_TAKEN' | 'APPOINTMENT_CHECKLIST_WITH_PROVIDER' | 'APPOINTMENT_CHECKLIST_NOTE_TAKEN' | 'APPOINTMENT_CHECKLIST_PAYMENT_MADE' | 'APPOINTMENT_CHECKLIST_REQUEST_GFE' | 'APPOINTMENT_CHECKLIST_PICTURE_TAKEN' | 'APPOINTMENT_CHECKLIST_CARE_PLAN' | 'NOTIFICATION' | 'LOW_PATIENT_REVIEW' | 'CHAT_UPDATE' | 'RAINFOREST_PAYIN_FAILED' | 'RAINFOREST_PAYIN_PROCESSING' | 'RAINFOREST_POS_PAYIN_CANCELLED' | 'RAINFOREST_DEPOSIT_IN_REVIEW' | 'RAINFOREST_DEPOSIT_SUCCEEDED' | 'RAINFOREST_DEPOSIT_FAILED' | 'STOCK_LOW' | 'STOCK_ADDED' | 'STOCK_ARCHIVED' | 'STOCK_LINKED_TO_ITEM' | 'STOCK_UNLINKED_FROM_ITEM' | 'STOCK_UPDATED' | 'STOCK_DRAWDOWN' | 'SHIPMENT_RECEIVED' | 'SHIPMENT_UPDATED' | 'SHIPMENT_ARCHIVED' | 'ITEM_CREATED' | 'ITEM_UPDATED' | 'ITEM_ARCHIVED' | 'INVENTORY_ACTION', required
  - `data` union, required
    - PaymentSummary
      - `id` string, required — The unique identifier for the payment.
      - `patientId` string, nullable — The ID of the patient associated with the payment.
      - `payinId` string, nullable — The ID of the payin associated with the payment.
      - `amount` integer, required — The total amount of the payment.
      - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required
      - `currency` string — The currency in which the payment was made.
      - `payinConfigId` string, nullable — The configuration ID for the payin.
      - `paymentMedium` string, required — The name of the payment medium.
      - `paymentMethodId` string, nullable — The ID of the payment method used.
      - `stripePaymentIntentId` string, nullable — Stripe's payment intent ID if used.
      - `failedReason` string, nullable — Reason for payment failure if applicable.
      - `updatedDate` string, date-time, nullable — The date and time the payment was last updated.
      - `createdDate` string, date-time, required — The date and time the payment was created.
      - `fee` integer — The fee charged by the payment processor.
      - `feeToPatient` integer, required — The fee charged to the patient for the transaction.
    - RefundSummary
      - `id` string, required
      - `paymentId` string, required
      - `amount` integer, required
      - `reason` 'DUPLICATE' | 'DISPUTE' | 'BOOKING_FEE' | 'OTHER', required
      - `createdDate` string, date-time, required
      - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required
      - `rainforestRefundId` string, nullable
      - `fee` integer
    - AdjustmentSummary
      - `chargeId` string, required
      - `providerId` string, nullable
      - `locationId` string, nullable
      - `id` string, required — Unique identifier for the adjustment
      - `amount` integer, required — Amount of the adjustment
      - `reason` string, nullable — Reason for the adjustment
      - `createdDate` string, date-time, required — Date when the adjustment was created
      - `adjustmentType` 'WRITE_OFF' | 'ADJUSTMENT' | 'EXTERNAL_SETTLEMENT', required
    - ChargeSummaryOutput
      - `id` string, nullable — A unique identifier for the charge. Auto-generated if not provided.
      - `patientId` string, required — Identifier of the patient being charged.
      - `patient` PatientSummary
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
        - `externalId` string, nullable — The user's external identifier if available.
        - `address` string, nullable — The user's primary address.
        - `addressLineTwo` string, nullable — Additional address information.
        - `city` string, nullable — The city of the user's address.
        - `state` string, nullable — The state of the user's address.
        - `zipCode` string, nullable — The postal code of the user's address.
        - `country` string, nullable — The country of the user's address.
        - `createdDate` string, date-time, required — The date and time when the user was created.
        - `addressValid` boolean, nullable — Whether the user's address is valid.
        - `meta` object, nullable — Any additional metadata about the user relevant to your system.
        - `isArchived` boolean, nullable — Whether the user is archived.
        - `primaryLocationId` string, nullable — The primary location of the user.
        - `gender` string, nullable — The gender of the patient.
        - `dateOfBirth` string, date, nullable — The date of birth of the patient.
        - `patientMedications` string[], nullable — List of patient's self-reported medications.
        - `onSchedulingBlacklist` boolean, nullable — Whether the patient is on the scheduling blacklist.
        - `surchargeDisabled` boolean, nullable — Whether surcharges are disabled for this patient.
        - `tags` PatientTagSummary[], nullable — List of patient tags
          - `id` string, required — Unique identifier for the patient tag
          - `name` string, required — Name of the patient tag
          - `emoji` string, nullable — Emoji associated with the tag
          - `color` string, nullable — Color code for the tag (hex format)
          - `isActive` boolean, required — Whether the tag is active
          - `createdDate` string, date-time, required — Date and time when the tag was created
          - `updatedDate` string, date-time, nullable — Date and time when the tag was last updated
        - `creditBalance` integer, nullable — Patient's credit balance in cents.
        - `preferredProviderId` string, nullable — The preferred provider ID for this patient.
      - `total` integer — Total amount of the charge.
      - `totalOutstanding` integer, required — Total outstanding amount that is yet to be paid.
      - `description` string, nullable — Description of the charge.
      - `status` 'OUTSTANDING' | 'PAID' | 'EXTERNAL_SETTLEMENT' | 'VOID' | 'WRITE_OFF' | 'REFUNDED' | 'CHARGEBACK' | 'PAYMENT_PLAN' | 'COLLECTIONS'
      - `discountAmount` integer, nullable — Any discount applied to the total outstanding.
      - `discountPercentage` number, nullable — Percentage of discount applied to the charge.
      - `externalId` string, nullable — External identifier for the charge, if applicable.
      - `externalCreatedDate` string, date-time, nullable — The creation date of the charge in your external system, if applicable.
      - `ruleSetId` string, nullable — Identifier for the `RuleSet` applied to this `Charge`, if any.
      - `createdDate` string, date-time, nullable — The date when the charge was created.
      - `creatorId` string, nullable — Identifier of the `Provider` who created the charge (i.e. the Clinician, or relevant Biller).
      - `items` ChargeItem[] — List of `Items` in the `Charge`.
        - `id` string, nullable — Unique identifier for the charge item
        - `itemId` string, nullable — Optional unique identifier for the item
        - `chargeId` string, required — Identifier of the charge this item is associated with
        - `name` string, nullable — Name of the item (None for items with associated inventory item)
        - `description` string, nullable — Description of the item
        - `quantity` integer, required — Quantity of the item being charged
        - `discountAmount` integer, nullable — Discount amount for the item
        - `discountPercentage` number, nullable — Discount percentage for the item
        - `discountReason` string, nullable — Reason for discount
        - `price` integer, required — Price of the item in cents
        - `soldPackageId` string, nullable — Unique identifier for the sold package usage
        - `bankedQuantity` integer, nullable — Quantity to bank for later use
        - `bankedItemId` string, nullable — ID of banked item being used (for tracking usage)
        - `issuedDiscountId` string, nullable — Unique identifier for the specific issued discount instance used
        - `soldByProviderId` string, nullable — Unique identifier for the provider who sold the item
        - `taxAmount` integer, nullable — Tax amount for the item in cents
        - `pricingId` string, nullable — Unique identifier for the pricing for the item
        - `shipmentIds` string[], nullable — Optional list of shipment IDs to reduce the stock quantity of
      - `tips` TipDetail[] — List of `Tips` in the `Charge`.
        - `chargeId` string, required — Charge ID this tip belongs to
        - `amount` integer, required — Tip amount in cents
        - `providerId` string, required — Provider ID receiving the tip
        - `id` string — Unique identifier for the tip
        - `provider` ProviderTiny
          - `id` string, required
          - `firstName` string, required
          - `lastName` string, nullable
          - `email` string, nullable
          - `createdDate` string, date-time, nullable
      - `locationId` string, nullable — Identifier of the `Location` where the charge was created.
      - `eventId` string, nullable — Identifier of the `Event` this charge is associated with, if any.
      - `memberId` string, nullable — Identifier of the `Member` this charge is associated with, if any.
      - `comment` string, nullable — Any additional comments about the charge.
      - `meta` object, nullable — Any additional metadata about the charge relevant to your system.
      - `merchantAccountId` string, nullable — Identifier of the `MerchantAccount` this charge is associated with.
    - ServiceDetail
      - `id` string, required
      - `duration` integer, required
      - `name` string, required
      - `locationIds` string[], nullable
      - `color` string, required
      - `description` string, nullable
      - `price` integer, nullable
      - `displayPrice` integer, nullable
      - `costOfService` integer
      - `estimated` boolean, nullable
      - `bookingFee` integer, required
      - `bookingFeeText` string, nullable
      - `reminderDaysBefore` integer, nullable
      - `cancellationCost` integer, nullable
      - `hoursBeforeCancellingCosts` integer, nullable
      - `bookingFeePercentage` integer, nullable
      - `cancellationFeePctWithin24h` integer, nullable
      - `cancellationFeePctWithin48h` integer, nullable
      - `refundBookingFeeBefore48h` boolean, nullable
      - `hoursBeforeBookingFeeRefundable` integer, nullable
      - `followUpDaysAfter` integer, nullable
      - `followUpSmsTemplate` string, nullable
      - `providerIds` string[], nullable
      - `forms` FormTiny[], nullable
        - `id` string, required
        - `name` string, required
        - `pathName` string, required
      - `createdDate` string, date-time, nullable
      - `updatedDate` string, date-time, nullable
      - `confirmationSmsTemplate` string, nullable
      - `cancellationSmsTemplate` string, nullable
      - `noShowSmsTemplate` string, nullable
      - `overrideNoticeSmsTemplate` string, nullable
      - `reminderSmsTemplate` string, nullable
      - `selfSchedulingBufferTime` integer, nullable
      - `visibility` 'ALL' | 'NEW' | 'EXISTING' | 'NO'
      - `minutesBeforeRebookingAllowed` integer, nullable
      - `allowIndividualProviderBooking` boolean, nullable
      - `displayOrder` integer, nullable
      - `reservedTimeMinutes` integer, nullable
      - `category` string, nullable
      - `isDoubleBookable` boolean, nullable
      - `isPopular` boolean, nullable
      - `creditCardRequired` boolean, nullable
      - `collectCreditCard` boolean, nullable
      - `autoGfeTreatments` string[], nullable
      - `brandName` string, nullable
      - `unit` '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'
      - `internalNotes` string, nullable
      - `sortOrder` integer, nullable
      - `taxable` boolean, nullable
      - `allowCustomPricing` boolean, nullable
    - MessageSummary
      - `id` string, required
      - `messageUid` string, nullable
      - `content` string, nullable
      - `chatId` string, required
      - `status` 'CREATED' | 'QUEUED' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'UNDELIVERED' | 'DELIVERED' | 'READ' | 'FAILED' | 'EXPIRED' | 'OPTED_OUT', required
      - `errorMessage` string, nullable
      - `sendoMessageId` string, nullable
      - `sender` UserTiny, required
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `functionCall` object, nullable
      - `createdDate` string, date-time, required
      - `files` string[], nullable
      - `suggestedMessages` SuggestedMessageSummary[], nullable
        - `id` string, required
        - `chatId` string, required
        - `fromMessageId` string, required
        - `content` string, required
        - `assistantId` string, required
        - `isSelected` boolean, required
        - `createdDate` string, date-time, required
      - `toolCalls` ToolCallSummary[], nullable
        - `id` string, required
        - `callId` string, nullable
        - `messageId` string, nullable
        - `alertId` string, nullable
        - `toolName` string, required
        - `toolArguments` object, required
        - `toolCallId` string, nullable
        - `result` object, nullable
        - `toolCallDescription` string, nullable
        - `hasBeenCalled` boolean
        - `createdDate` string, date-time, required
      - `eventId` string, nullable
      - `type` 'REMINDER' | 'OVERRIDE' | 'FOLLOW_UP' | 'EXPIRED' | 'CONFIRMATION' | 'INTRODUCTORY' | 'CANCELLED' | 'UPDATE'
    - PaymentWithCharges
      - `id` string, required — The unique identifier for the payment.
      - `patientId` string, nullable — The ID of the patient associated with the payment.
      - `payinId` string, nullable — The ID of the payin associated with the payment.
      - `amount` integer, required — The total amount of the payment.
      - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required
      - `currency` string — The currency in which the payment was made.
      - `payinConfigId` string, nullable — The configuration ID for the payin.
      - `paymentMedium` string, required — The name of the payment medium.
      - `paymentMethodId` string, nullable — The ID of the payment method used.
      - `stripePaymentIntentId` string, nullable — Stripe's payment intent ID if used.
      - `failedReason` string, nullable — Reason for payment failure if applicable.
      - `updatedDate` string, date-time, nullable — The date and time the payment was last updated.
      - `createdDate` string, date-time, required — The date and time the payment was created.
      - `fee` integer — The fee charged by the payment processor.
      - `feeToPatient` integer, required — The fee charged to the patient for the transaction.
      - `charges` ChargePaymentSummary[], required
        - `paymentId` string, required — The unique identifier for the payment.
        - `amount` integer, required — The amount of the payment.
        - `createdDate` string, date-time, nullable — The date and time the payment was created.
        - `chargeId` string, required — The unique identifier for the charge.
    - PatientSummary
      - `id` string, required — The unique identifier for the user.
      - `firstName` string, nullable — The user's first name.
      - `lastName` string, nullable — The user's last name.
      - `phoneNumber` string, nullable — The user's phone number.
      - `email` string, nullable — The user's email address.
      - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
      - `locationId` string, nullable — The location of the user.
      - `externalId` string, nullable — The user's external identifier if available.
      - `address` string, nullable — The user's primary address.
      - `addressLineTwo` string, nullable — Additional address information.
      - `city` string, nullable — The city of the user's address.
      - `state` string, nullable — The state of the user's address.
      - `zipCode` string, nullable — The postal code of the user's address.
      - `country` string, nullable — The country of the user's address.
      - `createdDate` string, date-time, required — The date and time when the user was created.
      - `addressValid` boolean, nullable — Whether the user's address is valid.
      - `meta` object, nullable — Any additional metadata about the user relevant to your system.
      - `isArchived` boolean, nullable — Whether the user is archived.
      - `primaryLocationId` string, nullable — The primary location of the user.
      - `gender` string, nullable — The gender of the patient.
      - `dateOfBirth` string, date, nullable — The date of birth of the patient.
      - `patientMedications` string[], nullable — List of patient's self-reported medications.
      - `onSchedulingBlacklist` boolean, nullable — Whether the patient is on the scheduling blacklist.
      - `surchargeDisabled` boolean, nullable — Whether surcharges are disabled for this patient.
      - `tags` PatientTagSummary[], nullable — List of patient tags
        - `id` string, required — Unique identifier for the patient tag
        - `name` string, required — Name of the patient tag
        - `emoji` string, nullable — Emoji associated with the tag
        - `color` string, nullable — Color code for the tag (hex format)
        - `isActive` boolean, required — Whether the tag is active
        - `createdDate` string, date-time, required — Date and time when the tag was created
        - `updatedDate` string, date-time, nullable — Date and time when the tag was last updated
      - `creditBalance` integer, nullable — Patient's credit balance in cents.
      - `preferredProviderId` string, nullable — The preferred provider ID for this patient.
    - InvoiceUpdate
      - `invoiceId` string, required
      - `method` 'CHARGE_CARD' | 'SMS' | 'EMAIL' | 'CALL' | 'MAIL' | 'EXPIRY' — The method used to send an invoice to a patient.
      - `sendTime` string, date-time, nullable
      - `status` 'PENDING' | 'SENT' | 'FAILED' | 'PAUSED' | 'CANCELLED' — The status of an invoice.
      - `methodsAttempted` array[], nullable
        - unknown[]
          - unknown
      - `failedReason` string, nullable
    - LowPatientReviewData
      - `rating` integer, required
      - `feedback` string, nullable, required
      - `locationName` string, required
      - `patientName` string, required
      - `reviewDate` string, required
      - `locationId` string, required
    - InvoiceSetUpdate
      - `invoiceSetId` string, required
      - `status` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'EXPIRED' | 'PAID' | 'WILL_FAIL' | 'FAILED', required — The status of an invoice set.
      - `pausedDate` string, date-time, nullable
    - Notification
      - `message` string, required
      - `data` object
      - `chatId` string, nullable
      - `callId` string, nullable
      - `messageId` string, nullable
    - CallSummary
      - `id` string, required
      - `sender` UserTiny
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `receiver` UserTiny
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `chatId` string, required
      - `direction` 'INBOUND' | 'OUTBOUND', required
      - `status` 'CREATED' | 'ONGOING' | 'TRANSFERRED' | 'DISCONNECTED' | 'FAILED' | 'FINISHED' | 'VOICEMAIL', required
      - `completedDate` string, date-time, nullable
      - `retellCallId` string, nullable
      - `disconnectionReason` string, nullable
      - `pathToAudio` string, nullable
      - `summary` string, nullable
      - `context` object, nullable
      - `createdDate` string, date-time, nullable
      - `toolCalls` ToolCall[]
        - `id` string, required
        - `toolName` string, required
        - `toolArguments` object, required
        - `toolCallId` string, nullable
      - `tags` TagSummary[]
        - `name` string, required
        - `description` string, nullable
        - `useForAlerts` boolean, required
        - `useForCalls` boolean, required
        - `id` string, required
      - `invoiceId` string, nullable
      - `type` 'MANUAL' | 'AI'
      - `locationId` string, nullable
    - EventDetail
      - `id` string, required
      - `title` string, required
      - `start` string, date-time, required
      - `end` string, date-time, required
      - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
      - `location` LocationSummary
        - `id` string, required
        - `isVirtual` boolean, required
        - `name` string, required
        - `addressLineOne` string, nullable
        - `addressLineTwo` string, nullable
        - `city` string, nullable
        - `state` string, nullable
        - `zipCode` string, nullable
        - `country` string, nullable
        - `createdDate` string, date-time, nullable
        - `spakinectLocationId` string, nullable
      - `attendees` AttendeeDetailOutput[]
        - `user` UserTiny, required
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `inviteStatus` 'PENDING' | 'ACCEPTED' | 'REJECTED', required
      - `status` 'PENDING' | 'RESERVED' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED' | 'OVERRIDABLE' | 'NO_SHOW', required
      - `recurringEventId` string, nullable
      - `recurringEvent` RecurringEventDetail
        - `id` string, required
        - `rrule` string, required
        - `startDate` string, date-time, required
        - `durationMinutes` integer, required
        - `timezone` string, required
        - `serviceIds` string[], nullable
        - `capacity` integer, nullable
        - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
        - `title` string, required
        - `attendeeIds` string[], nullable
        - `locationId` string, nullable
        - `organizerId` string, required
      - `eventServices` EventServiceDetail[]
        - `service` ServiceDetail, required
          - `id` string, required
          - `duration` integer, required
          - `name` string, required
          - `locationIds` string[], nullable
          - `color` string, required
          - `description` string, nullable
          - `price` integer, nullable
          - `displayPrice` integer, nullable
          - `costOfService` integer
          - `estimated` boolean, nullable
          - `bookingFee` integer, required
          - `bookingFeeText` string, nullable
          - `reminderDaysBefore` integer, nullable
          - `cancellationCost` integer, nullable
          - `hoursBeforeCancellingCosts` integer, nullable
          - `bookingFeePercentage` integer, nullable
          - `cancellationFeePctWithin24h` integer, nullable
          - `cancellationFeePctWithin48h` integer, nullable
          - `refundBookingFeeBefore48h` boolean, nullable
          - `hoursBeforeBookingFeeRefundable` integer, nullable
          - `followUpDaysAfter` integer, nullable
          - `followUpSmsTemplate` string, nullable
          - `providerIds` string[], nullable
          - `forms` FormTiny[], nullable
            - `id` string, required
            - `name` string, required
            - `pathName` string, required
          - `createdDate` string, date-time, nullable
          - `updatedDate` string, date-time, nullable
          - `confirmationSmsTemplate` string, nullable
          - `cancellationSmsTemplate` string, nullable
          - `noShowSmsTemplate` string, nullable
          - `overrideNoticeSmsTemplate` string, nullable
          - `reminderSmsTemplate` string, nullable
          - `selfSchedulingBufferTime` integer, nullable
          - `visibility` 'ALL' | 'NEW' | 'EXISTING' | 'NO'
          - `minutesBeforeRebookingAllowed` integer, nullable
          - `allowIndividualProviderBooking` boolean, nullable
          - `displayOrder` integer, nullable
          - `reservedTimeMinutes` integer, nullable
          - `category` string, nullable
          - `isDoubleBookable` boolean, nullable
          - `isPopular` boolean, nullable
          - `creditCardRequired` boolean, nullable
          - `collectCreditCard` boolean, nullable
          - `autoGfeTreatments` string[], nullable
          - `brandName` string, nullable
          - `unit` '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'
          - `internalNotes` string, nullable
          - `sortOrder` integer, nullable
          - `taxable` boolean, nullable
          - `allowCustomPricing` boolean, nullable
        - `providerId` string, nullable
        - `bookables` EventServiceBookable[], nullable
          - `eventId` string, required
          - `serviceId` string, required
          - `bookableId` string, required
          - `start` string, date-time, required
          - `end` string, date-time, required
        - `start` string, date-time, nullable
        - `end` string, date-time, nullable
        - `externalId` string, nullable
        - `isArchived` boolean, nullable
      - `icons` EventIcon[]
      - `capacity` integer, nullable
      - `organizer` UserTiny, required
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `meetingLink` string, nullable
      - `locationId` string, nullable
      - `formCompleted` boolean, nullable
      - `reminders` string[]
      - `recurrenceModificationMode` 'this' | 'future' | 'all' — Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected
      - `createdDate` string, date-time, nullable
      - `quickNotes` QuickNoteSummary[], nullable
        - `id` string, required
        - `patientId` string, required
        - `note` string, required
        - `creator` UserTiny, required
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `eventId` string, nullable
        - `createdDate` string, date-time, required
        - `updatedDate` string, date-time, nullable
        - `isArchived` boolean
    - UpdatedAppointment
      - `updatedFrom` EventDetail, required
        - `id` string, required
        - `title` string, required
        - `start` string, date-time, required
        - `end` string, date-time, required
        - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
        - `location` LocationSummary
          - `id` string, required
          - `isVirtual` boolean, required
          - `name` string, required
          - `addressLineOne` string, nullable
          - `addressLineTwo` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `zipCode` string, nullable
          - `country` string, nullable
          - `createdDate` string, date-time, nullable
          - `spakinectLocationId` string, nullable
        - `attendees` AttendeeDetailOutput[]
          - `user` UserTiny, required
            - `id` string, required — The unique identifier for the user.
            - `firstName` string, nullable — The user's first name.
            - `lastName` string, nullable — The user's last name.
            - `phoneNumber` string, nullable — The user's phone number.
            - `email` string, nullable — The user's email address.
            - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
            - `locationId` string, nullable — The location of the user.
          - `inviteStatus` 'PENDING' | 'ACCEPTED' | 'REJECTED', required
        - `status` 'PENDING' | 'RESERVED' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED' | 'OVERRIDABLE' | 'NO_SHOW', required
        - `recurringEventId` string, nullable
        - `recurringEvent` RecurringEventDetail
          - `id` string, required
          - `rrule` string, required
          - `startDate` string, date-time, required
          - `durationMinutes` integer, required
          - `timezone` string, required
          - `serviceIds` string[], nullable
          - `capacity` integer, nullable
          - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
          - `title` string, required
          - `attendeeIds` string[], nullable
          - `locationId` string, nullable
          - `organizerId` string, required
        - `eventServices` EventServiceDetail[]
          - `service` ServiceDetail, required
            - `id` string, required
            - `duration` integer, required
            - `name` string, required
            - `locationIds` string[], nullable
            - `color` string, required
            - `description` string, nullable
            - `price` integer, nullable
            - `displayPrice` integer, nullable
            - `costOfService` integer
            - `estimated` boolean, nullable
            - `bookingFee` integer, required
            - `bookingFeeText` string, nullable
            - `reminderDaysBefore` integer, nullable
            - `cancellationCost` integer, nullable
            - `hoursBeforeCancellingCosts` integer, nullable
            - `bookingFeePercentage` integer, nullable
            - `cancellationFeePctWithin24h` integer, nullable
            - `cancellationFeePctWithin48h` integer, nullable
            - `refundBookingFeeBefore48h` boolean, nullable
            - `hoursBeforeBookingFeeRefundable` integer, nullable
            - `followUpDaysAfter` integer, nullable
            - `followUpSmsTemplate` string, nullable
            - `providerIds` string[], nullable
            - `forms` FormTiny[], nullable
              - …
            - `createdDate` string, date-time, nullable
            - `updatedDate` string, date-time, nullable
            - `confirmationSmsTemplate` string, nullable
            - `cancellationSmsTemplate` string, nullable
            - `noShowSmsTemplate` string, nullable
            - `overrideNoticeSmsTemplate` string, nullable
            - `reminderSmsTemplate` string, nullable
            - `selfSchedulingBufferTime` integer, nullable
            - `visibility` 'ALL' | 'NEW' | 'EXISTING' | 'NO'
            - `minutesBeforeRebookingAllowed` integer, nullable
            - `allowIndividualProviderBooking` boolean, nullable
            - `displayOrder` integer, nullable
            - `reservedTimeMinutes` integer, nullable
            - `category` string, nullable
            - `isDoubleBookable` boolean, nullable
            - `isPopular` boolean, nullable
            - `creditCardRequired` boolean, nullable
            - `collectCreditCard` boolean, nullable
            - `autoGfeTreatments` string[], nullable
            - `brandName` string, nullable
            - `unit` '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'
            - `internalNotes` string, nullable
            - `sortOrder` integer, nullable
            - `taxable` boolean, nullable
            - `allowCustomPricing` boolean, nullable
          - `providerId` string, nullable
          - `bookables` EventServiceBookable[], nullable
            - `eventId` string, required
            - `serviceId` string, required
            - `bookableId` string, required
            - `start` string, date-time, required
            - `end` string, date-time, required
          - `start` string, date-time, nullable
          - `end` string, date-time, nullable
          - `externalId` string, nullable
          - `isArchived` boolean, nullable
        - `icons` EventIcon[]
        - `capacity` integer, nullable
        - `organizer` UserTiny, required
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `meetingLink` string, nullable
        - `locationId` string, nullable
        - `formCompleted` boolean, nullable
        - `reminders` string[]
        - `recurrenceModificationMode` 'this' | 'future' | 'all' — Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected
        - `createdDate` string, date-time, nullable
        - `quickNotes` QuickNoteSummary[], nullable
          - `id` string, required
          - `patientId` string, required
          - `note` string, required
          - `creator` UserTiny, required
            - `id` string, required — The unique identifier for the user.
            - `firstName` string, nullable — The user's first name.
            - `lastName` string, nullable — The user's last name.
            - `phoneNumber` string, nullable — The user's phone number.
            - `email` string, nullable — The user's email address.
            - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
            - `locationId` string, nullable — The location of the user.
          - `eventId` string, nullable
          - `createdDate` string, date-time, required
          - `updatedDate` string, date-time, nullable
          - `isArchived` boolean
      - `updatedTo` EventDetail, required
        - `id` string, required
        - `title` string, required
        - `start` string, date-time, required
        - `end` string, date-time, required
        - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
        - `location` LocationSummary
          - `id` string, required
          - `isVirtual` boolean, required
          - `name` string, required
          - `addressLineOne` string, nullable
          - `addressLineTwo` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `zipCode` string, nullable
          - `country` string, nullable
          - `createdDate` string, date-time, nullable
          - `spakinectLocationId` string, nullable
        - `attendees` AttendeeDetailOutput[]
          - `user` UserTiny, required
            - `id` string, required — The unique identifier for the user.
            - `firstName` string, nullable — The user's first name.
            - `lastName` string, nullable — The user's last name.
            - `phoneNumber` string, nullable — The user's phone number.
            - `email` string, nullable — The user's email address.
            - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
            - `locationId` string, nullable — The location of the user.
          - `inviteStatus` 'PENDING' | 'ACCEPTED' | 'REJECTED', required
        - `status` 'PENDING' | 'RESERVED' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED' | 'OVERRIDABLE' | 'NO_SHOW', required
        - `recurringEventId` string, nullable
        - `recurringEvent` RecurringEventDetail
          - `id` string, required
          - `rrule` string, required
          - `startDate` string, date-time, required
          - `durationMinutes` integer, required
          - `timezone` string, required
          - `serviceIds` string[], nullable
          - `capacity` integer, nullable
          - `type` 'APPOINTMENT' | 'SHIFT' | 'BLOCK', required
          - `title` string, required
          - `attendeeIds` string[], nullable
          - `locationId` string, nullable
          - `organizerId` string, required
        - `eventServices` EventServiceDetail[]
          - `service` ServiceDetail, required
            - `id` string, required
            - `duration` integer, required
            - `name` string, required
            - `locationIds` string[], nullable
            - `color` string, required
            - `description` string, nullable
            - `price` integer, nullable
            - `displayPrice` integer, nullable
            - `costOfService` integer
            - `estimated` boolean, nullable
            - `bookingFee` integer, required
            - `bookingFeeText` string, nullable
            - `reminderDaysBefore` integer, nullable
            - `cancellationCost` integer, nullable
            - `hoursBeforeCancellingCosts` integer, nullable
            - `bookingFeePercentage` integer, nullable
            - `cancellationFeePctWithin24h` integer, nullable
            - `cancellationFeePctWithin48h` integer, nullable
            - `refundBookingFeeBefore48h` boolean, nullable
            - `hoursBeforeBookingFeeRefundable` integer, nullable
            - `followUpDaysAfter` integer, nullable
            - `followUpSmsTemplate` string, nullable
            - `providerIds` string[], nullable
            - `forms` FormTiny[], nullable
              - …
            - `createdDate` string, date-time, nullable
            - `updatedDate` string, date-time, nullable
            - `confirmationSmsTemplate` string, nullable
            - `cancellationSmsTemplate` string, nullable
            - `noShowSmsTemplate` string, nullable
            - `overrideNoticeSmsTemplate` string, nullable
            - `reminderSmsTemplate` string, nullable
            - `selfSchedulingBufferTime` integer, nullable
            - `visibility` 'ALL' | 'NEW' | 'EXISTING' | 'NO'
            - `minutesBeforeRebookingAllowed` integer, nullable
            - `allowIndividualProviderBooking` boolean, nullable
            - `displayOrder` integer, nullable
            - `reservedTimeMinutes` integer, nullable
            - `category` string, nullable
            - `isDoubleBookable` boolean, nullable
            - `isPopular` boolean, nullable
            - `creditCardRequired` boolean, nullable
            - `collectCreditCard` boolean, nullable
            - `autoGfeTreatments` string[], nullable
            - `brandName` string, nullable
            - `unit` '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'
            - `internalNotes` string, nullable
            - `sortOrder` integer, nullable
            - `taxable` boolean, nullable
            - `allowCustomPricing` boolean, nullable
          - `providerId` string, nullable
          - `bookables` EventServiceBookable[], nullable
            - `eventId` string, required
            - `serviceId` string, required
            - `bookableId` string, required
            - `start` string, date-time, required
            - `end` string, date-time, required
          - `start` string, date-time, nullable
          - `end` string, date-time, nullable
          - `externalId` string, nullable
          - `isArchived` boolean, nullable
        - `icons` EventIcon[]
        - `capacity` integer, nullable
        - `organizer` UserTiny, required
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `meetingLink` string, nullable
        - `locationId` string, nullable
        - `formCompleted` boolean, nullable
        - `reminders` string[]
        - `recurrenceModificationMode` 'this' | 'future' | 'all' — Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected
        - `createdDate` string, date-time, nullable
        - `quickNotes` QuickNoteSummary[], nullable
          - `id` string, required
          - `patientId` string, required
          - `note` string, required
          - `creator` UserTiny, required
            - `id` string, required — The unique identifier for the user.
            - `firstName` string, nullable — The user's first name.
            - `lastName` string, nullable — The user's last name.
            - `phoneNumber` string, nullable — The user's phone number.
            - `email` string, nullable — The user's email address.
            - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
            - `locationId` string, nullable — The location of the user.
          - `eventId` string, nullable
          - `createdDate` string, date-time, required
          - `updatedDate` string, date-time, nullable
          - `isArchived` boolean
      - `patient` UserTiny, required
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `provider` UserTiny, required
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `staffDiff` StaffDiff
        - `added` UserTiny[]
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `removed` UserTiny[]
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
        - `unchanged` UserTiny[]
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
      - `serviceDiffs` ServiceDiff[]
        - `serviceId` string, required
        - `serviceTitle` string, nullable
        - `from` ServiceEndpoint
          - `start` string, date-time, nullable
          - `end` string, date-time, nullable
          - `providerId` string, nullable
        - `to` ServiceEndpoint
          - `start` string, date-time, nullable
          - `end` string, date-time, nullable
          - `providerId` string, nullable
        - `changeTypes` string[]
      - `timeDiff` TimeDiff
        - `fromStart` string, date-time, nullable
        - `toStart` string, date-time, nullable
      - `locationDiff` LocationDiff
        - `fromLocation` LocationTiny
          - `id` string, required
          - `isVirtual` boolean, required
        - `toLocation` LocationTiny
          - `id` string, required
          - `isVirtual` boolean, required
      - `changedFields` string[]
    - AnsweredFormTiny
      - `id` string, required
      - `name` string, required
      - `patient` UserTiny, required
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
      - `submissionDate` string, date-time, required
    - PlannedPaymentSummary
      - `paymentPlanId` string, required
      - `amount` number, required
      - `paymentDate` string, date, required
      - `id` string, required
      - `status` 'SCHEDULED' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required
    - PayinEvent — A payin event from Rainforest
      - `merchantId` string, required
      - `payinConfigId` string, required
      - `payinId` string, required
      - `paymentMethodId` string, nullable
      - `amount` integer, required
      - `billingType` string, required
      - `createdAt` string, date-time, required
      - `card` RainforestCard — The card used to pay for the payin
        - `brand` string, required
        - `last4` string, required
        - `expMonth` integer, required
        - `expYear` integer, required
      - `ach` RainforestACH — The ACH used to pay for the payin
        - `accountHolderType` string, required
        - `accountNumberLast4` string, required
        - `bankName` string, required
        - `routingNumber` string, required
      - `metadata` union, required
        - PaymentPlanPayinMetadata — The metadata sent to Rainforest when a payment plan is created
          - `charges` union
            - ChargeDetailOutput[]
              - …
            - ChargeTiny[]
              - …
          - `paymentMedium` 'POS' | 'VIRTUAL_TERMINAL' | 'PAYMENT_LINK' | 'PAYMENT_PLAN' | 'SUBSCRIPTION' | 'SAVED_PAYMENT_METHOD' | 'MEMBERSHIP' | 'CASH' | 'CHECK' | 'CARE_CREDIT' | 'PATIENT_CREDIT' — Payment medium types supported by the system. These fall into two categories: 1. Payment Processor Mediums: Require Rainforest/Stripe payin (card processing) 2. External Settlement Mediums: Settled outside the system (cash, check, etc.)
          - `paymentAmount` integer, nullable
          - `savePaymentMethod` boolean, nullable
          - `patientId` string, nullable
          - `transactionId` string, nullable
          - `locationId` string, nullable
          - `creatorId` string, nullable
          - `eventId` string, nullable
          - `isSurcharged` boolean, nullable
          - `membershipId` string, nullable
          - `membershipStartDate` string, date-time, nullable
          - `soldByProviderId` string, nullable
          - `paymentPlan` PaymentPlanCreateWithoutID, required — Represents the creation of a payment plan without an ID. This model defines the structure for creating a new payment plan, including details about the initial payment, associated charge, frequency of payments, number of installments, and the amount for each installment.
            - `initialAmount` integer, required — The initial payment amount for the payment plan
            - `chargeIds` string[], required — The IDs of the associated charges
            - `frequency` 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY', required
            - `installments` integer, required — The number of installment payments
            - `installmentAmount` integer, required — The amount of each installment payment
            - `locationId` string, nullable — The ID of the associated location
            - `startDate` string, date, nullable — Optional start date for the first payment (only allowed for $0 down payment plans)
        - PayinMetadata — The metadata sent to Rainforest when a payin is created
          - `charges` union
            - ChargeDetailOutput[]
              - …
            - ChargeTiny[]
              - …
          - `paymentMedium` 'POS' | 'VIRTUAL_TERMINAL' | 'PAYMENT_LINK' | 'PAYMENT_PLAN' | 'SUBSCRIPTION' | 'SAVED_PAYMENT_METHOD' | 'MEMBERSHIP' | 'CASH' | 'CHECK' | 'CARE_CREDIT' | 'PATIENT_CREDIT' — Payment medium types supported by the system. These fall into two categories: 1. Payment Processor Mediums: Require Rainforest/Stripe payin (card processing) 2. External Settlement Mediums: Settled outside the system (cash, check, etc.)
          - `paymentAmount` integer, nullable
          - `savePaymentMethod` boolean, nullable
          - `patientId` string, nullable
          - `transactionId` string, nullable
          - `locationId` string, nullable
          - `creatorId` string, nullable
          - `eventId` string, nullable
          - `isSurcharged` boolean, nullable
          - `membershipId` string, nullable
          - `membershipStartDate` string, date-time, nullable
          - `soldByProviderId` string, nullable
        - InsurancePaymentCreate
          - `id` string, required — Unique identifier for the insurance payment.
          - `insurer` string, required — Name of the insurer.
          - `comment` string, nullable — Optional comment about the payment.
          - `amount` integer, required — Amount of the payment.
          - `currency` string — Currency of the payment.
          - `locationId` string, nullable — Location of the payment.
          - `creatorId` string, nullable — ID of the provider who created this payment.
      - `merchantFees` MerchantFees, required — The fees for the merchant
        - `totalAmount` TotalAmount, required — Rainforest currency format
          - `amount` integer, required
          - `currencyCode` string, required
      - `deviceData` object, nullable
      - `refusalDesc` string, nullable
    - ChatUpdate — Represents changes to a chat with before/after snapshots
      - `id` string, required
      - `updatedFrom` ChatSnapshot, required — Represents a snapshot of chat state for change tracking
        - `id` string, required
        - `primaryPatientId` string, nullable
        - `status` 'READ' | 'UNREAD'
        - `patients` ChatPatient[], nullable
          - `id` string, required
          - `firstName` string, nullable, required
          - `lastName` string, nullable, required
          - `primaryLocationId` string, nullable, required
        - `phoneNumber` string, nullable
        - `latestMessageContent` string, nullable
        - `latestMessageDate` string, date-time, nullable
        - `createdDate` string, date-time, nullable
        - `optedOutOfSms` boolean, nullable
      - `updatedTo` ChatSnapshot, required — Represents a snapshot of chat state for change tracking
        - `id` string, required
        - `primaryPatientId` string, nullable
        - `status` 'READ' | 'UNREAD'
        - `patients` ChatPatient[], nullable
          - `id` string, required
          - `firstName` string, nullable, required
          - `lastName` string, nullable, required
          - `primaryLocationId` string, nullable, required
        - `phoneNumber` string, nullable
        - `latestMessageContent` string, nullable
        - `latestMessageDate` string, date-time, nullable
        - `createdDate` string, date-time, nullable
        - `optedOutOfSms` boolean, nullable
    - InventoryLog
      - `id` string — Unique identifier for the inventory log
      - `itemId` string, nullable — ID of the item
      - `stockId` string, required — ID of the stock
      - `quantity` number, nullable — Quantity of the stock
      - `chargeId` string, nullable — ID of the charge
      - `action` 'STOCK_CREATED' | 'STOCK_UPDATED' | 'STOCK_ARCHIVED' | 'DRAWDOWN' | 'RESTORED' | 'SHIPMENT_RECEIVED' | 'SHIPMENT_UPDATED' | 'SHIPMENT_ARCHIVED' | 'ITEM_LINKED' | 'ITEM_UNLINKED', required
      - `createdDate` string, date-time, nullable — Date and time the log was created
      - `creatorId` string, required — ID of the creator
      - `shipmentId` string, nullable — ID of the shipment
      - `note` string, nullable — Optional note about the inventory action
      - `stock` StockTiny
        - `id` string — Unique identifier for the stock
        - `name` string, required — Name of the stock
        - `description` string, nullable — Optional description of the stock
        - `notes` string, nullable — Notes about the stock
        - `category` string, nullable — Category name (references category.name)
        - `unit` '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', required
        - `isArchived` boolean — Whether the stock is archived
      - `item` Item
        - `id` string — Unique identifier for the item
        - `name` string, required — Name of the item
        - `brandName` string, nullable — Optional brand name of the item
        - `description` string, nullable — Optional description of the item
        - `price` integer, required — Price of the item in cents
        - `category` string, nullable — Category name (references category.name)
        - `unit` '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'
        - `isPhysical` boolean — Whether the item is physical
        - `isArchived` boolean — Whether the item is archived
        - `internalNotes` string, nullable — Optional internal notes for the item
        - `taxable` boolean — Whether the item is subject to taxes
        - `sortOrder` integer, nullable — Optional sort order for the item
        - `allowCustomPricing` boolean — Whether custom pricing is allowed for this item
        - `type` 'ITEM' | 'PRODUCT' | 'MEDICATION' | 'SERVICE' | 'PACKAGE' | 'MEMBERSHIP'
        - `stocks` ItemStock[], nullable — Optional linked stocks for the item
          - `itemId` string, required — ID of the item
          - `stockId` string, required — ID of the stock
          - `quantityUsed` number, required — Quantity of the item
      - `charge` ChargeSummaryOutput
        - `id` string, nullable — A unique identifier for the charge. Auto-generated if not provided.
        - `patientId` string, required — Identifier of the patient being charged.
        - `patient` PatientSummary
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
          - `externalId` string, nullable — The user's external identifier if available.
          - `address` string, nullable — The user's primary address.
          - `addressLineTwo` string, nullable — Additional address information.
          - `city` string, nullable — The city of the user's address.
          - `state` string, nullable — The state of the user's address.
          - `zipCode` string, nullable — The postal code of the user's address.
          - `country` string, nullable — The country of the user's address.
          - `createdDate` string, date-time, required — The date and time when the user was created.
          - `addressValid` boolean, nullable — Whether the user's address is valid.
          - `meta` object, nullable — Any additional metadata about the user relevant to your system.
          - `isArchived` boolean, nullable — Whether the user is archived.
          - `primaryLocationId` string, nullable — The primary location of the user.
          - `gender` string, nullable — The gender of the patient.
          - `dateOfBirth` string, date, nullable — The date of birth of the patient.
          - `patientMedications` string[], nullable — List of patient's self-reported medications.
          - `onSchedulingBlacklist` boolean, nullable — Whether the patient is on the scheduling blacklist.
          - `surchargeDisabled` boolean, nullable — Whether surcharges are disabled for this patient.
          - `tags` PatientTagSummary[], nullable — List of patient tags
            - `id` string, required — Unique identifier for the patient tag
            - `name` string, required — Name of the patient tag
            - `emoji` string, nullable — Emoji associated with the tag
            - `color` string, nullable — Color code for the tag (hex format)
            - `isActive` boolean, required — Whether the tag is active
            - `createdDate` string, date-time, required — Date and time when the tag was created
            - `updatedDate` string, date-time, nullable — Date and time when the tag was last updated
          - `creditBalance` integer, nullable — Patient's credit balance in cents.
          - `preferredProviderId` string, nullable — The preferred provider ID for this patient.
        - `total` integer — Total amount of the charge.
        - `totalOutstanding` integer, required — Total outstanding amount that is yet to be paid.
        - `description` string, nullable — Description of the charge.
        - `status` 'OUTSTANDING' | 'PAID' | 'EXTERNAL_SETTLEMENT' | 'VOID' | 'WRITE_OFF' | 'REFUNDED' | 'CHARGEBACK' | 'PAYMENT_PLAN' | 'COLLECTIONS'
        - `discountAmount` integer, nullable — Any discount applied to the total outstanding.
        - `discountPercentage` number, nullable — Percentage of discount applied to the charge.
        - `externalId` string, nullable — External identifier for the charge, if applicable.
        - `externalCreatedDate` string, date-time, nullable — The creation date of the charge in your external system, if applicable.
        - `ruleSetId` string, nullable — Identifier for the `RuleSet` applied to this `Charge`, if any.
        - `createdDate` string, date-time, nullable — The date when the charge was created.
        - `creatorId` string, nullable — Identifier of the `Provider` who created the charge (i.e. the Clinician, or relevant Biller).
        - `items` ChargeItem[] — List of `Items` in the `Charge`.
          - `id` string, nullable — Unique identifier for the charge item
          - `itemId` string, nullable — Optional unique identifier for the item
          - `chargeId` string, required — Identifier of the charge this item is associated with
          - `name` string, nullable — Name of the item (None for items with associated inventory item)
          - `description` string, nullable — Description of the item
          - `quantity` integer, required — Quantity of the item being charged
          - `discountAmount` integer, nullable — Discount amount for the item
          - `discountPercentage` number, nullable — Discount percentage for the item
          - `discountReason` string, nullable — Reason for discount
          - `price` integer, required — Price of the item in cents
          - `soldPackageId` string, nullable — Unique identifier for the sold package usage
          - `bankedQuantity` integer, nullable — Quantity to bank for later use
          - `bankedItemId` string, nullable — ID of banked item being used (for tracking usage)
          - `issuedDiscountId` string, nullable — Unique identifier for the specific issued discount instance used
          - `soldByProviderId` string, nullable — Unique identifier for the provider who sold the item
          - `taxAmount` integer, nullable — Tax amount for the item in cents
          - `pricingId` string, nullable — Unique identifier for the pricing for the item
          - `shipmentIds` string[], nullable — Optional list of shipment IDs to reduce the stock quantity of
        - `tips` TipDetail[] — List of `Tips` in the `Charge`.
          - `chargeId` string, required — Charge ID this tip belongs to
          - `amount` integer, required — Tip amount in cents
          - `providerId` string, required — Provider ID receiving the tip
          - `id` string — Unique identifier for the tip
          - `provider` ProviderTiny
            - `id` string, required
            - `firstName` string, required
            - `lastName` string, nullable
            - `email` string, nullable
            - `createdDate` string, date-time, nullable
        - `locationId` string, nullable — Identifier of the `Location` where the charge was created.
        - `eventId` string, nullable — Identifier of the `Event` this charge is associated with, if any.
        - `memberId` string, nullable — Identifier of the `Member` this charge is associated with, if any.
        - `comment` string, nullable — Any additional comments about the charge.
        - `meta` object, nullable — Any additional metadata about the charge relevant to your system.
        - `merchantAccountId` string, nullable — Identifier of the `MerchantAccount` this charge is associated with.
      - `shipment` ShipmentOutput
        - `id` string — Unique identifier for the shipment
        - `stockId` string, required — ID of the stock
        - `supplierId` string, required — ID of the supplier
        - `locationId` string, required — ID of the location where the shipment was delivered
        - `lotNumber` string, nullable — Optional lot number of the shipment
        - `expiryDate` string, date-time, nullable — Optional expiry date of the shipment
        - `sku` string, nullable — Optional SKU (Stock Keeping Unit)
        - `quantity` number, required — Total quantity
        - `remainingQuantity` number, required — Remaining quantity
        - `cost` integer, nullable — Cost of the shipment in cents
        - `supplier` Supplier
          - `id` string — Unique identifier for the supplier
          - `name` string, required — Name of the supplier
          - `description` string, nullable — Optional description of the supplier
          - `website` string, nullable — Optional website of the supplier
          - `email` string, nullable — Optional email of the supplier
          - `preferredContactMethod` string, nullable — Optional preferred contact method
          - `phoneNumber` string, nullable — Optional phone number of the supplier
          - `addressLineOne` string, nullable — Optional first line of address
          - `addressLineTwo` string, nullable — Optional second line of address
          - `city` string, nullable — Optional city
          - `state` string, nullable — Optional state or province
          - `zipCode` string, nullable — Optional ZIP or postal code
          - `country` string, nullable — Optional country
          - `isArchived` boolean — Whether the supplier is archived
        - `createdDate` string, date-time, nullable — Date and time the shipment was created
        - `note` string, nullable — Optional note for inventory log when updating shipment
        - `locationName` string, nullable, required — Get the location name from the related location object
      - `creator` UserTiny
        - `id` string, required — The unique identifier for the user.
        - `firstName` string, nullable — The user's first name.
        - `lastName` string, nullable — The user's last name.
        - `phoneNumber` string, nullable — The user's phone number.
        - `email` string, nullable — The user's email address.
        - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
        - `locationId` string, nullable — The location of the user.
    - ChargePaymentUpdate
      - `paymentId` string, required
      - `chargeId` string, required
      - `amount` integer, required
      - `payinConfigId` string, nullable
      - `paymentMedium` string, required
      - `createdDate` string, date-time, nullable
      - `payment` PaymentOutput, required
        - `id` string, required — The unique identifier for the payment.
        - `patientId` string, nullable — The ID of the patient associated with the payment.
        - `payinId` string, nullable — The ID of the payin associated with the payment.
        - `amount` integer, required — The total amount of the payment.
        - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required
        - `currency` string — The currency in which the payment was made.
        - `payinConfigId` string, nullable — The configuration ID for the payin.
        - `paymentMedium` string, required — The name of the payment medium.
        - `paymentMethodId` string, nullable — The ID of the payment method used.
        - `stripePaymentIntentId` string, nullable — Stripe's payment intent ID if used.
        - `failedReason` string, nullable — Reason for payment failure if applicable.
        - `updatedDate` string, date-time, nullable — The date and time the payment was last updated.
        - `createdDate` string, date-time, required — The date and time the payment was created.
        - `fee` integer — The fee charged by the payment processor.
        - `feeToPatient` integer, required — The fee charged to the patient for the transaction.
        - `paymentMethod` PaymentMethodSummary
          - `id` string, required
          - `patientId` string, nullable, required
          - `rainforestPaymentMethodId` string, required
          - `brand` string, nullable, required
          - `last4` string, nullable, required
          - `expMonth` integer, nullable, required
          - `expYear` integer, nullable, required
          - `accountHolderType` string, nullable, required
          - `accountNumberLast4` integer, nullable, required
          - `bankName` string, nullable, required
          - `routingNumber` integer, nullable, required
          - `description` string, nullable, required
          - `type` 'CARD' | 'ACH' | 'APPLE_PAY', required
          - `isDefault` boolean
          - `isArchived` boolean
        - `refunds` RefundSummary[] — List of refunds associated with the payment.
          - `id` string, required
          - `paymentId` string, required
          - `amount` integer, required
          - `reason` 'DUPLICATE' | 'DISPUTE' | 'BOOKING_FEE' | 'OTHER', required
          - `createdDate` string, date-time, required
          - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required
          - `rainforestRefundId` string, nullable
          - `fee` integer
    - AppointmentChecklistUpdatedData
      - `appointmentChecklistItem` AppointmentChecklistItem, required
        - `id` string, required
        - `eventId` string, required
        - `serviceId` string, nullable
        - `name` string, required
        - `type` 'FILLED_FORM' | 'CHECKED_IN' | 'WITH_MA' | 'MEASUREMENT_TAKEN' | 'DOSE_TAKEN' | 'WITH_PROVIDER' | 'NOTE_TAKEN' | 'PAYMENT_MADE' | 'REQUEST_GFE'
        - `optional` boolean, required
        - `position` integer, required
        - `completedDate` string, date-time, nullable
        - `completedByUser` UserTiny
          - `id` string, required — The unique identifier for the user.
          - `firstName` string, nullable — The user's first name.
          - `lastName` string, nullable — The user's last name.
          - `phoneNumber` string, nullable — The user's phone number.
          - `email` string, nullable — The user's email address.
          - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
          - `locationId` string, nullable — The location of the user.
      - `eventId` string, required
      - `completedByProviderId` string, required
    - DepositEvent — Deposit event from Rainforest webhooks
      - `merchantId` string, nullable
      - `depositId` string, required
      - `platformId` string, nullable
      - `status` string, required
      - `amount` integer, required
      - `currencyCode` string
      - `billingType` string, nullable
      - `depositFeeAmount` object, nullable
      - `depositType` string, nullable
      - `methodType` string, nullable
      - `ach` object, nullable
      - `plaidAch` object, nullable
      - `metadata` object, nullable
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, nullable
  - `actionRequired` boolean
  - `createdDate` string, date-time, required
  - `resolvedDate` string, date-time, nullable
  - `tags` TagTiny[]
    - `id` string, required
    - `name` string, required
  - `assignedProvider` ProviderTiny
    - `id` string, required
    - `firstName` string, required
    - `lastName` string, nullable
    - `email` string, nullable
    - `createdDate` string, date-time, nullable
  - `resolvingProvider` ProviderTiny
    - `id` string, required
    - `firstName` string, required
    - `lastName` string, nullable
    - `email` string, nullable
    - `createdDate` string, date-time, nullable
  - `patient` UserTiny
    - `id` string, required — The unique identifier for the user.
    - `firstName` string, nullable — The user's first name.
    - `lastName` string, nullable — The user's last name.
    - `phoneNumber` string, nullable — The user's phone number.
    - `email` string, nullable — The user's email address.
    - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
    - `locationId` string, nullable — The location of the user.
  - `callId` string, nullable
  - `messageId` string, nullable
  - `emailId` string, nullable
  - `mailId` string, nullable
  - `eventId` string, nullable
  - `formId` string, nullable
  - `invoiceId` string, nullable
  - `paymentId` string, nullable
  - `paymentMethodId` string, nullable
  - `chargeId` string, nullable
  - `adjustmentId` string, nullable
  - `refundId` string, nullable
  - `depositId` string, nullable
  - `occurances` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) · [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/decodahealth/decoda-api/revisions/4939a65a89d2/schema)