@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/types/patientTypes.ts

@@ -1,236 +0,0 @@
-/**
- * Parameters for fetching multiple patients.
- * @see https://www.opendental.com/site/apipatients.html
- */
-export interface GetPatientsParams {
-    LName?: string; //Supports partial string matching and is case-insensitive.
-    FName?: string; //Supports partial string matching and is case-insensitive.
-    Phone?: string; // phone number
-    Address?: string; // Primary address
-    hideInactive?: 'true' | 'false'; 
-    City?: string; // City
-    State?: string; // State
-    SSN?: string; // Social Security Number
-    ChartNumber?: string; // Chart number
-    guarOnly?: 'true' | 'false'; 
-    showArchived?: 'true' | 'false'; 
-    Birthdate?: string; //In "yyyy-mm-dd" format.
-    SiteNum?: number; 
-    SubscriberId?: string; 
-    Email?: string; // Email address
-    Country?: string; 
-    ClinicNum?: number; //comma separated list
-    clinicAbbr?: string; // Clinic abbreviation
-    invoiceNumber?: string; 
-    Offset?: number; // Pagination offset
-  }
-
-/**
- * Parameters for fetching comprehensive patient data.
- * @see https://www.opendental.com/site/apipatients.html
- */
-export interface GetPatientsSimpleParams extends GetPatientsParams {
-    LName?: string; //Supports partial string matching and is case-insensitive.
-    FName?: string; //Supports partial string matching and is case-insensitive.
-    Birthdate?: string; //In "yyyy-mm-dd" format.
-    ClinicNum?: number; //A single ClinicNum. Leave blank if not using clinics or want results for all clinics.
-    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
-    DateTStamp?: string; //In "yyyy-mm-dd HH:mm:ss" format.
-    PriProv?: number; // Primary provider ID
-    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
-    Guarantor?: number; // Guarantor's PatNum
-    SuperFamily?: number; // Super family number
-    EmployerNum?: number; // (Added in version 24.3.30) FK to employer.EmployerNum.
-    FeeSched?: number; // (Added in version 25.2.19) FK to feesched.FeeSchedNum.
-    HmPhone?: string; // (Added in version 25.4.29) Patient's home phone number.
-    WkPhone?: string; // (Added in version 25.4.29) Patient's work phone number.
-    WirelessPhone?: string; // (Added in version 25.4.29) Patient's wireless phone number.
-    Offset?: number; // Pagination offset
-  }
-
-/**
- * Parameters for creating a new patient.
- * Required fields depend on Open Dental's configuration.
- * @see https://www.opendental.com/site/apipatients.html
- */
-export interface CreatePatientParams {
-    LName: string; // Last name
-    FName: string; // First name
-    MiddleI?: string; // Middle initial
-    Preferred?: string; // Preferred name
-    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status, Default is Patient.
-    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
-    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
-    SSN?: string; // In the USA, 9 digits, no dashes. Any punctuation or format for other countries.
-    Address?: string; // Primary address
-    Address2?: string; // Secondary address
-    City?: string; // City
-    State?: string; // State
-    Zip?: string; // Postal code. Must be in format 12345, 12345-1234, or 123456789 (US) or A0A 0A0 (Canada, added in version 23.2.5).
-    HmPhone?: string; // Home phone number including any punctuation.
-    WkPhone?: string; // Work phone number including any punctuation.
-    WirelessPhone?: string; // Mobile phone number including any punctuation.
-    Guarantor?: number; // Head of household's PatNum. Only this or SuperFamily in a single request. Default is patient's PatNum.
-    Email?: string; // Email address
-    PriProv?: number; // Primary provider number
-    SecProv?: number; // Secondary provider number
-    BillingType?: string; // Billing type description
-    FamFinUrgNote?: string; // Family financial urgent note
-    MedUrgNote?: string; // (Added in version 25.4.29) Urgent medical note for patient. Default empty string.
-    ApptModNote?: string; // (Added in version 25.4.29) Appointment module note for patient. Default empty string.
-    ChartNumber?: string; // Chart number
-    MedicaidID?: string; // The Medicaid ID for this patient.
-    EmployerNum?: number; // FK to employer.EmployerNum. Default 0.
-    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
-    ClinicNum?: number; // Clinic number
-    Premed?: 'true' | 'false'; // Set to true if patient needs to be premedicated for appointment. Default is false.
-    Ward?: string; // Ward, hospital feature must be enabled
-    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
-    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
-    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
-    Language?: string; // Language code (ISO 639-2 format)
-    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format, hospital feature must be enabled
-    SuperFamily?: number; // Head of SuperFamily's PatNum. Default is 0. Only this or Guarantor in a single request. Creates a new SuperFamily if one does not exist. Does not honor any Super Family preferences.
-    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
-  }
-
-  export interface UpdatePatientParams {
-    LName?: string; // Last name
-    FName?: string; // First name
-    MiddleI?: string; // Middle initial
-    Preferred?: string; // Preferred name
-    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status, Default is Patient.
-    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
-    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
-    SSN?: string; // In the USA, 9 digits, no dashes. Any punctuation or format for other countries.
-    Address?: string; // Primary address
-    Address2?: string; // Secondary address
-    City?: string; // City
-    State?: string; // State
-    Zip?: string; // Postal code. Must be in format 12345, 12345-1234, or 123456789 (US) or A0A 0A0 (Canada, added in version 23.2.5).
-    HmPhone?: string; // Home phone number including any punctuation.
-    WkPhone?: string; // Work phone number including any punctuation.
-    WirelessPhone?: string; // Mobile phone number including any punctuation.
-    Guarantor?: number; // Head of household's PatNum. Only this or SuperFamily in a single request. Default is patient's PatNum.
-    Email?: string; // Email address
-    PriProv?: number; // Primary provider number
-    SecProv?: number; // Secondary provider number
-    BillingType?: string; // Billing type description
-    FamFinUrgNote?: string; // Family financial urgent note
-    MedUrgNote?: string; // (Added in version 25.4.29) Urgent medical note for patient. Default empty string.
-    ApptModNote?: string; // (Added in version 25.4.29) Appointment module note for patient. Default empty string.
-    ChartNumber?: string; // Chart number
-    MedicaidID?: string; // The Medicaid ID for this patient.
-    EmployerNum?: number; // FK to employer.EmployerNum. Default 0.
-    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
-    ClinicNum?: number; // Clinic number
-    Premed?: 'true' | 'false'; // Set to true if patient needs to be premedicated for appointment. Default is false.
-    Ward?: string; // Ward, hospital feature must be enabled
-    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
-    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
-    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
-    Language?: string; // Language code (ISO 639-2 format)
-    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format, hospital feature must be enabled
-    SuperFamily?: number; // Head of SuperFamily's PatNum. Default is 0. Only this or Guarantor in a single request. Creates a new SuperFamily if one does not exist. Does not honor any Super Family preferences.
-    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
-  }
-
-/**
- * Represents a patient in the Open Dental system.
- * @see https://www.opendental.com/site/apipatients.html
- */
-export interface Patient {
-    serverDateTime?: string; // Server datetime of API return
-    PatNum?: number; // Unique patient identifier
-    LName?: string; // Last name
-    FName?: string; // First name
-    MiddleI?: string; // Middle initial
-    Preferred?: string; // Preferred name
-    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
-    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
-    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
-    SSN?: string; // Social Security Number
-    Address?: string; // Primary address
-    Address2?: string; // Secondary address
-    City?: string; // City
-    State?: string; // State
-    Zip?: string; // ZIP code
-    HmPhone?: string; // Home phone number
-    WkPhone?: string; // Work phone number
-    WirelessPhone?: string; // Mobile phone number
-    Guarantor?: number; // Guarantor's PatNum
-    Email?: string; // Email address
-    EstBalance?: number; // Estimated balance
-    PriProv?: number; // Primary provider number
-    priProvAbbr?: string; // Primary provider abbreviation
-    SecProv?: number; // Secondary provider number
-    secProvAbbr?: string; // Secondary provider abbreviation
-    BillingType?: string; // Billing type description
-    ImageFolder?: string; // Image folder name
-    FamFinUrgNote?: string; // Family financial urgent note
-    MedUrgNote?: string; // 
-    ApptModNote?: string; //
-    ChartNumber?: string; // Chart number
-    MedicaidID?: string; // Medicaid ID
-    Bal_0_30?: number; // 
-    Bal_31_60?: number; // 
-    Bal_61_90?: number; // 
-    BalOver90?: number; // 
-    InsEst?: number; // 
-    BalTotal?: number; // Total balance
-    dateTimeLastAging?: string; // 
-    EmployerNum?: number; // 
-    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
-    ClinicNum?: number; // Clinic number
-    clinicAbbr?: string; // Clinic abbreviation
-    Premed?: 'true' | 'false'; // 
-    Ward?: string; // Ward
-    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
-    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
-    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
-    Language?: string; // Language code (ISO 639-2 format)
-    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format
-    SiteNum?: number; // Site number
-    siteDesc?: string; // Site description
-    DateTStamp?: string; // Timestamp of the last update in 'yyyy-MM-dd HH:mm:ss' format
-    SuperFamily?: number; // Super family number
-    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
-    SecUserNumEntry?: number; // employee num
-    SecDateEntry?: string; // Secondary date entry in 'yyyy-MM-dd' format
-  }  
-
-  /**
-   * Simplified representation of a patient in the Open Dental system.
-   * @see https://www.opendental.com/site/apipatients.html
-   */
-  export interface PatientSummary {
-    PatNum?: number; // Unique patient identifier
-    LName?: string; // Last name
-    FName?: string; // First name
-    MiddleI?: string; // Middle initial
-    Preferred?: string; // Preferred name
-    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
-    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
-    SSN?: string; // Social Security Number
-    Address?: string; // Primary address
-    Address2?: string; // Secondary address
-    City?: string; // City
-    State?: string; // State
-    Zip?: string; // ZIP code
-    HmPhone?: string; // Home phone number
-    WkPhone?: string; // Work phone number
-    WirelessPhone?: string; // Mobile phone number
-    Email?: string; // Email address
-    priProvAbbr?: string; // Primary provider abbreviation
-    secProvAbbr?: string; // Secondary provider abbreviation
-    BillingType?: string; // Billing type description
-    ChartNumber?: string; // Chart number
-    ClinicNum?: number; // Clinic number
-    clinicAbbr?: string; // Clinic abbreviation
-    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
-  }

