@rinse-dental/open-dental 3.2.2 → 3.3.1

package/dist/api/payPlanCharges.d.ts

@@ -0,0 +1,18 @@
+import HttpClient from "../utils/httpClient";
+import { PayPlanCharge } from "../types/payPlanChargeTypes";
+export default class PayPlanCharges {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch all payment plan charges for a specified payment plan.
+     * Mirrors GET /payplancharges
+     * Added in version 23.2.28
+     *
+     * @see https://www.opendental.com/site/apipayplancharges.html
+     * @param params - Query parameters: { PayPlanNum: number } (required)
+     */
+    getPayPlanCharges(params: {
+        PayPlanNum: number;
+    }): Promise<PayPlanCharge[]>;
+}
+//# sourceMappingURL=payPlanCharges.d.ts.map

package/dist/api/payPlanCharges.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payPlanCharges.d.ts","sourceRoot":"","sources":["../../src/api/payPlanCharges.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAS5D,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;OAOG;IACU,iBAAiB,CAC5B,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAC7B,OAAO,CAAC,aAAa,EAAE,CAAC;CAoB5B"}

package/dist/api/payPlanCharges.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Utility to remove undefined fields from objects (for API payloads) */
+const clean = (obj) => {
+    return Object.fromEntries(Object.entries(obj).filter(([_, v]) => v !== undefined));
+};
+class PayPlanCharges {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch all payment plan charges for a specified payment plan.
+     * Mirrors GET /payplancharges
+     * Added in version 23.2.28
+     *
+     * @see https://www.opendental.com/site/apipayplancharges.html
+     * @param params - Query parameters: { PayPlanNum: number } (required)
+     */
+    async getPayPlanCharges(params) {
+        // Validate required parameter
+        if (!params || typeof params !== "object") {
+            throw new Error("Invalid parameters: getPayPlanCharges requires a params object.");
+        }
+        if (!params.PayPlanNum || typeof params.PayPlanNum !== "number") {
+            throw new Error("Invalid parameter: PayPlanNum is required and must be a number.");
+        }
+        const query = clean({
+            PayPlanNum: params.PayPlanNum,
+        });
+        return this.httpClient.get("/payplancharges", query);
+    }
+}
+exports.default = PayPlanCharges;

package/dist/api/payPlans.d.ts

@@ -0,0 +1,66 @@
+import HttpClient from "../utils/httpClient";
+import { PayPlan, GetPayPlanByIdParams, CreateDynamicPayPlanParams, CreatePayPlanParams, ClosePayPlanParams, UpdateDynamicPayPlanParams } from "../types/payPlanTypes";
+export default class PayPlans {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple payment plans with filtering by PatNum or Guarantor.
+     * Mirrors GET /payplans
+     * @see https://www.opendental.com/site/apipayplans.html
+     * @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
+     */
+    getPayPlans(params: {
+        PatNum: number;
+        Guarantor?: never;
+    } | {
+        Guarantor: number;
+        PatNum?: never;
+    }): Promise<PayPlan[]>;
+    /**
+     * Fetch a single payment plan by PayPlanNum.
+     * Mirrors GET /payplans/{PayPlanNum}
+     * Added in version 24.4.30
+     */
+    getPayPlan({ PayPlanNum, }: GetPayPlanByIdParams): Promise<PayPlan>;
+    /**
+     * Create a new dynamic payment plan.
+     * Mirrors POST /payplans/Dynamic
+     * Added in version 22.2.22
+     *
+     * Required:
+     *  - PatNum
+     *  - PayAmt OR NumberOfPayments
+     *  - procNums and/or adjNums (at least one must have items)
+     *
+     * Note: If APR > 0, IsLocked may be required to be true (depending on preferences)
+     */
+    createDynamicPayPlan(data: CreateDynamicPayPlanParams): Promise<PayPlan>;
+    /**
+     * Create a patient payment plan (DEPRECATED as of 23.3.1).
+     * Mirrors POST /payplans
+     * Added in version 22.4.39, deprecated in 23.3.1
+     *
+     * @deprecated Use createDynamicPayPlan instead. This endpoint returns 410 Gone in newer versions.
+     *
+     * Required:
+     *  - PatNum
+     *  - useEstBalance OR principalAmount
+     *  - PayAmt OR NumberOfPayments
+     */
+    createPayPlan(data: CreatePayPlanParams): Promise<PayPlan>;
+    /**
+     * Close a payment plan and charge any outstanding interest.
+     * Mirrors PUT /payplans/{PayPlanNum}/Close
+     * Added in version 22.4.39
+     */
+    closePayPlan({ PayPlanNum, }: ClosePayPlanParams): Promise<PayPlan>;
+    /**
+     * Update an existing dynamic payment plan.
+     * Mirrors PUT /payplans/{PayPlanNum}/Dynamic
+     * Added in version 25.3.31
+     *
+     * All fields except PayPlanNum are optional; send only what you intend to change.
+     */
+    updateDynamicPayPlan(data: UpdateDynamicPayPlanParams): Promise<PayPlan>;
+}
+//# sourceMappingURL=payPlans.d.ts.map

