@rinse-dental/open-dental 1.4.0 → 1.5.1

package/dist/api/adjustments.d.ts

@@ -0,0 +1,48 @@
+import HttpClient from "../utils/httpClient";
+import { Adjustment, GetAdjustmentsParams, CreateAdjustmentParams, UpdateAdjustmentParams } from "../types/adjustmentTypes";
+export default class Adjustments {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+      * Fetch multiple adjustments with filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} params.PatNum - Required. FK to patient.PatNum.
+      * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
+      * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Adjustment[]>} - A list of adjustments.
+      */
+    getAdjustments({ PatNum, AdjType, ProcNum, Offset, }: GetAdjustmentsParams): Promise<Adjustment>;
+    /**
+     * This adds an adjustments to a patient's account.
+     * @param {Object} data - The details of the adjustment to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum
+     * @param {number} data.AdjType - Required. definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+     * @param {number} data.AdjAmt - Required. Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+     * @param {string} data.AdjDate - Required. Cannot be a future date. String in "yyyy-MM-dd" format.
+     * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+     * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+     * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+     * @param {string} [data.ProcDate] - Optional. String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
+     * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+     * @returns {Promise<Adjustment>} - The created adjustment.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createAdjustment({ PatNum, AdjType, AdjAmt, AdjDate, ProvNum, ProcNum, ClinicNum, ProcDate, AdjNote, }: CreateAdjustmentParams): Promise<Adjustment>;
+    /**
+     * Update an adjustment.
+     * @param {Object} data - The details of adjustment to update.
+     * @param {number} data.AdjNum - Required. Primary key.
+     * @param {string} data.AdjDate - Cannot be a future date. String in "yyyy-MM-dd" format.
+     * @param {number} data.AdjAmt - Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+     * @param {number} data.AdjType - definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+     * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+     * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+     * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+     * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+     * @returns {Promise<Adjustment>} - The updated adjustment.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateAdjustment({ AdjNum, AdjDate, AdjAmt, AdjType, ProvNum, AdjNote, ProcNum, ClinicNum, }: UpdateAdjustmentParams): Promise<Adjustment>;
+}
+//# sourceMappingURL=adjustments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adjustments.d.ts","sourceRoot":"","sources":["../../src/api/adjustments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;QAQI;IACS,cAAc,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,OAAO,EACP,MAAM,GAEP,EAAG,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAa9C;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,GACR,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBhD;;;;;;;;;;;;;OAaG;IACU,gBAAgB,CAAC,EAC5B,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,SAAS,GACV,EAAG,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;CAgBjD"}

package/dist/api/adjustments.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Adjustments {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+      * Fetch multiple adjustments with filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} params.PatNum - Required. FK to patient.PatNum.
+      * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
+      * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<Adjustment[]>} - A list of adjustments.
+      */
+    async getAdjustments({ PatNum, AdjType, ProcNum, Offset, }) {
+        if (!PatNum || typeof PatNum !== "number") {
+            throw new Error("Invalid data: A Valid PatNum is required.");
+        }
+        return this.httpClient.get("/adjustments", {
+            PatNum,
+            AdjType,
+            ProcNum,
+            Offset,
+        });
+    }
+    /**
+     * This adds an adjustments to a patient's account.
+     * @param {Object} data - The details of the adjustment to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum
+     * @param {number} data.AdjType - Required. definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+     * @param {number} data.AdjAmt - Required. Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+     * @param {string} data.AdjDate - Required. Cannot be a future date. String in "yyyy-MM-dd" format.
+     * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+     * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+     * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+     * @param {string} [data.ProcDate] - Optional. String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
+     * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+     * @returns {Promise<Adjustment>} - The created adjustment.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createAdjustment({ PatNum, AdjType, AdjAmt, AdjDate, ProvNum, ProcNum, ClinicNum, ProcDate, AdjNote, }) {
+        if (!PatNum || !AdjType || !AdjAmt || !AdjDate) {
+            throw new Error("Invalid data: PatNum, AdjType, AdjAmt, and AdjDate are required.");
+        }
+        return this.httpClient.post("/adjustments", {
+            PatNum,
+            AdjType,
+            AdjAmt,
+            AdjDate,
+            ProvNum,
+            ProcNum,
+            ClinicNum,
+            ProcDate,
+            AdjNote,
+        });
+    }
+    /**
+     * Update an adjustment.
+     * @param {Object} data - The details of adjustment to update.
+     * @param {number} data.AdjNum - Required. Primary key.
+     * @param {string} data.AdjDate - Cannot be a future date. String in "yyyy-MM-dd" format.
+     * @param {number} data.AdjAmt - Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+     * @param {number} data.AdjType - definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+     * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+     * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+     * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+     * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+     * @returns {Promise<Adjustment>} - The updated adjustment.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateAdjustment({ AdjNum, AdjDate, AdjAmt, AdjType, ProvNum, AdjNote, ProcNum, ClinicNum, }) {
+        if (!AdjNum || typeof AdjNum !== "number") {
+            throw new Error("Invalid data: A valid AdjNum is required.");
+        }
+        return this.httpClient.put(`/adjustments/${AdjNum}`, {
+            AdjNum,
+            AdjDate,
+            AdjAmt,
+            AdjType,
+            ProvNum,
+            AdjNote,
+            ProcNum,
+            ClinicNum,
+        });
+    }
+}
+exports.default = Adjustments;

package/dist/openDental.d.ts

@@ -21,6 +21,7 @@ import RefAttaches from "./api/refAttaches";
 import InsPlans from "./api/insPlans";
 import Benefits from "./api/benefits";
 import ClaimProcs from "./api/claimProcs";
+import Adjustments from "./api/adjustments";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -119,6 +120,10 @@ declare class OpenDental {
      * Create a new instance of the ClaimProcs API.
      */
     static ClaimProcs(): ClaimProcs;