package/src/types/payPlanChargeTypes.ts

@@ -1,77 +0,0 @@
-/**
- * PayPlanCharge types for Open Dental REST API
- * Spec refs:
- *  - https://www.opendental.com/site/apipayplancharges.html
- *
- * Notes:
- *  - Dates are strings from the API (yyyy-MM-dd or yyyy-MM-dd HH:mm:ss).
- *  - PayPlanCharges represent individual charges within a payment plan
- *  - Each charge can be a debit (payment due) or credit (payment received)
- * @see https://www.opendental.com/site/apipayplancharges.html
- */
-
-/** Charge type for payment plan charges */
-export type ChargeType = "Debit" | "Credit";
-
-/** Link type for payment plan charges */
-export type LinkType =
-  | "Procedure"
-  | "Adjustment"
-  | "Payment"
-  | "None"
-  | string; // Open to allow for other types
-
-/**
- * Represents a PayPlanCharge returned by the Open Dental API.
- * Mirrors the response payload of GET endpoints.
- */
-export interface PayPlanCharge {
-  PayPlanChargeNum: number;     // PK - Unique charge identifier
-  PayPlanNum: number;           // FK to payplan.PayPlanNum
-  Guarantor: number;            // FK to patient.PatNum (guarantor)
-  PatNum: number;               // FK to patient.PatNum
-  ChargeDate: string;           // "yyyy-MM-dd" - Date of charge
-  Principal: number;            // Principal amount (decimal)
-  Interest: number;             // Interest amount (decimal)
-  Note: string;                 // Optional note for the charge
-  ProvNum: number;              // FK to provider.ProvNum
-  ClinicNum: number;            // FK to clinic.ClinicNum
-  ChargeType: ChargeType;       // Type of charge ("Debit" | "Credit")
-  ProcNum: number;              // FK to procedurelog.ProcNum
-  SecDateTEntry: string;        // "yyyy-MM-dd HH:mm:ss" - Entry timestamp
-  SecDateTEdit: string;         // "yyyy-MM-dd HH:mm:ss" - Last edit timestamp
-  StatementNum: number;         // FK to statement.StatementNum
-  FKey: number;                 // Foreign key reference (context-dependent)
-  LinkType: LinkType;           // Link type (e.g., "Procedure", "Adjustment")
-  IsOffset: boolean;            // Whether this is an offset charge
-}
-
-/** GET /payplancharges query params */
-export interface GetPayPlanChargesParams {
-  /** Payment plan number - Required */
-  PayPlanNum: number;
-}
-
-/** Minimal helper to detect "zero" dates in responses */
-export const isZeroDate = (d?: string | null): boolean =>
-  !d || d === "0001-01-01";
-
-/** Narrow helper for timestamps that can be zeroed by the API */
-export const isZeroDateTime = (d?: string | null): boolean =>
-  !d || d.startsWith("0001-01-01");
-
-/** Runtime guard for ChargeType values */
-export const isChargeType = (s: string): s is ChargeType =>
-  ["Debit", "Credit"].includes(s);
-
-/** Helper to determine if a charge is a debit (payment due) */
-export const isDebitCharge = (charge: PayPlanCharge): boolean =>
-  charge.ChargeType === "Debit";
-
-/** Helper to determine if a charge is a credit (payment received) */
-export const isCreditCharge = (charge: PayPlanCharge): boolean =>
-  charge.ChargeType === "Credit";
-
-/** Helper to calculate total charge amount (principal + interest) */
-export const getTotalChargeAmount = (charge: PayPlanCharge): number =>
-  charge.Principal + charge.Interest;