package/dist/api/payPlans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payPlans.d.ts","sourceRoot":"","sources":["../../src/api/payPlans.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,oBAAoB,EACpB,0BAA0B,EAC1B,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAS/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsBnI;;;;OAIG;IACU,UAAU,CAAC,EACtB,UAAU,GACX,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO1C;;;;;;;;;;;OAWG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;IA4DnB;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAuDvE;;;;OAIG;IACU,YAAY,CAAC,EACxB,UAAU,GACX,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxC;;;;;;OAMG;IACU,oBAAoB,CAC/B,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,OAAO,CAAC;CAoCpB"}

package/dist/api/payPlans.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Utility to remove undefined fields from objects (for API payloads) */
+const clean = (obj) => {
+    return Object.fromEntries(Object.entries(obj).filter(([_, v]) => v !== undefined));
+};
+class PayPlans {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple payment plans with filtering by PatNum or Guarantor.
+     * Mirrors GET /payplans
+     * @see https://www.opendental.com/site/apipayplans.html
+     * @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
+     */
+    async getPayPlans(params) {
+        // API requires either PatNum OR Guarantor, not both
+        if ('PatNum' in params && 'Guarantor' in params && params.PatNum && params.Guarantor) {
+            throw new Error("Invalid parameters: PatNum and Guarantor are mutually exclusive. Provide only one.");
+        }
+        if (!('PatNum' in params) && !('Guarantor' in params)) {
+            throw new Error("Invalid parameters: Either PatNum or Guarantor is required.");
+        }
+        const query = clean({
+            PatNum: 'PatNum' in params ? params.PatNum : undefined,
+            Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
+        });
+        return this.httpClient.get("/payplans", query);
+    }
+    /**
+     * Fetch a single payment plan by PayPlanNum.
+     * Mirrors GET /payplans/{PayPlanNum}
+     * Added in version 24.4.30
+     */
+    async getPayPlan({ PayPlanNum, }) {
+        if (!PayPlanNum || typeof PayPlanNum !== "number") {
+            throw new Error("Invalid parameter: PayPlanNum must be a valid number.");
+        }
+        return this.httpClient.get(`/payplans/${PayPlanNum}`);
+    }
+    /**
+     * Create a new dynamic payment plan.
+     * Mirrors POST /payplans/Dynamic
+     * Added in version 22.2.22
+     *
+     * Required:
+     *  - PatNum
+     *  - PayAmt OR NumberOfPayments
+     *  - procNums and/or adjNums (at least one must have items)
+     *
+     * Note: If APR > 0, IsLocked may be required to be true (depending on preferences)
+     */
+    async createDynamicPayPlan(data) {
+        // Validate required fields
+        if (!data || typeof data !== "object") {
+            throw new Error("Invalid payload: createDynamicPayPlan requires a request body.");
+        }
+        if (!data.PatNum || typeof data.PatNum !== "number") {
+            throw new Error("Invalid payload: PatNum is required and must be a number.");
+        }
+        // Either PayAmt OR NumberOfPayments is required
+        if (!data.PayAmt && !data.NumberOfPayments) {
+            throw new Error("Invalid payload: Either PayAmt or NumberOfPayments is required.");
+        }
+        // At least one of procNums or adjNums must be provided and non-empty
+        const hasProcNums = Array.isArray(data.procNums) && data.procNums.length > 0;
+        const hasAdjNums = Array.isArray(data.adjNums) && data.adjNums.length > 0;
+        if (!hasProcNums && !hasAdjNums) {
+            throw new Error("Invalid payload: At least one of procNums or adjNums must be a non-empty array.");
+        }
+        // Validate APR and IsLocked relationship
+        if (data.APR && data.APR > 0 && data.IsLocked === false) {
+            console.warn("Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences.");
+        }
+        const payload = clean({
+            PatNum: data.PatNum,
+            PayAmt: data.PayAmt,
+            NumberOfPayments: data.NumberOfPayments,
+            procNums: data.procNums,
+            adjNums: data.adjNums,
+            Guarantor: data.Guarantor,
+            PayPlanDate: data.PayPlanDate,
+            APR: data.APR,
+            DownPayment: data.DownPayment,
+            Note: data.Note,
+            PlanCategory: data.PlanCategory,
+            ChargeFrequency: data.ChargeFrequency,
+            DatePayPlanStart: data.DatePayPlanStart,
+            DateInterestStart: data.DateInterestStart,
+            IsLocked: data.IsLocked,
+            DynamicPayPlanTPOption: data.DynamicPayPlanTPOption,
+        });
+        return this.httpClient.post("/payplans/Dynamic", payload);
+    }
+    /**
+     * Create a patient payment plan (DEPRECATED as of 23.3.1).
+     * Mirrors POST /payplans
+     * Added in version 22.4.39, deprecated in 23.3.1
+     *
+     * @deprecated Use createDynamicPayPlan instead. This endpoint returns 410 Gone in newer versions.
+     *
+     * Required:
+     *  - PatNum
+     *  - useEstBalance OR principalAmount
+     *  - PayAmt OR NumberOfPayments
+     */
+    async createPayPlan(data) {
+        console.warn("Warning: createPayPlan is deprecated as of version 23.3.1. Use createDynamicPayPlan instead.");
+        // Validate required fields
+        if (!data || typeof data !== "object") {
+            throw new Error("Invalid payload: createPayPlan requires a request body.");
+        }
+        if (!data.PatNum || typeof data.PatNum !== "number") {
+            throw new Error("Invalid payload: PatNum is required and must be a number.");
+        }
+        // Either useEstBalance OR principalAmount is required
+        if (data.useEstBalance === undefined &&
+            data.principalAmount === undefined) {
+            throw new Error("Invalid payload: Either useEstBalance or principalAmount is required.");
+        }
+        // Either PayAmt OR NumberOfPayments is required
+        if (!data.PayAmt && !data.NumberOfPayments) {
+            throw new Error("Invalid payload: Either PayAmt or NumberOfPayments is required.");
+        }
+        const payload = clean({
+            PatNum: data.PatNum,
+            useEstBalance: data.useEstBalance,
+            principalAmount: data.principalAmount,
+            PayAmt: data.PayAmt,
+            NumberOfPayments: data.NumberOfPayments,
+            Guarantor: data.Guarantor,
+            PayPlanDate: data.PayPlanDate,
+            APR: data.APR,
+            DownPayment: data.DownPayment,
+            Note: data.Note,
+            PlanCategory: data.PlanCategory,
+            ChargeFrequency: data.ChargeFrequency,
+            DatePayPlanStart: data.DatePayPlanStart,
+            DateInterestStart: data.DateInterestStart,
+        });
+        return this.httpClient.post("/payplans", payload);
+    }
+    /**
+     * Close a payment plan and charge any outstanding interest.
+     * Mirrors PUT /payplans/{PayPlanNum}/Close
+     * Added in version 22.4.39
+     */
+    async closePayPlan({ PayPlanNum, }) {
+        if (!PayPlanNum || typeof PayPlanNum !== "number") {
+            throw new Error("Invalid parameter: PayPlanNum is required and must be a number.");
+        }
+        return this.httpClient.put(`/payplans/${PayPlanNum}/Close`, {});
+    }
+    /**
+     * Update an existing dynamic payment plan.
+     * Mirrors PUT /payplans/{PayPlanNum}/Dynamic
+     * Added in version 25.3.31
+     *
+     * All fields except PayPlanNum are optional; send only what you intend to change.
+     */
+    async updateDynamicPayPlan(data) {
+        if (!data?.PayPlanNum || typeof data.PayPlanNum !== "number") {
+            throw new Error("Invalid payload: PayPlanNum is required and must be a number.");
+        }
+        // Validate APR and IsLocked relationship
+        if (data.APR && data.APR > 0 && data.IsLocked === false) {
+            console.warn("Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences.");
+        }
+        const { PayPlanNum, ...updateFields } = data;
+        const payload = clean({
+            PayAmt: updateFields.PayAmt,
+            NumberOfPayments: updateFields.NumberOfPayments,
+            Guarantor: updateFields.Guarantor,
+            PayPlanDate: updateFields.PayPlanDate,
+            APR: updateFields.APR,
+            Note: updateFields.Note,
+            PlanCategory: updateFields.PlanCategory,
+            ChargeFrequency: updateFields.ChargeFrequency,
+            DatePayPlanStart: updateFields.DatePayPlanStart,
+            DateInterestStart: updateFields.DateInterestStart,
+            IsLocked: updateFields.IsLocked,
+            SheetDefNum: updateFields.SheetDefNum,
+        });
+        return this.httpClient.put(`/payplans/${PayPlanNum}/Dynamic`, payload);
+    }
+}
+exports.default = PayPlans;