+    /**
+     * Create a new instance of the Adjustments API.
+     */
+    static Adjustments(): Adjustments;
 }
 export { OpenDental };
 //# sourceMappingURL=openDental.d.ts.map

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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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,UAAU,MAAM,kBAAkB,CAAC;AAE1C,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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,UAAU;CAMzB;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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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,UAAU;IAOxB;;OAEG;WACW,WAAW;CAM1B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -28,6 +28,7 @@ const refAttaches_1 = __importDefault(require("./api/refAttaches"));
 const insPlans_1 = __importDefault(require("./api/insPlans"));
 const benefits_1 = __importDefault(require("./api/benefits"));
 const claimProcs_1 = __importDefault(require("./api/claimProcs"));
+const adjustments_1 = __importDefault(require("./api/adjustments"));
 class OpenDental {
     static httpClient;
     /**
@@ -248,5 +249,14 @@ class OpenDental {
         }
         return new claimProcs_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the Adjustments API.
+     */
+    static Adjustments() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new adjustments_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/adjustmentTypes.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Represents an InsSub in the Open Dental system. Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.
+ * @see https://www.opendental.com/site/apiadjustments.html
+ */
+export interface Adjustment {
+    AdjNum?: number;
+    AdjDate?: string;
+    AdjAmt?: number;
+    PatNum?: number;
+    AdjType?: number;
+    adjType?: string;
+    ProvNum?: number;
+    AdjNote?: string;
+    ProcDate?: string;
+    ProcNum?: number;
+    DateEntry?: string;
+    ClinicNum?: number;
+    SecUserNumEntry?: number;
+    SecDateTEdit?: string;
+}
+/**
+ * Gets adjustments based on PatNum and provided parameters.
+ * @see https://www.opendental.com/site/apiadjustments.html
+ */
+export interface GetAdjustmentsParams {
+    PatNum: number;
+    AdjType?: number;
+    ProcNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating an adjustment for a patient.
+ * @see https://www.opendental.com/site/apiadjustments.html
+ */
+export interface CreateAdjustmentParams {
+    PatNum: number;
+    AdjType: number;
+    AdjAmt: number;
+    AdjDate: string;
+    ProvNum?: number;
+    ProcNum?: number;
+    ClinicNum?: number;
+    ProcDate?: string;
+    AdjNote?: string;
+}
+/**
+ * Parameters for updating an adjustment for a patient.
+ * @see https://www.opendental.com/site/apiadjustments.html
+ */
+export interface UpdateAdjustmentParams {
+    AdjNum: number;
+    AdjDate?: string;
+    AdjAmt?: number;
+    AdjType?: number;
+    ProvNum?: number;
+    AdjNote?: string;
+    ProcNum?: number;
+    ClinicNum?: number;
+}
+//# sourceMappingURL=adjustmentTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adjustmentTypes.d.ts","sourceRoot":"","sources":["../../src/types/adjustmentTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/adjustmentTypes.js

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

package/package.json

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

package/src/api/adjustments.ts

@@ -0,0 +1,126 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Adjustment,
+  GetAdjustmentsParams,
+  CreateAdjustmentParams,
+  UpdateAdjustmentParams,
+} from "../types/adjustmentTypes";
+
+export default class Adjustments {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple adjustments with filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} params.PatNum - Required. FK to patient.PatNum. 
+    * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
+    * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<Adjustment[]>} - A list of adjustments.
+    */
+  public async getAdjustments({
+    PatNum,
+    AdjType,
+    ProcNum,
+    Offset,
+
+  } : GetAdjustmentsParams): Promise<Adjustment> {
+    if (!PatNum || typeof PatNum !== "number") {
+      throw new Error("Invalid data: A Valid PatNum is required.");
+    }
+
+    return this.httpClient.get<Adjustment>("/adjustments", {
+      PatNum,
+      AdjType,
+      ProcNum,
+      Offset,
+    });
+  }
+
+  /**
+   * This adds an adjustments to a patient's account.
+   * @param {Object} data - The details of the adjustment to create.
+   * @param {number} data.PatNum - Required. FK to patient.PatNum
+   * @param {number} data.AdjType - Required. definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+   * @param {number} data.AdjAmt - Required. Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+   * @param {string} data.AdjDate - Required. Cannot be a future date. String in "yyyy-MM-dd" format.
+   * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+   * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+   * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+   * @param {string} [data.ProcDate] - Optional. String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
+   * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+   * @returns {Promise<Adjustment>} - The created adjustment.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createAdjustment({
+    PatNum,
+    AdjType,
+    AdjAmt,
+    AdjDate,
+    ProvNum,
+    ProcNum,
+    ClinicNum,
+    ProcDate,
+    AdjNote,
+  } : CreateAdjustmentParams): Promise<Adjustment> {
+    if (!PatNum || !AdjType || !AdjAmt || !AdjDate) {
+      throw new Error("Invalid data: PatNum, AdjType, AdjAmt, and AdjDate are required.");
+    }
+
+    return this.httpClient.post<Adjustment>("/adjustments", {
+      PatNum,
+      AdjType,
+      AdjAmt,
+      AdjDate,
+      ProvNum,
+      ProcNum,
+      ClinicNum,
+      ProcDate,
+      AdjNote,
+    });
+  }
+
+  /**
+   * Update an adjustment.
+   * @param {Object} data - The details of adjustment to update.
+   * @param {number} data.AdjNum - Required. Primary key.
+   * @param {string} data.AdjDate - Cannot be a future date. String in "yyyy-MM-dd" format.
+   * @param {number} data.AdjAmt - Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+   * @param {number} data.AdjType - definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+   * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
+   * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
+   * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+   * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
+   * @returns {Promise<Adjustment>} - The updated adjustment.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateAdjustment({
+    AdjNum,
+    AdjDate,
+    AdjAmt,
+    AdjType,
+    ProvNum,
+    AdjNote,
+    ProcNum,
+    ClinicNum,
+  } : UpdateAdjustmentParams): Promise<Adjustment> {
+    if (!AdjNum || typeof AdjNum !== "number") {
+      throw new Error("Invalid data: A valid AdjNum is required.");
+    }
+
+    return this.httpClient.put<Adjustment>(`/adjustments/${AdjNum}`, {
+      AdjNum,
+      AdjDate,
+      AdjAmt,
+      AdjType,
+      ProvNum,
+      AdjNote,
+      ProcNum,
+      ClinicNum,
+    });
+  }
+}

package/src/openDental.ts

@@ -22,6 +22,7 @@ import RefAttaches from "./api/refAttaches";
 import InsPlans from "./api/insPlans";
 import Benefits from "./api/benefits";
 import ClaimProcs from "./api/claimProcs";
+import Adjustments from "./api/adjustments";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -270,6 +271,16 @@ class OpenDental {
     }
     return new ClaimProcs(this.httpClient);
   }
+
+  /**
+   * Create a new instance of the Adjustments API.
+   */
+  public static Adjustments() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Adjustments(this.httpClient);
+  }
 }
 
 export { OpenDental };