package/src/types/payPlanTypes.ts

@@ -1,171 +0,0 @@
-/**
- * PayPlan types for Open Dental REST API
- * Spec refs:
- *  - https://www.opendental.com/site/apipayplans.html
- *
- * Notes:
- *  - Dates are strings from the API (yyyy-MM-dd or yyyy-MM-dd HH:mm:ss).
- *  - Prior to 23.3.1, Open Dental users had the ability to create both Patient Payment Plans and Dynamic Payment Plans.
- *  - In version 23.3.1, Open Dental deprecated Patient Payment Plans, renaming them to Old Payment Plans in the UI.
- *  - The PayPlans POST (create) method was also deprecated at that time.
- *  - Dynamic Payment Plans are now referred to simply as Payment Plans in Open Dental.
- *  - Insurance payment plans have PlanNum and InsSubNum values greater than zero
- * @see https://www.opendental.com/site/apipayplans.html
- */
-
-/** Charge frequency for payment plans */
-export type ChargeFrequency =
-  | "Weekly"
-  | "EveryOtherWeek"
-  | "Monthly"
-  | "Quarterly"
-  | "OrdinalWeekday";
-
-/** Dynamic payment plan treatment plan option */
-export type DynamicPayPlanTPOption =
-  | "AwaitComplete"
-  | "TreatAsComplete"
-  | "None";
-
-/**
- * Represents a PayPlan returned by the Open Dental API.
- * Mirrors the response payload of GET/POST/PUT endpoints.
- */
-export interface PayPlan {
-  PayPlanNum: number;           // PK
-  PatNum: number;               // FK to patient.PatNum
-  Guarantor: number;            // FK to patient.PatNum (guarantor)
-  PayPlanDate: string;          // "yyyy-MM-dd" - Date of agreement
-  APR: number;                  // Annual percentage rate (decimal)
-  Note: string;                 // Payment plan note
-  PlanNum: number;              // FK to insplan.PlanNum (0 for patient plans)
-  CompletedAmt: number;         // Amount completed
-  InsSubNum: number;            // FK to inssub.InsSubNum (0 for patient plans)
-  PaySchedule: number;          // FK to schedule (if applicable)
-  NumberOfPayments: number;     // Total number of payments
-  PayAmt: number;               // Amount per payment
-  DownPayment: number;          // Down payment amount
-  IsClosed: boolean;            // Whether plan is closed
-  Signature: string;            // Digital signature data
-  SigIsTopaz: boolean;          // Whether signature is Topaz format
-  PlanCategory: number;         // DefNum for plan category
-  IsDynamic: boolean;           // Whether this is a dynamic payment plan
-  ChargeFrequency: ChargeFrequency; // Payment frequency
-  DatePayPlanStart: string;     // "yyyy-MM-dd" - First payment due date
-  DynamicPayPlanTPOption: DynamicPayPlanTPOption; // TP option for dynamic plans
-  DateInterestStart: string;    // "yyyy-MM-dd" - When interest starts accruing
-  IsLocked: boolean;            // Lock status (required true if APR > 0)
-  SheetDefNum: number;          // FK to sheetdef.SheetDefNum (custom sheet)
-}
-
-/** GET /payplans (multiple) query params */
-export interface GetPayPlansParams {
-  /** Patient number - mutually exclusive with Guarantor */
-  PatNum?: number;
-  /** Guarantor number - mutually exclusive with PatNum */
-  Guarantor?: number;
-}
-
-/** GET /payplans/{PayPlanNum} - path parameter only */
-export interface GetPayPlanByIdParams {
-  PayPlanNum: number;
-}
-
-/**
- * POST /payplans/Dynamic body
- * Creates a dynamic payment plan
- * Required: PatNum, (PayAmt OR NumberOfPayments), (procNums OR adjNums)
- */
-export interface CreateDynamicPayPlanParams {
-  PatNum: number;                           // Required
-  PayAmt?: number;                          // Required if NumberOfPayments not provided
-  NumberOfPayments?: number;                // Required if PayAmt not provided
-  procNums?: number[];                      // Array of procedure numbers
-  adjNums?: number[];                       // Array of adjustment numbers
-  Guarantor?: number;                       // FK to patient.PatNum
-  PayPlanDate?: string;                     // "yyyy-MM-dd" - defaults to today
-  APR?: number;                             // Annual percentage rate
-  DownPayment?: number;                     // Down payment amount
-  Note?: string;                            // Payment plan note
-  PlanCategory?: number;                    // DefNum for plan category
-  ChargeFrequency?: ChargeFrequency;        // Payment frequency
-  DatePayPlanStart?: string;                // "yyyy-MM-dd" - first payment due date
-  DateInterestStart?: string;               // "yyyy-MM-dd" - when interest starts
-  IsLocked?: boolean;                       // Lock status (required true if APR > 0)
-  DynamicPayPlanTPOption?: DynamicPayPlanTPOption; // TP option
-}
-
-/**
- * POST /payplans body (DEPRECATED as of 23.3.1)
- * Use CreateDynamicPayPlanParams instead
- * Creates an old-style patient payment plan
- */
-export interface CreatePayPlanParams {
-  PatNum: number;                           // Required
-  useEstBalance?: boolean;                  // Use estimated balance
-  principalAmount?: number;                 // Principal amount
-  PayAmt?: number;                          // Required if NumberOfPayments not provided
-  NumberOfPayments?: number;                // Required if PayAmt not provided
-  Guarantor?: number;                       // FK to patient.PatNum
-  PayPlanDate?: string;                     // "yyyy-MM-dd"
-  APR?: number;                             // Annual percentage rate
-  DownPayment?: number;                     // Down payment amount
-  Note?: string;                            // Payment plan note
-  PlanCategory?: number;                    // DefNum for plan category
-  ChargeFrequency?: ChargeFrequency;        // Payment frequency
-  DatePayPlanStart?: string;                // "yyyy-MM-dd"
-  DateInterestStart?: string;               // "yyyy-MM-dd"
-}
-
-/**
- * PUT /payplans/{PayPlanNum}/Close
- * Closes a payment plan and charges outstanding interest
- */
-export interface ClosePayPlanParams {
-  PayPlanNum: number; // in URL
-}
-
-/**
- * PUT /payplans/{PayPlanNum}/Dynamic
- * Updates a dynamic payment plan
- * All fields optional except PayPlanNum
- */
-export interface UpdateDynamicPayPlanParams {
-  PayPlanNum: number;                       // Required (in URL)
-  PayAmt?: number;                          // Amount per payment
-  NumberOfPayments?: number;                // Total number of payments
-  Guarantor?: number;                       // FK to patient.PatNum
-  PayPlanDate?: string;                     // "yyyy-MM-dd"
-  APR?: number;                             // Annual percentage rate
-  Note?: string;                            // Payment plan note
-  PlanCategory?: number;                    // DefNum for plan category
-  ChargeFrequency?: ChargeFrequency;        // Payment frequency
-  DatePayPlanStart?: string;                // "yyyy-MM-dd"
-  DateInterestStart?: string;               // "yyyy-MM-dd"
-  IsLocked?: boolean;                       // Lock status
-  SheetDefNum?: number;                     // FK to sheetdef.SheetDefNum
-}
-
-/** Minimal helper to detect "zero" dates in responses */
-export const isZeroDate = (d?: string | null): boolean =>
-  !d || d === "0001-01-01";
-
-/** Narrow helper for timestamps that can be zeroed by the API */
-export const isZeroDateTime = (d?: string | null): boolean =>
-  !d || d.startsWith("0001-01-01");
-
-/** Runtime guard for ChargeFrequency values */
-export const isChargeFrequency = (s: string): s is ChargeFrequency =>
-  ["Weekly", "EveryOtherWeek", "Monthly", "Quarterly", "OrdinalWeekday"].includes(s);
-
-/** Runtime guard for DynamicPayPlanTPOption values */
-export const isDynamicPayPlanTPOption = (t: string): t is DynamicPayPlanTPOption =>
-  ["AwaitComplete", "TreatAsComplete", "None"].includes(t);
-
-/** Helper to determine if a PayPlan is an insurance payment plan */
-export const isInsurancePayPlan = (payPlan: PayPlan): boolean =>
-  payPlan.PlanNum > 0 && payPlan.InsSubNum > 0;
-
-/** Helper to determine if a PayPlan is a patient payment plan */
-export const isPatientPayPlan = (payPlan: PayPlan): boolean =>
-  payPlan.PlanNum === 0 && payPlan.InsSubNum === 0;