package/dist/openDental.d.ts

@@ -12,6 +12,8 @@ import Providers from "./api/providers";
 import Operatories from "./api/operatories";
 import Payments from "./api/payments";
 import PaySplits from "./api/paySplits";
+import PayPlans from "./api/payPlans";
+import PayPlanCharges from "./api/payPlanCharges";
 import Definitions from "./api/definitions";
 import DiscountPlans from "./api/discountPlans";
 import DiscountPlanSubs from "./api/discountPlanSubs";
@@ -161,6 +163,14 @@ declare class OpenDental {
      * Create a new instance of the PaySplits API.
      */
     static PaySplits(): PaySplits;
+    /**
+     * Create a new instance of the PayPlans API.
+     */
+    static PayPlans(): PayPlans;
+    /**
+     * Create a new instance of the PayPlanCharges API.
+     */
+    static PayPlanCharges(): PayPlanCharges;
     /**
      * Create a new instance of the Fees API.
      */

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,MAAM;IAOpB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;KAEC;WACa,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,YAAY;IAO1B;;KAEC;WACa,gBAAgB;IAO9B;;KAEC;WACa,WAAW;IAOzB;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,MAAM;IAOpB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,IAAI;IAOlB;;KAEC;WACa,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,YAAY;IAO1B;;KAEC;WACa,gBAAgB;IAO9B;;KAEC;WACa,WAAW;IAOzB;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -52,6 +52,8 @@ const providers_1 = __importDefault(require("./api/providers"));
 const operatories_1 = __importDefault(require("./api/operatories"));
 const payments_1 = __importDefault(require("./api/payments"));
 const paySplits_1 = __importDefault(require("./api/paySplits"));
+const payPlans_1 = __importDefault(require("./api/payPlans"));
+const payPlanCharges_1 = __importDefault(require("./api/payPlanCharges"));
 const definitions_1 = __importDefault(require("./api/definitions"));
 const discountPlans_1 = __importDefault(require("./api/discountPlans"));
 const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
@@ -353,6 +355,24 @@ class OpenDental {
         }
         return new paySplits_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the PayPlans API.
+     */
+    static PayPlans() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new payPlans_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the PayPlanCharges API.
+     */
+    static PayPlanCharges() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new payPlanCharges_1.default(this.httpClient);
+    }
     /**
      * Create a new instance of the Fees API.
      */

