@rinse-dental/open-dental 0.1.7 → 1.0.1

package/src/api/discountPlanSubs.ts

@@ -0,0 +1,86 @@
+import HttpClient from "../utils/httpClient";
+import {
+  DiscountPlanSub,
+  GetDiscountPlanSubsParams,
+  CreateDiscountPlanSubParams,
+  UpdateDiscountPlanSubParams,
+} from "../types/discountPlanSubTypes";
+
+export default class DiscountPlanSubs {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch multiple definitinos with optional filtering and pagination.
+   * @param {Object} params - The parameters for filtering and pagination.
+   * @param {number} [params.PatNum] - Filter by patient.
+   * @param {number} [params.Offset] - Pagination offset for results.
+   * @returns {Promise<DiscountPlanSub[]>} - A list of appointments.
+   */
+  public async getDiscountPlanSubs({
+    PatNum,
+    Offset,
+  }: GetDiscountPlanSubsParams = {}): Promise<DiscountPlanSub[]> {
+    const params = {
+      PatNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<DiscountPlanSub[]>("/discountplansubs", params);
+  }
+
+  /**
+   * Create a new discount plan sub.
+   * @param {Object} data - The details of discount plan sub to create.
+   * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
+   * @param {number} data.PatNum - Required: Patient number.
+   * @param {number} [data.DateEffective] - Optional: Patient number.
+   * @param {number} [data.DateTerm] - Optional: Patient number.
+   * @param {number} [data.SubNote] - Optional: Patient number.
+   * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createDiscountPlanSub(data: CreateDiscountPlanSubParams): Promise<DiscountPlanSub> {
+    if (!data.DiscountPlanNum || !data.PatNum) {
+      throw new Error("Invalid data: DiscountPlanNum and PatNum are required.");
+    }
+
+    return this.httpClient.post<DiscountPlanSub>("/discountplansubs", data);
+  }
+
+  /**
+   * Update a discount plan sub.
+   * @param {Object} data - The details of the discount sub to update.
+   * @param {number} data.DiscountSubNum - Required: PK
+   * @param {number} data.PatNum - Required: Patient number.
+   * @param {number} [data.DateEffective] - Optional: Patient number.
+   * @param {number} [data.DateTerm] - Optional: Patient number.
+   * @param {number} [data.SubNote] - Optional: Patient number.
+   * @returns {Promise<DiscountPlanSub>} - The updated discount plan sub.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub> {
+    if (!data.DiscountSubNum || !data.PatNum) {
+      throw new Error("Invalid data: DiscountSubNum and PatNum are required.");
+    }
+
+    return this.httpClient.put<DiscountPlanSub>(`/discountplansubs/${data.DiscountSubNum}`, data);
+  }
+
+  /**
+   * Delete a discount plan sub entry.
+   * @param {number} [DiscountSubNum] - Required: The unique identifier of the discount plan sub to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
+   */
+  public async deleteDiscountPlanSub(DiscountSubNum: number): Promise<void> {
+    if (!DiscountSubNum || typeof DiscountSubNum !== "number") {
+      throw new Error("Invalid parameter: ProcNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/discountplansubs/${DiscountSubNum}`);
+  }
+}

package/src/api/index.ts

@@ -6,5 +6,10 @@ export { default as Patients } from "./patients";
 export { default as ProcedureLogs } from "./procedureLog"; 
 export { default as Recalls } from "./recalls";
 export { default as TreatmentPlans } from "./treatplans";
-export { default as Schedule } from "./schedules"; 
+export { default as Schedules } from "./schedules"; 
+export { default as Providers } from "./providers"; 
+export { default as Operatories } from "./operatories"; 
+export { default as Payments } from "./payments";
+export { default as Definitions } from "./definitions"; 
+export { default as DiscountPlanSubs } from "./discountPlanSubs"; 
 // Add other APIs as needed

package/src/api/operatories.ts

@@ -13,9 +13,9 @@ export default class Operatories {
 
   /**
    * Fetch a single operatory by its ID.
-   * @param {number} OperatoryNum - The ID of the patfield.
-   * @returns {Promise<Operatory>} - The patient data.
-   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+   * @param {number} OperatoryNum - The ID of the operatory.
+   * @returns {Promise<Operatory>} - The operatory data.
+   * @throws {Error} - If `OperatoryNum` is not valid or the API returns an error.
    */
   public async getOperatory(OperatoryNum: number): Promise<Operatory> {
     if (!OperatoryNum || typeof OperatoryNum !== "number") {
@@ -30,7 +30,7 @@ export default class Operatories {
    * @param {Object} params - Filtering and pagination parameters.
    * @param {string} [params.ClinicNum] - Filter by clinicnum
    * @param {string} [params.Offset] - Filter by clinicnum
-  * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+  * @returns {Promise<Operatory[]>} - A list of operatories.
    * @throws {Error} - If the API returns an error.
    */
     public async getOperatories({

package/src/api/patFields.ts

@@ -15,7 +15,7 @@ export default class PatFields {
   /**
    * Fetch a single patfield by its ID.
    * @param {number} PatFieldNum - The ID of the patfield.
-   * @returns {Promise<PatField>} - The patient data.
+   * @returns {Promise<PatField>} - The patfield data.
    * @throws {Error} - If `PatNum` is not valid or the API returns an error.
    */
   public async getPatField(PatFieldNum: number): Promise<PatField> {
@@ -27,12 +27,12 @@ export default class PatFields {
   }
 
   /**
-   * Fetch multiple patients with optional filtering and pagination.
+   * Fetch multiple patfields with optional filtering and pagination.
    * @param {Object} params - Filtering and pagination parameters.
    * @param {string} [params.PatNum] - Filter by last name (case-insensitive, partial match).
    * @param {string} [params.FieldName] - Filter by last name (case-insensitive, partial match).
    * @param {string} [params.SecDateTEdit] - Filter by last name (case-insensitive, partial match).
-   * @returns {Promise<PatField[]>} - A list of summarized patient data.
+   * @returns {Promise<PatField[]>} - A list of patfields.
    * @throws {Error} - If the API returns an error.
    */
     public async getPatFields({

package/src/api/payments.ts

@@ -0,0 +1,86 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Payment,
+  GetPaymentsParams,
+  CreatePaymentParams,
+  UpdatePaymentParams,
+} from "../types/paymentTypes";
+
+export default class Payments {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+/**
+ * Fetch multiple payments with optional filtering and pagination.
+ * @param {Object} params - The parameters for filtering and pagination.
+ * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
+ * @param {number} [params.PatNum] - FK to patient.PatNum.
+ * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
+ * @param {number} [params.Offset] - Pagination offset for results.
+ * @returns {Promise<Payment[]>} - A list of payments.
+ */
+public async getPayments({
+    PayType,
+    PatNum,
+    DateEntry,
+    Offset,
+  }: GetPaymentsParams = {}): Promise<Payment[]> {
+    const params = {
+      PayType,
+      PatNum,
+      DateEntry,
+      Offset,
+    };
+  
+    return this.httpClient.get<Payment[]>("/payments", params);
+  }
+
+  /**
+   * Create a payment.
+   * @param {Object} data - Data for the new payment.
+   * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+   * @param {number} data.PatNum - Required: FK to Patient
+   * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+   * @param {string} [data.CheckNum] - Optional.
+   * @param {string} [data.PayNote] - Optional.
+   * @param {string} [data.BankBranch] - Optional.
+   * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+   * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. 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".
+   * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+   * @param {number[]} [data.procNums=[]] - Optional. 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.
+   * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+   * @returns {Promise<Payment>} - The created payment.
+   * @throws {Error} - If required fields are missing.
+   */
+    public async createPayment(data: CreatePaymentParams): Promise<Payment> {
+        if (!data.PayAmt || !data.PatNum) {
+          throw new Error("PayAmt and PatNum are required.");
+        }
+    
+        return this.httpClient.post<Payment>("/payments", data);
+      }
+
+  /**
+   * Update a payment.
+   * @param {Object} data - Data for the new payment.
+   * @param {string} data.PayNum - Required: PK of Payment to update.
+   * @param {string} [data.PayType] - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.CheckNum] - Optional.
+   * @param {string} [data.PayNote] - Optional.
+   * @param {string} [data.BankBranch] - Optional.
+   * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+   * @returns {Promise<Payment>} - The updated payment.
+   * @throws {Error} - If required fields are missing.
+   */
+  public async updatePayment(data: UpdatePaymentParams): Promise<Payment> {
+    if (!data.PayNum) {
+      throw new Error("PayNum is required.");
+    }
+
+    return this.httpClient.put<Payment>(`/payments/${data.PayNum}`, data);
+  }
+}

package/src/api/providers.ts

@@ -33,7 +33,7 @@ export default class Providers {
    * @param {number} [params.ClinicNum] - Get providers by ClinicNum
    * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
    * @param {string} [params.Offset] - Pagination
-  * @returns {Promise<Provider[]>} - A list of summarized patient data.
+  * @returns {Promise<Provider[]>} - A list of providers.
    * @throws {Error} - If the API returns an error.
    */
     public async getProviders({
@@ -51,25 +51,25 @@ export default class Providers {
 
     /**
      * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
-     * @param {Object} data - The data for the new patfield.
+     * @param {Object} data - The data for the new provider.
      * @param {string} data.Abbr - Required.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The created provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     public async createProvider({
@@ -118,25 +118,25 @@ export default class Providers {
     /**
      * Update a provider.
      * @param {number} ProvNum - The ID of the provider.
-     * @param {Object} data - The data for the new patfield.
-     * @param {string} data.Abbr - Optional but must not be blank.
-     * @param {string} data.LName - Optional.
-     * @param {string} data.FName - Optional.
-     * @param {string} data.MI - Optional.
-     * @param {string} data.Suffix - Optional.
-     * @param {number} data.FeeSched - Optional.
-     * @param {number} data.Specialty - Optional.
-     * @param {string} data.SSN - Optional.
-     * @param {'true' | 'false'} data.IsSecondary - Optional.
-     * @param {'true' | 'false'} data.IsHidden - Optional.
-     * @param {'true' | 'false'} data.UsingTIN - Optional.
-     * @param {'true' | 'false'} data.SigOnFile - Optional.
-     * @param {'true' | 'false'} data.IsNotPerson - Optional.
-     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
-     * @param {string} data.Birthdate - Optional.
-     * @param {string} data.SchedNote - Optional.
-     * @param {string} data.PreferredName - Optional.
-     * @returns {Promise<Provider>} - The created PatField.
+     * @param {Object} data - The data for a provider.
+     * @param {string} [data.Abbr] - Optional but must not be blank.
+     * @param {string} [data.LName] - Optional.
+     * @param {string} [data.FName] - Optional.
+     * @param {string} [data.MI] - Optional.
+     * @param {string} [data.Suffix] - Optional.
+     * @param {number} [data.FeeSched] - Optional.
+     * @param {number} [data.Specialty] - Optional.
+     * @param {string} [data.SSN] - Optional.
+     * @param {'true' | 'false'} [data.IsSecondary] - Optional.
+     * @param {'true' | 'false'} [data.IsHidden] - Optional.
+     * @param {'true' | 'false'} [data.UsingTIN] - Optional.
+     * @param {'true' | 'false'} [data.SigOnFile] - Optional.
+     * @param {'true' | 'false'} [data.IsNotPerson] - Optional.
+     * @param {'true' | 'false'} [data.IsHiddenReport] - Optional.
+     * @param {string} [data.Birthdate] - Optional.
+     * @param {string} [data.SchedNote] - Optional.
+     * @param {string} [data.PreferredName] - Optional.
+     * @returns {Promise<Provider>} - The updated Provider.
      * @throws {Error} - If the data is invalid or the API returns an error.
      */
     public async updateProvider({

package/src/api/schedules.ts

@@ -13,8 +13,8 @@ export default class Schedules {
 
   /**
    * Fetch a single Schedule by its ID.
-   * @param {number} ScheduleNum - The ID of the patfield.
-   * @returns {Promise<Schedule>} - The patient data.
+   * @param {number} ScheduleNum - The ID of a schedule.
+   * @returns {Promise<Schedule>} - The schedule data.
    * @throws {Error} - If `PatNum` is not valid or the API returns an error.
    */
   public async getSchedule(ScheduleNum: number): Promise<Schedule> {
@@ -26,7 +26,7 @@ export default class Schedules {
   }
 
   /**
-   * Fetch multiple patients with optional filtering and pagination.
+   * Fetch multiple schedules with optional filtering and pagination.
    * @param {Object} params - Filtering and pagination parameters.
    * @param {string} [params.date] - Optional: For a single day. Today's date by default.
    * @param {string} [params.dateStart] - Optional: For a single day. Today's date by default.
@@ -36,7 +36,7 @@ export default class Schedules {
    * @param {number} [params.ProvNum] - FK to provider.ProvNum.
    * @param {number} [params.EmployeeNum] - FK to employee.EmployeeNum.
    * @param {number} [params.Offset] - Pagination offset.
-   * @returns {Promise<Schedule[]>} - A list of summarized patient data.
+   * @returns {Promise<Schedule[]>} - A list of schedules.
    * @throws {Error} - If the API returns an error.
    */
   public async getSchedules({

package/src/api/treatplans.ts

@@ -6,7 +6,6 @@ import {
     UpdateTreatmentPlanParams,
     SaveTreatmentPlanParams,
 } from "../types/treatPlanTypes";
-import { updateProcedureLogParams } from "../types/procedurelogTypes";
 
 export default class TreatmentPlans {
   private httpClient: HttpClient;
@@ -21,7 +20,7 @@ export default class TreatmentPlans {
      * @param {string} [params.PatNum] - patient.PatNum.
      * @param {string} [params.SecDateTEdit] - Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
      * @param {"Saved" | "Active" | "Inactive"} [params.TPStatus] - Either "Saved", "Active", or "Inactive". Default all.
-     * @returns {Promise<TreatmentPlan[]>} - An array of recall list objects.
+     * @returns {Promise<TreatmentPlan[]>} - An array of treatplan objects.
      */
     public async getTreatmentPlans({
         PatNum,
@@ -39,12 +38,12 @@ export default class TreatmentPlans {
 
      /**
      * Create a new TreatPlan.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for the new treatment plan.
      * @param {number} data.PatNum - Required. FK to patient.PatNum.
      * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
      * @param {string} [data.Note] - Optional: An administrative note for staff use.
      * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
-     * @returns {Promise<TreatmentPlan>} - The created recall object.
+     * @returns {Promise<TreatmentPlan>} - The created treatment plan object.
      * @throws {Error} - If required fields are missing.
      */
     public async createTreatmentPlan(data: CreateTreatmentPlanParams): Promise<TreatmentPlan> {
@@ -57,11 +56,11 @@ export default class TreatmentPlans {
 
     /**
      * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
-     * @param {Object} data - Data for the new appointment.
+     * @param {Object} data - Data for saved treatment plan.
      * @param {number} data.TreatPlanNum - Required.
      * @param {string} [data.Heading] - Optional. Defaults to the heading of the supplied Treatment Plan.
      * @param {string} [data.UserNumPresenter=0] - Optional. FK to userod.UserNum. Default 0.
-     * @returns {Promise<TreatmentPlan>} - The created recall object.
+     * @returns {Promise<TreatmentPlan>} - The saved treatment plan object.
      * @throws {Error} - If required fields are missing.
      */
     public async saveTreatmentPlan(data: SaveTreatmentPlanParams): Promise<TreatmentPlan> {
@@ -73,10 +72,10 @@ export default class TreatmentPlans {
     }
 
     /**
-    * Create a new TreatPlan.
-    * @param {Object} data - Data for the new appointment.
+    * Update a TreatPlan.
+    * @param {Object} data - Data for the treatplan.
     * @param {number} data.TreatPlanNum - Required.
-    * @param {string} [data.Heading] - The heading that shows at the top of the treatment plan.
+    * @param {string} [data.Heading] - Optional. The heading that shows at the top of the treatment plan.
     * @param {string} [data.Note] - Optional: An administrative note for staff use.
     * @param {number} [data.ResponsParty] - FK to patient.PatNum. The patient responsible for approving the treatment.
     * @param {"Insurance" | "Discount"} [params.TPType] - Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
@@ -84,7 +83,7 @@ export default class TreatmentPlans {
     * @param {string} [data.SignaturePracticeText] - The typed name of the person who signed the patient signature.
     * @param {"true" | "false"} [data.isSigned] - The typed name of the person who signed the patient signature.
     * @param {"true" | "false"} [data.isSignedPractice] - Either "true" or "false". True updates the treatplan SignaturePractice, digitally signs for the practice, and overwrites existing signature. False clears the exisiting treatplan SignaturePractice.
-    * @returns {Promise<TreatmentPlan>} - The created recall object.
+    * @returns {Promise<TreatmentPlan>} - The updated treatplan object.
     * @throws {Error} - If required fields are missing.
      */
     public async updateTreatmentPlan(data: UpdateTreatmentPlanParams): Promise<TreatmentPlan> {

package/src/openDental.ts

@@ -10,6 +10,9 @@ import TreatmentPlans from "./api/treatplans";
 import Schedules from "./api/schedules";
 import Providers from "./api/providers";
 import Operatories from "./api/operatories";
+import Payments from "./api/payments";
+import Definitions from "./api/definitions";
+import DiscountPlanSubs from "./api/discountPlanSubs";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -120,7 +123,7 @@ class OpenDental {
     }
   
   /**
-   * Create a new instance of the Schedules API.
+   * Create a new instance of the Providers API.
    */
     public static Providers() {
       if (!this.httpClient) {
@@ -130,7 +133,7 @@ class OpenDental {
     }
 
   /**
-   * Create a new instance of the Schedules API.
+   * Create a new instance of the Operatories API.
    */
     public static Operatories() {
       if (!this.httpClient) {
@@ -138,6 +141,35 @@ class OpenDental {
       }
       return new Operatories(this.httpClient);
     }
+
+  /**
+   * Create a new instance of the Payments API.
+   */
+    public static Payments() {
+      if (!this.httpClient) {
+        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+      }
+      return new Payments(this.httpClient);
+    }
+
+  /**
+   * Create a new instance of the Definitions API.
+   */
+  public static Definitions() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Definitions(this.httpClient);
+  }
+  /**
+   * Create a new instance of the DiscountPlanSubs API.
+   */
+  public static DiscountPlanSubs() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new DiscountPlanSubs(this.httpClient);
+  }
 }
 
 export { OpenDental };

package/src/types/definitionTypes.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents a definition in the Open Dental system.
+ * Used in multiple definition-related endpoints.
+ * @see https://www.opendental.com/site/apidefinitions.html
+ */
+export interface Definition {
+    DefNum?: number; //PK
+    ItemName?: string; //
+    ItemValue?: string; //
+    Category?: number; //
+    category?: string; //
+    isHidden?: 'true' | 'false'; //
+  }
+
+  /**
+   * Parameters for GET Definitions.
+   * @see https://www.opendental.com/site/apidefinitions.html
+   */
+  export interface GetDefinitionsParams {
+    Category?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+    includeHidden?: 'true' | 'false'; //optional parameter that defaults to false.
+    Offset?: number; // Pagination offset for results
+  }
+  

package/src/types/discountPlanSubTypes.ts

@@ -0,0 +1,46 @@
+/**
+ * Represents a subscription to a discount plan in the Open Dental system.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface DiscountPlanSub {
+    DiscountSubNum?: number; //PK
+    DiscountPlanNum?: number; //FK to discount plan
+    PatNum?: number; //FK to patient
+    DateEffective?: string; //String in "yyyy-MM-dd" format. 
+    DateTerm?: string; //String in "yyyy-MM-dd" format. 
+    SubNote?: string; //
+  }
+
+  /**
+   * Parameters for GET discount plan subs.
+   * @see https://www.opendental.com/site/apidiscountplansubs.html
+   */
+  export interface GetDiscountPlanSubsParams {
+    PatNum?: number; // FK to patient.PatNum.
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating a discount plan sub.
+   * @see https://www.opendental.com/site/apidiscountplansubs.html
+   */
+  export interface CreateDiscountPlanSubParams {
+    PatNum: number; //FK to patient
+    DiscountPlanNum: number; //FK to discount plan
+    DateEffective?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will start impacting procedure fees. Default "0001-01-01" to indicate the beginning of the current calendar year.
+    DateTerm?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will no longer impact procedure fees. Default "0001-01-01" to indicate no end date.
+    SubNote?: string; //Optional. Subscriber note.
+  }
+  
+  /**
+   * Parameters for updating a discount plan sub.
+   * @see https://www.opendental.com/site/apidiscountplansubs.html
+   */
+  export interface UpdateDiscountPlanSubParams {
+    DiscountSubNum: number; //PK  
+    PatNum: string; //FK to patient
+    DateEffective?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will start impacting procedure fees. Default "0001-01-01" to indicate the beginning of the current calendar year.
+    DateTerm?: string; //Optional. String in "yyyy-MM-dd" format. The date when the plan will no longer impact procedure fees. Default "0001-01-01" to indicate no end date.
+    SubNote?: string; //Optional. Subscriber note.
+  }
+  

package/src/types/paymentTypes.ts

@@ -0,0 +1,70 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @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".
+  }
+