package/src/types/paySplitTypes.ts

@@ -1,44 +0,0 @@
-/**
- * Represents a payment split in Open Dental
- * @see https://www.opendental.com/site/apipaysplits.html
- */
-export interface PaySplit {
-    SplitNum?: number; //
-    SplitAmt?: number; //
-    PatNum?: number; //
-    PayNum?: number; //
-    ProvNum?: number; //
-    PayPlanNum?: number; //
-    DatePay?: string; //String in "yyyy-MM-dd" format. 
-    ProcNum?: number; //
-    DateEntry?: string; //String in "yyyy-MM-dd" format. 
-    UnearnedType?: number; //
-    unearnedType?: string; //
-    ClinicNum?: number; //
-    SecDateTEdit?: string; //String in "yyyy-MM-dd" format. 
-    AdjNum?: number; //
-    PayPlanChargeNum?: number; //
-    PayPlanDebitType?: string; //
-  }
-
-  /**
-   * Parameters for GET Pay Splits.
-   * @see https://www.opendental.com/site/apipaysplits.html
-   */
-  export interface GetPaySplitsParams {
-    PatNum?: number; //Optional. Get all PaySplits for a single patient.
-    PayNum?: number; //Optional. Get all PaySplits for a single payment.
-    ProcNum?: number; //Optional. Get all PaySplits attached to a specific procedure.
-    Offset?: number; // Pagination offset for results
-  }
-
-  /**
-   * Parameters for UPDATE Pay Splits.
-   * @see https://www.opendental.com/site/apipaysplits.html
-   */
-  export interface UpdatePaySplitsParams {
-    SplitNum?: number; //Required in the URL.
-    ProvNum?: number; //Optional. FK to provider.ProvNum. This field can always be updated when the AllowPrepayProvider preference is enabled. Without this preference, ProvNum can only be updated for paysplits that do not have an UnearnedType.
-    ClinicNum?: number; // FK to clinic.ClinicNum.
-  }
-  