package/dist/types/payPlanChargeTypes.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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;
+/**
+ * Represents a PayPlanCharge returned by the Open Dental API.
+ * Mirrors the response payload of GET endpoints.
+ */
+export interface PayPlanCharge {
+    PayPlanChargeNum: number;
+    PayPlanNum: number;
+    Guarantor: number;
+    PatNum: number;
+    ChargeDate: string;
+    Principal: number;
+    Interest: number;
+    Note: string;
+    ProvNum: number;
+    ClinicNum: number;
+    ChargeType: ChargeType;
+    ProcNum: number;
+    SecDateTEntry: string;
+    SecDateTEdit: string;
+    StatementNum: number;
+    FKey: number;
+    LinkType: LinkType;
+    IsOffset: boolean;
+}
+/** GET /payplancharges query params */
+export interface GetPayPlanChargesParams {
+    /** Payment plan number - Required */
+    PayPlanNum: number;
+}
+/** Minimal helper to detect "zero" dates in responses */
+export declare const isZeroDate: (d?: string | null) => boolean;
+/** Narrow helper for timestamps that can be zeroed by the API */
+export declare const isZeroDateTime: (d?: string | null) => boolean;
+/** Runtime guard for ChargeType values */
+export declare const isChargeType: (s: string) => s is ChargeType;
+/** Helper to determine if a charge is a debit (payment due) */
+export declare const isDebitCharge: (charge: PayPlanCharge) => boolean;
+/** Helper to determine if a charge is a credit (payment received) */
+export declare const isCreditCharge: (charge: PayPlanCharge) => boolean;
+/** Helper to calculate total charge amount (principal + interest) */
+export declare const getTotalChargeAmount: (charge: PayPlanCharge) => number;
+//# sourceMappingURL=payPlanChargeTypes.d.ts.map

package/dist/types/payPlanChargeTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payPlanChargeTypes.d.ts","sourceRoot":"","sources":["../../src/types/payPlanChargeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,2CAA2C;AAC3C,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5C,yCAAyC;AACzC,MAAM,MAAM,QAAQ,GAChB,WAAW,GACX,YAAY,GACZ,SAAS,GACT,MAAM,GACN,MAAM,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,uCAAuC;AACvC,MAAM,WAAW,uBAAuB;IACtC,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yDAAyD;AACzD,eAAO,MAAM,UAAU,GAAI,IAAI,MAAM,GAAG,IAAI,KAAG,OACrB,CAAC;AAE3B,iEAAiE;AACjE,eAAO,MAAM,cAAc,GAAI,IAAI,MAAM,GAAG,IAAI,KAAG,OACjB,CAAC;AAEnC,0CAA0C;AAC1C,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,KAAG,CAAC,IAAI,UACb,CAAC;AAElC,+DAA+D;AAC/D,eAAO,MAAM,aAAa,GAAI,QAAQ,aAAa,KAAG,OACvB,CAAC;AAEhC,qEAAqE;AACrE,eAAO,MAAM,cAAc,GAAI,QAAQ,aAAa,KAAG,OACvB,CAAC;AAEjC,qEAAqE;AACrE,eAAO,MAAM,oBAAoB,GAAI,QAAQ,aAAa,KAAG,MACzB,CAAC"}

package/dist/types/payPlanChargeTypes.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTotalChargeAmount = exports.isCreditCharge = exports.isDebitCharge = exports.isChargeType = exports.isZeroDateTime = exports.isZeroDate = void 0;
+/** Minimal helper to detect "zero" dates in responses */
+const isZeroDate = (d) => !d || d === "0001-01-01";
+exports.isZeroDate = isZeroDate;
+/** Narrow helper for timestamps that can be zeroed by the API */
+const isZeroDateTime = (d) => !d || d.startsWith("0001-01-01");
+exports.isZeroDateTime = isZeroDateTime;
+/** Runtime guard for ChargeType values */
+const isChargeType = (s) => ["Debit", "Credit"].includes(s);
+exports.isChargeType = isChargeType;
+/** Helper to determine if a charge is a debit (payment due) */
+const isDebitCharge = (charge) => charge.ChargeType === "Debit";
+exports.isDebitCharge = isDebitCharge;
+/** Helper to determine if a charge is a credit (payment received) */
+const isCreditCharge = (charge) => charge.ChargeType === "Credit";
+exports.isCreditCharge = isCreditCharge;
+/** Helper to calculate total charge amount (principal + interest) */
+const getTotalChargeAmount = (charge) => charge.Principal + charge.Interest;
+exports.getTotalChargeAmount = getTotalChargeAmount;

