@rinse-dental/open-dental 3.4.2 → 4.0.2

package/dist/types/userGroupTypes.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A single user group record.
+ * @see https://www.opendental.com/site/apiusergroups.html
+ */
+export interface UserGroupItem {
+    UserGroupNum?: number;
+    Description?: string;
+    UserGroupNumCEMT?: number;
+}
+/**
+ * Query parameters for GET /usergroups (list).
+ * @see https://www.opendental.com/site/apiusergroups.html
+ */
+export interface GetUserGroupsParams {
+    includeCEMT?: string;
+    Offset?: number;
+    Limit?: number;
+    DateFormatString?: string;
+    DateTimeFormatString?: string;
+}
+//# sourceMappingURL=userGroupTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userGroupTypes.d.ts","sourceRoot":"","sources":["../../src/types/userGroupTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B"}

package/dist/types/userGroupTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/userODTypes.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Represents an Open Dental user account.
+ * UserNum is permanent and never changes — it is the permanent audit trail identifier.
+ * Users are separate entities from Providers and Employees (but may be linked to either).
+ * @see https://www.opendental.com/site/apiuserods.html
+ */
+export interface UserODItem {
+    UserNum: number;
+    UserName: string;
+    userGroupNums: number[];
+    /** FK to employee.EmployeeNum. 0 if user is not linked to an employee. */
+    EmployeeNum: number;
+    /** Employee first and last name. Blank if not linked to an employee. */
+    employeeName: string;
+    /** FK to provider.ProvNum. 0 if user is not linked to a provider. */
+    ProviderNum: number;
+    /** Full provider name with suffix. Blank if not linked to a provider. */
+    providerName: string;
+    /**
+     * FK to clinic.ClinicNum. Default clinic for this user.
+     * 0 = no default clinic, or defaults to HQ when clinics are enabled.
+     */
+    ClinicNum: number;
+    emailAddress: string;
+    /**
+     * Whether the user is hidden from the login list.
+     * Returned as string "true" or "false" (not a boolean).
+     */
+    IsHidden: "true" | "false";
+    /**
+     * FK to userod.UserNum in the Central Manager (CEMT) database.
+     * Only editable via CEMT — cannot be changed through this API.
+     */
+    UserNumCEMT: number;
+    /**
+     * Whether the user must reset their password on next login.
+     * Returned as string "true" or "false" (not a boolean).
+     */
+    IsPasswordResetRequired: "true" | "false";
+}
+/** @see https://www.opendental.com/site/apiuserods.html */
+export interface GetUserODsParams {
+    /**
+     * Optional. "true" returns hidden users alongside visible ones.
+     * Default: "false". Added v22.4.24.
+     */
+    includeHidden?: "true" | "false";
+    /**
+     * Optional. "true" returns CEMT-designated users.
+     * Default: "false". Added v25.1.10.
+     */
+    includeCEMT?: "true" | "false";
+    Offset?: number;
+    Limit?: number;
+    DateFormatString?: string;
+    DateTimeFormatString?: string;
+}
+/** @see https://www.opendental.com/site/apiuserods.html */
+export interface CreateUserODParams {
+    /**
+     * Required. Must be unique. Cannot end with whitespace.
+     */
+    UserName: string;
+    /** Required. FK to usergroup.UserGroupNum. Obtain via UserGroups GET endpoint. */
+    UserGroupNum: number;
+    /**
+     * Required. Minimum 8 characters with at least one number, one uppercase letter,
+     * and one lowercase letter. Special characters required if office PasswordStrength preference is enabled.
+     */
+    Password: string;
+    /**
+     * Optional. "true" or "false". Defaults to "false".
+     * Forces the user to reset their password on first login.
+     */
+    IsPasswordResetRequired?: "true" | "false";
+}
+/** @see https://www.opendental.com/site/apiuserods.html */
+export interface UpdateUserODParams {
+    /** Required. Primary key of the user to update (passed in URL path). */
+    UserNum: number;
+    /**
+     * Optional. Array of UserGroupNum integers, e.g. [1, 2, 3].
+     * Replaces ALL existing group memberships — not additive. Added v25.1.10.
+     */
+    userGroupNums?: number[];
+    /** Optional. FK to employee.EmployeeNum — associates this user with an employee. */
+    EmployeeNum?: number;
+    /** Optional. FK to provider.ProvNum — associates this user with a provider. */
+    ProviderNum?: number;
+    /** Optional. FK to clinic.ClinicNum — sets the default clinic for this user. */
+    ClinicNum?: number;
+    /** Optional. "true" or "false" — hides or shows the user in the login list. */
+    IsHidden?: "true" | "false";
+    /** Optional. "true" or "false". Added v25.1.10. */
+    IsPasswordResetRequired?: "true" | "false";
+}
+//# sourceMappingURL=userODTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userODTypes.d.ts","sourceRoot":"","sources":["../../src/types/userODTypes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,0EAA0E;IAC1E,WAAW,EAAE,MAAM,CAAC;IACpB,wEAAwE;IACxE,YAAY,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,uBAAuB,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3C;AAED,2DAA2D;AAC3D,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5C;AAED,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,mDAAmD;IACnD,uBAAuB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5C"}

