@rinse-dental/open-dental 3.3.0 → 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

@@ -1,5 +1,5 @@
 import HttpClient from "../utils/httpClient";
-import { PayPlan, GetPayPlansParams, GetPayPlanByIdParams, CreateDynamicPayPlanParams, CreatePayPlanParams, ClosePayPlanParams, UpdateDynamicPayPlanParams } from "../types/payPlanTypes";
+import { PayPlan, GetPayPlanByIdParams, CreateDynamicPayPlanParams, CreatePayPlanParams, ClosePayPlanParams, UpdateDynamicPayPlanParams } from "../types/payPlanTypes";
 export default class PayPlans {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -7,8 +7,15 @@ export default class PayPlans {
      * 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?: GetPayPlansParams): Promise<PayPlan[]>;
+    getPayPlans(params: {
+        PatNum: number;
+        Guarantor?: never;
+    } | {
+        Guarantor: number;
+        PatNum?: never;
+    }): Promise<PayPlan[]>;
     /**
      * Fetch a single payment plan by PayPlanNum.
      * Mirrors GET /payplans/{PayPlanNum}

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

@@ -1 +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,iBAAiB,EACjB,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;;;;OAIG;IACU,WAAW,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsB5E;;;;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"}
+{"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

@@ -13,18 +13,19 @@ class PayPlans {
      * 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 = {}) {
+    async getPayPlans(params) {
         // API requires either PatNum OR Guarantor, not both
-        if (params.PatNum && params.Guarantor) {
+        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 (!params.PatNum && !params.Guarantor) {
+        if (!('PatNum' in params) && !('Guarantor' in params)) {
             throw new Error("Invalid parameters: Either PatNum or Guarantor is required.");
         }
         const query = clean({
-            PatNum: params.PatNum,
-            Guarantor: params.Guarantor,
+            PatNum: 'PatNum' in params ? params.PatNum : undefined,
+            Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
         });
         return this.httpClient.get("/payplans", query);
     }

package/dist/openDental.d.ts

@@ -13,6 +13,7 @@ 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";
@@ -166,6 +167,10 @@ declare class OpenDental {
      * 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,QAAQ,MAAM,gBAAgB,CAAC;AACtC,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,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

@@ -53,6 +53,7 @@ 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"));
@@ -363,6 +364,15 @@ class OpenDental {
         }
         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/package.json

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

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

@@ -2,7 +2,6 @@
 import HttpClient from "../utils/httpClient";
 import {
   PayPlan,
-  GetPayPlansParams,
   GetPayPlanByIdParams,
   CreateDynamicPayPlanParams,
   CreatePayPlanParams,
@@ -28,24 +27,25 @@ export default class PayPlans {
    * 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: GetPayPlansParams = {}): Promise<PayPlan[]> {
+  public async getPayPlans(params: { PatNum: number; Guarantor?: never } | { Guarantor: number; PatNum?: never }): Promise<PayPlan[]> {
     // API requires either PatNum OR Guarantor, not both
-    if (params.PatNum && params.Guarantor) {
+    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 (!params.PatNum && !params.Guarantor) {
+    if (!('PatNum' in params) && !('Guarantor' in params)) {
       throw new Error(
         "Invalid parameters: Either PatNum or Guarantor is required."
       );
     }
 
     const query = clean({
-      PatNum: params.PatNum,
-      Guarantor: params.Guarantor,
+      PatNum: 'PatNum' in params ? params.PatNum : undefined,
+      Guarantor: 'Guarantor' in params ? params.Guarantor : undefined,
     });
 
     return this.httpClient.get<PayPlan[]>("/payplans", query);

package/src/openDental.ts

@@ -14,6 +14,7 @@ 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";
@@ -361,6 +362,16 @@ class OpenDental {
     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;