package/dist/types/payPlanTypes.d.ts

@@ -0,0 +1,143 @@
+/**
+ * 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;
+    PatNum: number;
+    Guarantor: number;
+    PayPlanDate: string;
+    APR: number;
+    Note: string;
+    PlanNum: number;
+    CompletedAmt: number;
+    InsSubNum: number;
+    PaySchedule: number;
+    NumberOfPayments: number;
+    PayAmt: number;
+    DownPayment: number;
+    IsClosed: boolean;
+    Signature: string;
+    SigIsTopaz: boolean;
+    PlanCategory: number;
+    IsDynamic: boolean;
+    ChargeFrequency: ChargeFrequency;
+    DatePayPlanStart: string;
+    DynamicPayPlanTPOption: DynamicPayPlanTPOption;
+    DateInterestStart: string;
+    IsLocked: boolean;
+    SheetDefNum: number;
+}
+/** 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;
+    PayAmt?: number;
+    NumberOfPayments?: number;
+    procNums?: number[];
+    adjNums?: number[];
+    Guarantor?: number;
+    PayPlanDate?: string;
+    APR?: number;
+    DownPayment?: number;
+    Note?: string;
+    PlanCategory?: number;
+    ChargeFrequency?: ChargeFrequency;
+    DatePayPlanStart?: string;
+    DateInterestStart?: string;
+    IsLocked?: boolean;
+    DynamicPayPlanTPOption?: DynamicPayPlanTPOption;
+}
+/**
+ * POST /payplans body (DEPRECATED as of 23.3.1)
+ * Use CreateDynamicPayPlanParams instead
+ * Creates an old-style patient payment plan
+ */
+export interface CreatePayPlanParams {
+    PatNum: number;
+    useEstBalance?: boolean;
+    principalAmount?: number;
+    PayAmt?: number;
+    NumberOfPayments?: number;
+    Guarantor?: number;
+    PayPlanDate?: string;
+    APR?: number;
+    DownPayment?: number;
+    Note?: string;
+    PlanCategory?: number;
+    ChargeFrequency?: ChargeFrequency;
+    DatePayPlanStart?: string;
+    DateInterestStart?: string;
+}
+/**
+ * PUT /payplans/{PayPlanNum}/Close
+ * Closes a payment plan and charges outstanding interest
+ */
+export interface ClosePayPlanParams {
+    PayPlanNum: number;
+}
+/**
+ * PUT /payplans/{PayPlanNum}/Dynamic
+ * Updates a dynamic payment plan
+ * All fields optional except PayPlanNum
+ */
+export interface UpdateDynamicPayPlanParams {
+    PayPlanNum: number;
+    PayAmt?: number;
+    NumberOfPayments?: number;
+    Guarantor?: number;
+    PayPlanDate?: string;
+    APR?: number;
+    Note?: string;
+    PlanCategory?: number;
+    ChargeFrequency?: ChargeFrequency;
+    DatePayPlanStart?: string;
+    DateInterestStart?: string;
+    IsLocked?: boolean;
+    SheetDefNum?: number;
+}
+/** Minimal helper to detect "zero" dates in responses */
+export declare const isZeroDate: (d?: string | null) => boolean;
+/** Narrow helper for timestamps that can be zeroed by the API */
+export declare const isZeroDateTime: (d?: string | null) => boolean;
+/** Runtime guard for ChargeFrequency values */
+export declare const isChargeFrequency: (s: string) => s is ChargeFrequency;
+/** Runtime guard for DynamicPayPlanTPOption values */
+export declare const isDynamicPayPlanTPOption: (t: string) => t is DynamicPayPlanTPOption;
+/** Helper to determine if a PayPlan is an insurance payment plan */
+export declare const isInsurancePayPlan: (payPlan: PayPlan) => boolean;
+/** Helper to determine if a PayPlan is a patient payment plan */
+export declare const isPatientPayPlan: (payPlan: PayPlan) => boolean;
+//# sourceMappingURL=payPlanTypes.d.ts.map