package/src/types/paymentTypes.ts

@@ -1,69 +0,0 @@
-/**
- * Represents a payment in the Open Dental system.
- * @see https://www.opendental.com/site/apipayments.html
- */
-export interface Payment {
-    PayNum?: number; //PK
-    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
-    payType?: string; //
-    PayDate?: string; //String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
-    PayAmt?: string; //
-    CheckNum?: string; //
-    BankBranch?: string; //
-    PayNote?: string; //
-    PatNum?: number; //FK to patient.PatNum.
-    ClinicNum?: string; //
-    DateEntry?: string; //
-    DepositNum?: number; //
-    Receipt?: string; //
-    IsRecurringCC?: 'true' | 'false'; //
-    PaymentSource?: string; //
-    ProcessStatus?: string; //
-    RecurringChargeDate?: string; //
-    IsCcCompleted?: 'true' | 'false'; //
-    serverDateTime?: string; //
-  }
-
-  /**
-   * Parameters for GET Payments.
-   * @see https://www.opendental.com/site/apipayments.html
-   */
-  export interface GetPaymentsParams {
-    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
-    PatNum?: number; //FK to patient.PatNum.
-    DateEntry?: string; //String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
-    Offset?: number; // Pagination offset for results
-  }
-
-  /**
-   * Parameters for creating a payment.
-   * @see https://www.opendental.com/site/apipayments.html
-   */
-  export interface CreatePaymentParams {
-    PatNum: number; //Required. FK to patient.PatNum.
-    PayAmt: string; //String amount of payment as 0.00 (float.toString())
-    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
-    PayDate?: string; //String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
-    CheckNum?: string; //
-    PayNote?: string; //
-    BankBranch?: string; //    
-    ClinicNum?: string; //Defaults to patient.ClinicNum
-    isPatientPreferred?: 'true' | 'false'; //When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
-    isPrepayment?: 'true' | 'false'; //Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
-    procNums?: number[]; //An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
-    payPlanNum?: number; //FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
-  }
-  
-  /**
-   * Parameters for updating a payment.
-   * @see https://www.opendental.com/site/apipayments.html
-   */
-  export interface UpdatePaymentParams {
-    PayNum: number; //Required PK
-    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
-    CheckNum?: string; //
-    BankBranch?: string; //    
-    PayNote?: string; //
-    ProcessStatus?:  'OnlineProcessed' | 'OnlinePending'; //Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
-  }
-  