package/src/types/adjustmentTypes.ts

@@ -0,0 +1,63 @@
+/**
+ * Represents an InsSub in the Open Dental system. Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.
+ * @see https://www.opendental.com/site/apiadjustments.html
+ */
+export interface Adjustment {
+    AdjNum?: number; // Primary Key
+    AdjDate?: string; // Cannot be a future date. String in "yyyy-MM-dd" format.
+    AdjAmt?: number; // Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+    PatNum?: number; // FK to patient.PatNum
+    AdjType?: number; // definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+    adjType?: string; // definition.ItemName where AdjType == definition.DefNum && definition.Category == 1.
+    ProvNum?: number; // FK to provider.ProvNum
+    AdjNote?: string; // Note for the adjustment.
+    ProcDate?: string; // String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
+    ProcNum?: number; // Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+    DateEntry?: string; // String in "yyyy-MM-dd" format. 
+    ClinicNum?: number; // Default patient.ClinicNum.
+    SecUserNumEntry?: number; //
+    SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  }
+
+  /**
+   * Gets adjustments based on PatNum and provided parameters.
+   * @see https://www.opendental.com/site/apiadjustments.html
+   */
+  export interface GetAdjustmentsParams {
+    PatNum: number; // Required. FK to patient.PatNum
+    AdjType?: number; // Optional. definition.DefNum where definition.Category=1.
+    ProcNum?: number; // Optional. FK to procedure.ProcNum.
+    Offset?: number; // Pagination offset for results.
+  }
+
+  /**
+   * Parameters for creating an adjustment for a patient.
+   * @see https://www.opendental.com/site/apiadjustments.html
+   */
+  export interface CreateAdjustmentParams {
+    PatNum: number; // Required. FK to patient.PatNum
+    AdjType: number; // Required. definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+    AdjAmt: number; // Required. Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+    AdjDate: string; // Required. Cannot be a future date. String in "yyyy-MM-dd" format.
+    ProvNum?: number; // FK to provider.ProvNum
+    ProcNum?: number; // Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+    ClinicNum?: number; // Default patient.ClinicNum.
+    ProcDate?: string; // String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
+    AdjNote?: string; // Note for the adjustment.
+  }
+  
+  /**
+   * Parameters for updating an adjustment for a patient.
+   * @see https://www.opendental.com/site/apiadjustments.html
+   */
+  export interface UpdateAdjustmentParams {
+    AdjNum: number; // Required. Primary Key
+    AdjDate?: string; // Cannot be a future date. String in "yyyy-MM-dd" format.
+    AdjAmt?: number; // Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
+    AdjType?: number; // definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
+    ProvNum?: number; // FK to provider.ProvNum
+    AdjNote?: string; // Note for the adjustment.
+    ProcNum?: number; // Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
+    ClinicNum?: number; // Default patient.ClinicNum.
+  }
+