package/dist/types/payPlanTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payPlanTypes.d.ts","sourceRoot":"","sources":["../../src/types/payPlanTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,yCAAyC;AACzC,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,gBAAgB,CAAC;AAErB,iDAAiD;AACjD,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,iBAAiB,GACjB,MAAM,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4CAA4C;AAC5C,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yDAAyD;AACzD,eAAO,MAAM,UAAU,GAAI,IAAI,MAAM,GAAG,IAAI,KAAG,OACrB,CAAC;AAE3B,iEAAiE;AACjE,eAAO,MAAM,cAAc,GAAI,IAAI,MAAM,GAAG,IAAI,KAAG,OACjB,CAAC;AAEnC,+CAA+C;AAC/C,eAAO,MAAM,iBAAiB,GAAI,GAAG,MAAM,KAAG,CAAC,IAAI,eACiC,CAAC;AAErF,sDAAsD;AACtD,eAAO,MAAM,wBAAwB,GAAI,GAAG,MAAM,KAAG,CAAC,IAAI,sBACA,CAAC;AAE3D,oEAAoE;AACpE,eAAO,MAAM,kBAAkB,GAAI,SAAS,OAAO,KAAG,OACR,CAAC;AAE/C,iEAAiE;AACjE,eAAO,MAAM,gBAAgB,GAAI,SAAS,OAAO,KAAG,OACF,CAAC"}

package/dist/types/payPlanTypes.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPatientPayPlan = exports.isInsurancePayPlan = exports.isDynamicPayPlanTPOption = exports.isChargeFrequency = exports.isZeroDateTime = exports.isZeroDate = void 0;
+/** Minimal helper to detect "zero" dates in responses */
+const isZeroDate = (d) => !d || d === "0001-01-01";
+exports.isZeroDate = isZeroDate;
+/** Narrow helper for timestamps that can be zeroed by the API */
+const isZeroDateTime = (d) => !d || d.startsWith("0001-01-01");
+exports.isZeroDateTime = isZeroDateTime;
+/** Runtime guard for ChargeFrequency values */
+const isChargeFrequency = (s) => ["Weekly", "EveryOtherWeek", "Monthly", "Quarterly", "OrdinalWeekday"].includes(s);
+exports.isChargeFrequency = isChargeFrequency;
+/** Runtime guard for DynamicPayPlanTPOption values */
+const isDynamicPayPlanTPOption = (t) => ["AwaitComplete", "TreatAsComplete", "None"].includes(t);
+exports.isDynamicPayPlanTPOption = isDynamicPayPlanTPOption;
+/** Helper to determine if a PayPlan is an insurance payment plan */
+const isInsurancePayPlan = (payPlan) => payPlan.PlanNum > 0 && payPlan.InsSubNum > 0;
+exports.isInsurancePayPlan = isInsurancePayPlan;
+/** Helper to determine if a PayPlan is a patient payment plan */
+const isPatientPayPlan = (payPlan) => payPlan.PlanNum === 0 && payPlan.InsSubNum === 0;
+exports.isPatientPayPlan = isPatientPayPlan;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "3.2.2",
+    "version": "3.3.1",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/release.sh

@@ -41,7 +41,7 @@ gh release create "$NEW_TAG" --title "Release $NEW_TAG" --notes "$COMMIT_MSG"
 
 
 #example ./release.sh "updated axios error return" patch 
-#example ./release.sh "Added InsVerifies" minor
+#example ./release.sh "Added Claims api" minor
 #example ./release.sh "Some commit message" major 
 
 #./release.sh "Added readme" patch

package/src/api/payPlanCharges.ts

@@ -0,0 +1,49 @@
+// src/api/payPlanCharges.ts
+import HttpClient from "../utils/httpClient";
+import { PayPlanCharge } from "../types/payPlanChargeTypes";
+
+/** Utility to remove undefined fields from objects (for API payloads) */
+const clean = (obj: Record<string, any>): Record<string, any> => {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_, v]) => v !== undefined)
+  );
+};
+
+export default class PayPlanCharges {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch all payment plan charges for a specified payment plan.
+   * Mirrors GET /payplancharges
+   * Added in version 23.2.28
+   *
+   * @see https://www.opendental.com/site/apipayplancharges.html
+   * @param params - Query parameters: { PayPlanNum: number } (required)
+   */
+  public async getPayPlanCharges(
+    params: { PayPlanNum: number }
+  ): Promise<PayPlanCharge[]> {
+    // Validate required parameter
+    if (!params || typeof params !== "object") {
+      throw new Error(
+        "Invalid parameters: getPayPlanCharges requires a params object."
+      );
+    }
+
+    if (!params.PayPlanNum || typeof params.PayPlanNum !== "number") {
+      throw new Error(
+        "Invalid parameter: PayPlanNum is required and must be a number."
+      );
+    }
+
+    const query = clean({
+      PayPlanNum: params.PayPlanNum,
+    });
+
+    return this.httpClient.get<PayPlanCharge[]>("/payplancharges", query);
+  }
+}

package/src/api/payPlans.ts