package/src/types/procNoteTypes.ts

@@ -1,38 +0,0 @@
-/**
- * Represents a procNote in Open Dental
- * @see https://www.opendental.com/site/apiprocnotes.html
- */
-export interface ProcNote {
-    ProcNoteNum?: number; //
-    PatNum?: number; //
-    ProcNum?: number; //
-    EntryDateTime?: string; //
-    UserNum?: number; //
-    Note?: string; //
-    SigIsTopaz?: "true" | "false"; //
-    isSigned?: "true" | "false"; //
-  }
-
-  /**
-   * Gets a list of procnotes ordered by most recent. When a procnote is edited in Open Dental, a new procnote is created. No existing procnote can EVER be edited or deleted.
-   * @see https://www.opendental.com/site/apiprocnotes.html
-   */
-  export interface GetProcNotesParams {
-    PatNum?: number; // Optional. FK to patient.PatNum.
-    ProcNum?: number; // Optional. FK to procedure.ProcNum.
-    Offset?: number; // Optional. Pagination.
-  }
-
-  /**
-   * Creates a new note that is associated with a procedure. If the Procedure Note contains 50 or more consecutive blank lines, they will be removed. The new procnote will always replace the existing procnote. Every change is recorded with an archived note history, which can be viewed in the Chart Module under Show Tab > Audit.
-   * To sign a procnote set isSigned to true. The signature that appears on the procnote will be shown as the following: "Digitally Signed by [API DeveloperName] Date Signed: ["MM/dd/yyyy HH:mm:ss tt"]". See API Implementation for more information on API Signatures.
-   * @see https://www.opendental.com/site/apiprocnotes.html
-   */
-  export interface CreateProcNoteParams {
-    PatNum: number; // Required. FK to patient.PatNum.
-    ProcNum: number; // Required. ProcNum of the procedure.
-    Note: string; // Required. The actual note.
-    isSigned?: "true" | "false"; //  (added in version 24.2.29) Optional. Either "true" or "false". If "true", will digitally sign the procnote. Default "false".
-    doAppendNote?: "true" | "false"; //  (added in version 24.2.29) Optional. Either "true" or "false". If "true", will prepend the Note field with the most recent procnote.Note value followed by two newlines. Default "false".
-  }
-