package/dist/types/userODTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/errorHandler.d.ts

@@ -1 +1,6 @@
+/**
+ * Formats an unknown error into a consistent Error instance.
+ * Used across the SDK to normalise thrown values.
+ */
+export declare function toError(err: unknown): Error;
 //# sourceMappingURL=errorHandler.d.ts.map

package/dist/utils/errorHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utils/errorHandler.ts"],"names":[],"mappings":""}
+{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utils/errorHandler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,CAG3C"}

package/dist/utils/errorHandler.js

@@ -1 +1,12 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toError = toError;
+/**
+ * Formats an unknown error into a consistent Error instance.
+ * Used across the SDK to normalise thrown values.
+ */
+function toError(err) {
+    if (err instanceof Error)
+        return err;
+    return new Error(typeof err === "string" ? err : JSON.stringify(err));
+}

package/dist/utils/httpClient.d.ts

@@ -1,6 +1,22 @@
+export interface HttpClientOptions {
+    /**
+     * Request timeout in milliseconds. Defaults to 30000 (30 seconds).
+     * Set to 0 to disable the timeout entirely.
+     */
+    timeout?: number;
+    /**
+     * Enable debug logging. When true, failed requests log the HTTP method,
+     * endpoint path (query parameters stripped), and status code to console.error.
+     * Response bodies, request payloads, and headers are never logged regardless
+     * of this setting, to prevent PHI from appearing in log output.
+     * Defaults to false.
+     */
+    debug?: boolean;
+}
 declare class HttpClient {
     private client;
-    constructor(baseURL: string, authToken: string);
+    private debug;
+    constructor(baseURL: string, authToken: string, options?: HttpClientOptions);
     /**
      * GET request
      * @param {string} url - The endpoint URL
@@ -31,14 +47,16 @@ declare class HttpClient {
     /**
      * Handles requests and errors consistently across methods.
      * @param {Function} requestFn - The Axios request function to execute.
-     * @returns {Promise<T>} - The API response or an error message.
-     * @throws {Error} - Throws an error with a formatted message.
+     * @returns {Promise<T>} - The API response.
+     * @throws {Error} - Throws a formatted error on failure.
      */
     private handleRequest;
     /**
-     * Error handler to provide detailed error information.
-     * @param {unknown} error - The error object from Axios or another source.
-     * @throws {Error} - A formatted error with API details or a general message.
+     * Formats and throws errors from failed requests.
+     * Never logs response bodies, payloads, or headers — only method, path, and
+     * status code when debug mode is enabled.
+     * @param {unknown} error - The caught error.
+     * @throws {Error} - Always throws.
      */
     private handleError;
 }

package/dist/utils/httpClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpClient.d.ts","sourceRoot":"","sources":["../../src/utils/httpClient.ts"],"names":[],"mappings":"AAEA,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAgB;gBAElB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAU9C;;;;;OAKG;IACU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7D;;;;;OAKG;IACU,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI3D;;;;;OAKG;IACU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI1D;;;;OAIG;IACU,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/C;;;;;OAKG;YACW,aAAa;IAS3B;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAkCpB;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"httpClient.d.ts","sourceRoot":"","sources":["../../src/utils/httpClient.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,KAAK,CAAU;gBAEX,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB;IAc/E;;;;;OAKG;IACU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7D;;;;;OAKG;IACU,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI3D;;;;;OAKG;IACU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI1D;;;;OAIG;IACU,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/C;;;;;OAKG;YACW,aAAa;IAS3B;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAgCpB;AAED,eAAe,UAAU,CAAC"}

package/dist/utils/httpClient.js

@@ -6,9 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 class HttpClient {
     client;
-    constructor(baseURL, authToken) {
+    debug;
+    constructor(baseURL, authToken, options = {}) {
+        const { timeout = 30_000, debug = false } = options;
+        this.debug = debug;
         this.client = axios_1.default.create({
             baseURL,
+            timeout,
             headers: {
                 Authorization: authToken,
                 "Content-Type": "application/json",
@@ -53,8 +57,8 @@ class HttpClient {
     /**
      * Handles requests and errors consistently across methods.
      * @param {Function} requestFn - The Axios request function to execute.
-     * @returns {Promise<T>} - The API response or an error message.
-     * @throws {Error} - Throws an error with a formatted message.
+     * @returns {Promise<T>} - The API response.
+     * @throws {Error} - Throws a formatted error on failure.
      */
     async handleRequest(requestFn) {
         try {
@@ -66,42 +70,42 @@ class HttpClient {
         }
     }
     /**
-     * Error handler to provide detailed error information.
-     * @param {unknown} error - The error object from Axios or another source.
-     * @throws {Error} - A formatted error with API details or a general message.
+     * Formats and throws errors from failed requests.
+     * Never logs response bodies, payloads, or headers — only method, path, and
+     * status code when debug mode is enabled.
+     * @param {unknown} error - The caught error.
+     * @throws {Error} - Always throws.
      */
     handleError(error) {
         if (axios_1.default.isAxiosError(error)) {
             if (error.response) {
-                // The server responded with a status code outside 2xx
                 const { status, data } = error.response;
-                // Only log if not 404
-                if (status !== 404) {
-                    console.error("API Response Error:", {
-                        status,
-                        data,
-                        headers: error.response.headers,
-                    });
+                const message = data?.message ?? JSON.stringify(data);
+                if (this.debug) {
+                    // Strip query params so PatNums and other identifiers are not logged.
+                    const method = (error.config?.method ?? "UNKNOWN").toUpperCase();
+                    const safePath = (error.config?.url ?? "unknown").split("?")[0];
+                    console.error(`[OpenDental] ${method} ${safePath} → ${status}`);
                 }
-                throw error.response;
-                /*throw new Error(
-                  `API Error (Status ${status}): ${data?.message || JSON.stringify(data)}`
-                );*/
+                throw new Error(`API Error (Status ${status}): ${message}`);
             }
             else if (error.request) {
-                // The request was made, but no response received
-                console.error("No Response Error:", error.request);
+                if (this.debug) {
+                    console.error("[OpenDental] No response received from server — request timed out or server is unreachable.");
+                }
                 throw new Error("No response received from the server.");
             }
             else {
-                // Something went wrong in setting up the request
-                console.error("Request Setup Error:", error.message);
+                if (this.debug) {
+                    console.error("[OpenDental] Request setup error:", error.message);
+                }
                 throw new Error(`Request setup failed: ${error.message}`);
             }
         }
         else {
-            // Handle non-Axios-specific errors
-            console.error("Unexpected Error:", error);
+            if (this.debug) {
+                console.error("[OpenDental] Unexpected non-HTTP error.");
+            }
             throw new Error("An unexpected error occurred.");
         }
     }

package/docs/Open Dental 2026-04-22/api-url-list.md

@@ -0,0 +1,110 @@
+# Open Dental API URLs — Evaluation List
+**Date:** 2026-04-22  
+**Source:** https://www.opendental.com/sitemap.xml  
+**Excluded:** apisetup, apideveloperportal, apipermissions, apilocal
+
+---
+
+1. https://www.opendental.com/site/apiaccountmodules.html
+2. https://www.opendental.com/site/apiadjustments.html
+3. https://www.opendental.com/site/apiallergies.html
+4. https://www.opendental.com/site/apiallergydefs.html
+5. https://www.opendental.com/site/apiappointments.html
+6. https://www.opendental.com/site/apiappointmenttypes.html
+7. https://www.opendental.com/site/apiapptfielddefs.html
+8. https://www.opendental.com/site/apiapptfields.html
+9. https://www.opendental.com/site/apiautonotecontrols.html
+10. https://www.opendental.com/site/apiautonotes.html
+11. https://www.opendental.com/site/apibenefits.html
+12. https://www.opendental.com/site/apicarriers.html
+13. https://www.opendental.com/site/apichartmodules.html
+14. https://www.opendental.com/site/apiclaimpayments.html
+15. https://www.opendental.com/site/apiclaimprocs.html
+16. https://www.opendental.com/site/apiclaims.html
+17. https://www.opendental.com/site/apiclaimtrackings.html
+18. https://www.opendental.com/site/apiclinics.html
+19. https://www.opendental.com/site/apicommlogs.html
+20. https://www.opendental.com/site/apicomputers.html
+21. https://www.opendental.com/site/apidefinitions.html
+22. https://www.opendental.com/site/apidiscountplans.html
+23. https://www.opendental.com/site/apidiscountplansubs.html
+24. https://www.opendental.com/site/apidiseasedefs.html
+25. https://www.opendental.com/site/apidiseases.html
+26. https://www.opendental.com/site/apidocuments.html
+27. https://www.opendental.com/site/apiemployers.html
+28. https://www.opendental.com/site/apietrans.html
+29. https://www.opendental.com/site/apietransmessagetexts.html
+30. https://www.opendental.com/site/apietranss.html
+31. https://www.opendental.com/site/apievents.html
+32. https://www.opendental.com/site/apifamilymodules.html
+33. https://www.opendental.com/site/apifeescheds.html
+34. https://www.opendental.com/site/apihistappointments.html
+35. https://www.opendental.com/site/apiimplementation.html
+36. https://www.opendental.com/site/apiinsplans.html
+37. https://www.opendental.com/site/apiinssubs.html
+38. https://www.opendental.com/site/apiinsverifies.html
+39. https://www.opendental.com/site/apimedicationpats.html
+40. https://www.opendental.com/site/apimedications.html
+41. https://www.opendental.com/site/apioperatories.html
+42. https://www.opendental.com/site/apipatfielddefs.html
+43. https://www.opendental.com/site/apipatfields.html
+44. https://www.opendental.com/site/apipatientnotes.html
+45. https://www.opendental.com/site/apipatientraces.html
+46. https://www.opendental.com/site/apipatients.html
+47. https://www.opendental.com/site/apipatplans.html
+48. https://www.opendental.com/site/apipayments.html
+49. https://www.opendental.com/site/apipayplans.html
+50. https://www.opendental.com/site/apipaysplits.html
+51. https://www.opendental.com/site/apiperioexams.html
+52. https://www.opendental.com/site/apiperiomeasures.html
+53. https://www.opendental.com/site/apipopups.html
+54. https://www.opendental.com/site/apipreferences.html
+55. https://www.opendental.com/site/apiprocedurecodes.html
+56. https://www.opendental.com/site/apiprocedurelogs.html
+57. https://www.opendental.com/site/apiprocnotes.html
+58. https://www.opendental.com/site/apiproctps.html
+59. https://www.opendental.com/site/apiproviders.html
+60. https://www.opendental.com/site/apiqueries.html
+61. https://www.opendental.com/site/apiquickpastecats.html
+62. https://www.opendental.com/site/apiquickpastenotes.html
+63. https://www.opendental.com/site/apirecalls.html
+64. https://www.opendental.com/site/apirefattaches.html
+65. https://www.opendental.com/site/apireferrals.html
+66. https://www.opendental.com/site/apireports.html
+67. https://www.opendental.com/site/apischedules.html
+68. https://www.opendental.com/site/apisecurity.html
+69. https://www.opendental.com/site/apisecuritylogs.html
+70. https://www.opendental.com/site/apisheetdefs.html
+71. https://www.opendental.com/site/apisheetfields.html
+72. https://www.opendental.com/site/apisheets.html
+73. https://www.opendental.com/site/apisignalods.html
+74. https://www.opendental.com/site/apispecification.html
+75. https://www.opendental.com/site/apisubscriptions.html
+76. https://www.opendental.com/site/apisubstitutionlinks.html
+77. https://www.opendental.com/site/apitasklists.html
+78. https://www.opendental.com/site/apitasks.html
+79. https://www.opendental.com/site/apitreatplanattaches.html
+80. https://www.opendental.com/site/apitreatplans.html
+81. https://www.opendental.com/site/apiuserods.html
+82. https://www.opendental.com/site/apifees.html
+83. https://www.opendental.com/site/apilabcases.html
+84. https://www.opendental.com/site/apipayplancharges.html
+85. https://www.opendental.com/site/apicodegroups.html
+86. https://www.opendental.com/site/apicovcats.html
+87. https://www.opendental.com/site/apiasapcomms.html
+88. https://www.opendental.com/site/apiclockevents.html
+89. https://www.opendental.com/site/apicovspans.html
+90. https://www.opendental.com/site/apiehrpatients.html
+91. https://www.opendental.com/site/apiemployees.html
+92. https://www.opendental.com/site/apieobattaches.html
+93. https://www.opendental.com/site/apilaboratories.html
+94. https://www.opendental.com/site/apilabturnarounds.html
+95. https://www.opendental.com/site/apipharmacies.html
+96. https://www.opendental.com/site/apirecalltypes.html
+97. https://www.opendental.com/site/apirxpats.html
+98. https://www.opendental.com/site/apischeduleops.html
+99. https://www.opendental.com/site/apistatements.html
+100. https://www.opendental.com/site/apitasknotes.html
+101. https://www.opendental.com/site/apitoothinitials.html
+102. https://www.opendental.com/site/apiusergroupattaches.html
+103. https://www.opendental.com/site/apiusergroups.html

package/docs/Open Dental 2026-04-22/apiaccountmodules.md

@@ -0,0 +1,116 @@
+# API: AccountModules
+
+**Source:** https://www.opendental.com/site/apiaccountmodules.html  
+**Extracted:** 2026-04-22  
+**Base Path:** `/accountmodules`
+
+---
+
+## Endpoints
+
+### GET /accountmodules/{PatNum}/Aging
+
+**Version:** 22.3.6  
+**Description:** Returns aged balance and insurance estimate data for a patient's family account.
+
+**Path Parameters:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | yes | Patient number |
+
+**Response Fields (object):**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| Bal_0_30 | decimal | Aged balance 0–30 days |
+| Bal_31_60 | decimal | Aged balance 31–60 days |
+| Bal_61_90 | decimal | Aged balance 61–90 days |
+| BalOver90 | decimal | Aged balance over 90 days |
+| Total | decimal | Total family balance before insurance |
+| InsEst | decimal | Insurance estimate for the family |
+| EstBal | decimal | Remaining balance after insurance and write-offs |
+| PatEstBal | decimal | Patient balance after deductions |
+| Unearned | decimal | Prepayment / unearned balance |
+
+**Status Codes:**
+
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### GET /accountmodules/{PatNum}/PatientBalances
+
+**Version:** 22.1  
+**Description:** Returns a list of balances for each member of a patient's family, plus an "Entire Family" summary row.
+
+**Path Parameters:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | yes | Patient number |
+
+**Response Fields (array of objects):**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| PatNum | integer | Patient or guarantor number |
+| Name | string | Patient name, or "Entire Family" for the summary row |
+| Balance | decimal | Account balance |
+
+**Status Codes:**
+
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |
+
+---
+
+### GET /accountmodules/{PatNum}/ServiceDateView
+
+**Version:** 22.3.32  
+**Description:** Returns a chronological list of account transactions (procedures, adjustments, payments, claims, payment plan charges) for a patient or their entire family.
+
+**Path Parameters:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| PatNum | integer | yes | Patient number |
+
+**Query Parameters:**
+
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| isFamily | boolean | no | false | When `true`, returns transactions for all family members |
+
+**Response Fields (array of objects):**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| ObjectType | string | One of: `ProcedureLog`, `Adjustment`, `PaySplit`, `ClaimProc`, `PayPlanCharge`, `PayPlan` |
+| PrimaryKey | string | Primary key of the source object |
+| Type | string | Human-readable transaction type descriptor |
+| ServiceDate | date | Date the service was provided |
+| TransDate | date | Date the transaction was posted |
+| Patient | string | Patient first name |
+| PatNum | string | Patient number |
+| Reference | string | Description of the object |
+| Charge | decimal | Amount charged |
+| Credit | decimal | Amount paid / credited |
+| Provider | string | Provider abbreviation |
+| InsBal | decimal | Insurance payment balance |
+| AcctBal | decimal | Patient portion balance |
+
+**Status Codes:**
+
+| Code | Meaning |
+|------|---------|
+| 200 | OK |
+| 400 | Bad Request |
+| 404 | Not Found |