@@ -0,0 +1,274 @@
+// src/api/payPlans.ts
+import HttpClient from "../utils/httpClient";
+import {
+  PayPlan,
+  GetPayPlanByIdParams,
+  CreateDynamicPayPlanParams,
+  CreatePayPlanParams,
+  ClosePayPlanParams,
+  UpdateDynamicPayPlanParams,
+} from "../types/payPlanTypes";
+
+/** Utility to remove undefined fields from objects (for API payloads) */
+const clean = (obj: Record<string, any>): Record<string, any> => {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_, v]) => v !== undefined)
+  );
+};
+
+export default class PayPlans {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch multiple payment plans with filtering by PatNum or Guarantor.
+   * Mirrors GET /payplans
+   * @see https://www.opendental.com/site/apipayplans.html
+   * @param params - Query parameters: { PatNum: number } OR { Guarantor: number } (mutually exclusive, one required)
+   */
+  public async getPayPlans(params: { PatNum: number; Guarantor?: never } | { Guarantor: number; PatNum?: never }): Promise<PayPlan[]> {
+    // API requires either PatNum OR Guarantor, not both
+    if ('PatNum' in params && 'Guarantor' in params && params.PatNum && params.Guarantor) {
+      throw new Error(
+        "Invalid parameters: PatNum and Guarantor are mutually exclusive. Provide only one."
+      );
+    }
+
+    if (!('PatNum' in params) && !('Guarantor' in params)) {
+      throw new Error(
+        "Invalid parameters: Either PatNum or Guarantor is required."
+      );
+    }
+
+    const query = clean({
+      PatNum: 'PatNum' in params ? params.PatNum : undefined,
+      Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
+    });
+
+    return this.httpClient.get<PayPlan[]>("/payplans", query);
+  }
+
+  /**
+   * Fetch a single payment plan by PayPlanNum.
+   * Mirrors GET /payplans/{PayPlanNum}
+   * Added in version 24.4.30
+   */
+  public async getPayPlan({
+    PayPlanNum,
+  }: GetPayPlanByIdParams): Promise<PayPlan> {
+    if (!PayPlanNum || typeof PayPlanNum !== "number") {
+      throw new Error("Invalid parameter: PayPlanNum must be a valid number.");
+    }
+    return this.httpClient.get<PayPlan>(`/payplans/${PayPlanNum}`);
+  }
+
+  /**
+   * Create a new dynamic payment plan.
+   * Mirrors POST /payplans/Dynamic
+   * Added in version 22.2.22
+   *
+   * Required:
+   *  - PatNum
+   *  - PayAmt OR NumberOfPayments
+   *  - procNums and/or adjNums (at least one must have items)
+   *
+   * Note: If APR > 0, IsLocked may be required to be true (depending on preferences)
+   */
+  public async createDynamicPayPlan(
+    data: CreateDynamicPayPlanParams
+  ): Promise<PayPlan> {
+    // Validate required fields
+    if (!data || typeof data !== "object") {
+      throw new Error(
+        "Invalid payload: createDynamicPayPlan requires a request body."
+      );
+    }
+
+    if (!data.PatNum || typeof data.PatNum !== "number") {
+      throw new Error(
+        "Invalid payload: PatNum is required and must be a number."
+      );
+    }
+
+    // Either PayAmt OR NumberOfPayments is required
+    if (!data.PayAmt && !data.NumberOfPayments) {
+      throw new Error(
+        "Invalid payload: Either PayAmt or NumberOfPayments is required."
+      );
+    }
+
+    // At least one of procNums or adjNums must be provided and non-empty
+    const hasProcNums = Array.isArray(data.procNums) && data.procNums.length > 0;
+    const hasAdjNums = Array.isArray(data.adjNums) && data.adjNums.length > 0;
+
+    if (!hasProcNums && !hasAdjNums) {
+      throw new Error(
+        "Invalid payload: At least one of procNums or adjNums must be a non-empty array."
+      );
+    }
+
+    // Validate APR and IsLocked relationship
+    if (data.APR && data.APR > 0 && data.IsLocked === false) {
+      console.warn(
+        "Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences."
+      );
+    }
+
+    const payload = clean({
+      PatNum: data.PatNum,
+      PayAmt: data.PayAmt,
+      NumberOfPayments: data.NumberOfPayments,
+      procNums: data.procNums,
+      adjNums: data.adjNums,
+      Guarantor: data.Guarantor,
+      PayPlanDate: data.PayPlanDate,
+      APR: data.APR,
+      DownPayment: data.DownPayment,
+      Note: data.Note,
+      PlanCategory: data.PlanCategory,
+      ChargeFrequency: data.ChargeFrequency,
+      DatePayPlanStart: data.DatePayPlanStart,
+      DateInterestStart: data.DateInterestStart,
+      IsLocked: data.IsLocked,
+      DynamicPayPlanTPOption: data.DynamicPayPlanTPOption,
+    });
+
+    return this.httpClient.post<PayPlan>("/payplans/Dynamic", payload);
+  }
+
+  /**
+   * Create a patient payment plan (DEPRECATED as of 23.3.1).
+   * Mirrors POST /payplans
+   * Added in version 22.4.39, deprecated in 23.3.1
+   *
+   * @deprecated Use createDynamicPayPlan instead. This endpoint returns 410 Gone in newer versions.
+   *
+   * Required:
+   *  - PatNum
+   *  - useEstBalance OR principalAmount
+   *  - PayAmt OR NumberOfPayments
+   */
+  public async createPayPlan(data: CreatePayPlanParams): Promise<PayPlan> {
+    console.warn(
+      "Warning: createPayPlan is deprecated as of version 23.3.1. Use createDynamicPayPlan instead."
+    );
+
+    // Validate required fields
+    if (!data || typeof data !== "object") {
+      throw new Error(
+        "Invalid payload: createPayPlan requires a request body."
+      );
+    }
+
+    if (!data.PatNum || typeof data.PatNum !== "number") {
+      throw new Error(
+        "Invalid payload: PatNum is required and must be a number."
+      );
+    }
+
+    // Either useEstBalance OR principalAmount is required
+    if (
+      data.useEstBalance === undefined &&
+      data.principalAmount === undefined
+    ) {
+      throw new Error(
+        "Invalid payload: Either useEstBalance or principalAmount is required."
+      );
+    }
+
+    // Either PayAmt OR NumberOfPayments is required
+    if (!data.PayAmt && !data.NumberOfPayments) {
+      throw new Error(
+        "Invalid payload: Either PayAmt or NumberOfPayments is required."
+      );
+    }
+
+    const payload = clean({
+      PatNum: data.PatNum,
+      useEstBalance: data.useEstBalance,
+      principalAmount: data.principalAmount,
+      PayAmt: data.PayAmt,
+      NumberOfPayments: data.NumberOfPayments,
+      Guarantor: data.Guarantor,
+      PayPlanDate: data.PayPlanDate,
+      APR: data.APR,
+      DownPayment: data.DownPayment,
+      Note: data.Note,
+      PlanCategory: data.PlanCategory,
+      ChargeFrequency: data.ChargeFrequency,
+      DatePayPlanStart: data.DatePayPlanStart,
+      DateInterestStart: data.DateInterestStart,
+    });
+
+    return this.httpClient.post<PayPlan>("/payplans", payload);
+  }
+
+  /**
+   * Close a payment plan and charge any outstanding interest.
+   * Mirrors PUT /payplans/{PayPlanNum}/Close
+   * Added in version 22.4.39
+   */
+  public async closePayPlan({
+    PayPlanNum,
+  }: ClosePayPlanParams): Promise<PayPlan> {
+    if (!PayPlanNum || typeof PayPlanNum !== "number") {
+      throw new Error(
+        "Invalid parameter: PayPlanNum is required and must be a number."
+      );
+    }
+
+    return this.httpClient.put<PayPlan>(
+      `/payplans/${PayPlanNum}/Close`,
+      {}
+    );
+  }
+
+  /**
+   * Update an existing dynamic payment plan.
+   * Mirrors PUT /payplans/{PayPlanNum}/Dynamic
+   * Added in version 25.3.31
+   *
+   * All fields except PayPlanNum are optional; send only what you intend to change.
+   */
+  public async updateDynamicPayPlan(
+    data: UpdateDynamicPayPlanParams
+  ): Promise<PayPlan> {
+    if (!data?.PayPlanNum || typeof data.PayPlanNum !== "number") {
+      throw new Error(
+        "Invalid payload: PayPlanNum is required and must be a number."
+      );
+    }
+
+    // Validate APR and IsLocked relationship
+    if (data.APR && data.APR > 0 && data.IsLocked === false) {
+      console.warn(
+        "Warning: When APR > 0, IsLocked may need to be true depending on Open Dental preferences."
+      );
+    }
+
+    const { PayPlanNum, ...updateFields } = data;
+
+    const payload = clean({
+      PayAmt: updateFields.PayAmt,
+      NumberOfPayments: updateFields.NumberOfPayments,
+      Guarantor: updateFields.Guarantor,
+      PayPlanDate: updateFields.PayPlanDate,
+      APR: updateFields.APR,
+      Note: updateFields.Note,
+      PlanCategory: updateFields.PlanCategory,
+      ChargeFrequency: updateFields.ChargeFrequency,
+      DatePayPlanStart: updateFields.DatePayPlanStart,
+      DateInterestStart: updateFields.DateInterestStart,
+      IsLocked: updateFields.IsLocked,
+      SheetDefNum: updateFields.SheetDefNum,
+    });
+
+    return this.httpClient.put<PayPlan>(
+      `/payplans/${PayPlanNum}/Dynamic`,
+      payload
+    );
+  }
+}

package/src/openDental.ts

@@ -13,6 +13,8 @@ import Providers from "./api/providers";
 import Operatories from "./api/operatories";
 import Payments from "./api/payments";
 import PaySplits from "./api/paySplits";
+import PayPlans from "./api/payPlans";
+import PayPlanCharges from "./api/payPlanCharges";
 import Definitions from "./api/definitions";
 import DiscountPlans from "./api/discountPlans";
 import DiscountPlanSubs from "./api/discountPlanSubs";
@@ -350,6 +352,26 @@ class OpenDental {
     return new PaySplits(this.httpClient);
   }
 
+  /**
+   * Create a new instance of the PayPlans API.
+   */
+  public static PayPlans() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new PayPlans(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the PayPlanCharges API.
+   */
+  public static PayPlanCharges() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new PayPlanCharges(this.httpClient);
+  }
+
   /**
    * Create a new instance of the Fees API.
    */

package/src/types/payPlanChargeTypes.ts

@@ -0,0 +1,77 @@
+/**
+ * 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

@@ -0,0 +1,171 @@
+/**
+ * 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;