@rinse-dental/open-dental 0.1.6 → 1.0.0

package/deploy_notes.txt

@@ -1,8 +1,10 @@
 npm run build
-npm version patch //patch, minor, major
-npm pack
+
 git add .
 git commit -m "notes"
+
+npm version patch //patch, minor, major
+npm pack
 git push origin main
 git tag //confirm tag
 git push origin vX.Y.Z

package/dist/api/definitions.d.ts

@@ -0,0 +1,16 @@
+import HttpClient from "../utils/httpClient";
+import { Definition, GetDefinitionsParams } from "../types/definitionTypes";
+export default class Definitions {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple definitinos with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Category] - Filter by category.
+     * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Definition[]>} - A list of appointments.
+     */
+    getDefinitions({ Category, includeHidden, Offset, }?: GetDefinitionsParams): Promise<Definition[]>;
+}
+//# sourceMappingURL=definitions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/api/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;OAOG;IACU,cAAc,CAAC,EACxB,QAAQ,EACR,aAAa,EACb,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CASrD"}

package/dist/api/definitions.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Definitions {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple definitinos with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Category] - Filter by category.
+     * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Definition[]>} - A list of appointments.
+     */
+    async getDefinitions({ Category, includeHidden, Offset, } = {}) {
+        const params = {
+            Category,
+            includeHidden,
+            Offset,
+        };
+        return this.httpClient.get("/definitions", params);
+    }
+}
+exports.default = Definitions;

package/dist/api/discountPlanSubs.d.ts

@@ -0,0 +1,46 @@
+import HttpClient from "../utils/httpClient";
+import { DiscountPlanSub, GetDiscountPlanSubsParams, CreateDiscountPlanSubParams, UpdateDiscountPlanSubParams } from "../types/discountPlanSubTypes";
+export default class DiscountPlanSubs {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple definitinos with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PatNum] - Filter by patient.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<DiscountPlanSub[]>} - A list of appointments.
+     */
+    getDiscountPlanSubs({ PatNum, Offset, }?: GetDiscountPlanSubsParams): Promise<DiscountPlanSub[]>;
+    /**
+     * Create a new discount plan sub.
+     * @param {Object} data - The details of the procedure log to create.
+     * @param {number} data.DiscountPlanNum - Required: FK to discount plan.
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} data.DateEffective - Optional: Patient number.
+     * @param {number} data.DateTerm - Optional: Patient number.
+     * @param {number} data.SubNote - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The created discount plan sub.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createDiscountPlanSub(data: CreateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    /**
+     * Create a new procedure log entry.
+     * @param {Object} data - The details of the procedure log to create.
+     * @param {number} data.DiscountSubNum - Required: PK
+     * @param {number} data.PatNum - Required: Patient number.
+     * @param {number} data.DateEffective - Optional: Patient number.
+     * @param {number} data.DateTerm - Optional: Patient number.
+     * @param {number} data.SubNote - Optional: Patient number.
+     * @returns {Promise<DiscountPlanSub>} - The created procedure log.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateDiscountPlanSub(data: UpdateDiscountPlanSubParams): Promise<DiscountPlanSub>;
+    /**
+     * Delete a discount plan sub entry.
+     * @param {number} DiscountSubNum - Required: The unique identifier of the discount plan sub to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `DiscountSubNum` is not valid or the API returns an error.
+     */
+    deleteDiscountPlanSub(DiscountSubNum: number): Promise<void>;
+}
+//# sourceMappingURL=discountPlanSubs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discountPlanSubs.d.ts","sourceRoot":"","sources":["../../src/api/discountPlanSubs.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,mBAAmB,CAAC,EAC/B,MAAM,EACN,MAAM,GACP,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ/F;;;;;OAKG;IACU,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1E"}

package/dist/api/discountPlanSubs.js

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

package/dist/api/index.d.ts

@@ -6,5 +6,10 @@ export { default as Patients } from "./patients";
 export { default as ProcedureLogs } from "./procedureLog";
 export { default as Recalls } from "./recalls";
 export { default as TreatmentPlans } from "./treatplans";
-export { default as Schedule } from "./schedules";
+export { default as Schedules } from "./schedules";
+export { default as Providers } from "./providers";
+export { default as Operatories } from "./operatories";
+export { default as Payments } from "./payments";
+export { default as Definitions } from "./definitions";
+export { default as DiscountPlanSubs } from "./discountPlanSubs";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/api/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schedule = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
+exports.DiscountPlanSubs = exports.Definitions = exports.Payments = exports.Operatories = exports.Providers = exports.Schedules = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
 var appointments_1 = require("./appointments");
 Object.defineProperty(exports, "Appointments", { enumerable: true, get: function () { return __importDefault(appointments_1).default; } });
 var chartModules_1 = require("./chartModules");
@@ -21,5 +21,15 @@ Object.defineProperty(exports, "Recalls", { enumerable: true, get: function () {
 var treatplans_1 = require("./treatplans");
 Object.defineProperty(exports, "TreatmentPlans", { enumerable: true, get: function () { return __importDefault(treatplans_1).default; } });
 var schedules_1 = require("./schedules");
-Object.defineProperty(exports, "Schedule", { enumerable: true, get: function () { return __importDefault(schedules_1).default; } });
+Object.defineProperty(exports, "Schedules", { enumerable: true, get: function () { return __importDefault(schedules_1).default; } });
+var providers_1 = require("./providers");
+Object.defineProperty(exports, "Providers", { enumerable: true, get: function () { return __importDefault(providers_1).default; } });
+var operatories_1 = require("./operatories");
+Object.defineProperty(exports, "Operatories", { enumerable: true, get: function () { return __importDefault(operatories_1).default; } });
+var payments_1 = require("./payments");
+Object.defineProperty(exports, "Payments", { enumerable: true, get: function () { return __importDefault(payments_1).default; } });
+var definitions_1 = require("./definitions");
+Object.defineProperty(exports, "Definitions", { enumerable: true, get: function () { return __importDefault(definitions_1).default; } });
+var discountPlanSubs_1 = require("./discountPlanSubs");
+Object.defineProperty(exports, "DiscountPlanSubs", { enumerable: true, get: function () { return __importDefault(discountPlanSubs_1).default; } });
 // Add other APIs as needed

package/dist/api/operatories.d.ts

@@ -4,14 +4,14 @@ export default class Operatories {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * Fetch a single patfield by its ID.
+     * Fetch a single operatory by its ID.
      * @param {number} OperatoryNum - The ID of the patfield.
      * @returns {Promise<Operatory>} - The patient data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
-    getPatField(OperatoryNum: number): Promise<Operatory>;
+    getOperatory(OperatoryNum: number): Promise<Operatory>;
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple operatories with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum

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

@@ -1 +1 @@
-{"version":3,"file":"operatories.d.ts","sourceRoot":"","sources":["../../src/api/operatories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,SAAS,EACT,oBAAoB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQlE;;;;;;;OAOG;IACY,cAAc,CAAC,EAC1B,SAAS,EACT,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOtD"}
+{"version":3,"file":"operatories.d.ts","sourceRoot":"","sources":["../../src/api/operatories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,SAAS,EACT,oBAAoB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQnE;;;;;;;OAOG;IACY,cAAc,CAAC,EAC1B,SAAS,EACT,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOtD"}

package/dist/api/operatories.js

@@ -6,19 +6,19 @@ class Operatories {
         this.httpClient = httpClient;
     }
     /**
-     * Fetch a single patfield by its ID.
+     * Fetch a single operatory by its ID.
      * @param {number} OperatoryNum - The ID of the patfield.
      * @returns {Promise<Operatory>} - The patient data.
      * @throws {Error} - If `PatNum` is not valid or the API returns an error.
      */
-    async getPatField(OperatoryNum) {
+    async getOperatory(OperatoryNum) {
         if (!OperatoryNum || typeof OperatoryNum !== "number") {
             throw new Error("Invalid parameter: PatNum must be a valid number.");
         }
         return await this.httpClient.get(`/operatories/${OperatoryNum}`);
     }
     /**
-     * Fetch multiple patients with optional filtering and pagination.
+     * Fetch multiple operatories with optional filtering and pagination.
      * @param {Object} params - Filtering and pagination parameters.
      * @param {string} [params.ClinicNum] - Filter by clinicnum
      * @param {string} [params.Offset] - Filter by clinicnum

package/dist/api/payments.d.ts

@@ -0,0 +1,49 @@
+import HttpClient from "../utils/httpClient";
+import { Payment, GetPaymentsParams, CreatePaymentParams, UpdatePaymentParams } from "../types/paymentTypes";
+export default class Payments {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch multiple payments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
+     * @param {number} [params.PatNum] - FK to patient.PatNum.
+     * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Payment[]>} - A list of payments.
+     */
+    getPayments({ PayType, PatNum, DateEntry, Offset, }?: GetPaymentsParams): Promise<Payment[]>;
+    /**
+     * Create a payment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+     * @param {number} data.PatNum - Required: FK to Patient
+     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+     * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+     * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+     * @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+     * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+     * @returns {Promise<Payment>} - The created payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    createPayment(data: CreatePaymentParams): Promise<Payment>;
+    /**
+     * Update a payment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {string} data.PayNum - Required: PK of Payment to update.
+     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+     * @returns {Promise<Payment>} - The updated payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    updatePayment(data: UpdatePaymentParams): Promise<Payment>;
+}
+//# sourceMappingURL=payments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/api/payments.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIpC;;;;;;;;OAQG;IACU,WAAW,CAAC,EACrB,OAAO,EACP,MAAM,EACN,SAAS,EACT,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAW9C;;;;;;;;;;;;;;;;;OAiBG;IACY,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzE;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAOxE"}

package/dist/api/payments.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Payments {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch multiple payments with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
+     * @param {number} [params.PatNum] - FK to patient.PatNum.
+     * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
+     * @param {number} [params.Offset] - Pagination offset for results.
+     * @returns {Promise<Payment[]>} - A list of payments.
+     */
+    async getPayments({ PayType, PatNum, DateEntry, Offset, } = {}) {
+        const params = {
+            PayType,
+            PatNum,
+            DateEntry,
+            Offset,
+        };
+        return this.httpClient.get("/payments", params);
+    }
+    /**
+     * Create a payment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+     * @param {number} data.PatNum - Required: FK to Patient
+     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+     * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+     * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+     * @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+     * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+     * @returns {Promise<Payment>} - The created payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async createPayment(data) {
+        if (!data.PayAmt || !data.PatNum) {
+            throw new Error("PayAmt and PatNum are required.");
+        }
+        return this.httpClient.post("/payments", data);
+    }
+    /**
+     * Update a payment.
+     * @param {Object} data - Data for the new appointment.
+     * @param {string} data.PayNum - Required: PK of Payment to update.
+     * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+     * @param {string} [data.CheckNum] - Optional.
+     * @param {string} [data.PayNote] - Optional.
+     * @param {string} [data.BankBranch] - Optional.
+     * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+     * @returns {Promise<Payment>} - The updated payment.
+     * @throws {Error} - If required fields are missing.
+     */
+    async updatePayment(data) {
+        if (!data.PayNum) {
+            throw new Error("PayNum is required.");
+        }
+        return this.httpClient.put(`/payments/${data.PayNum}`, data);
+    }
+}
+exports.default = Payments;

package/dist/openDental.d.ts

@@ -9,6 +9,9 @@ import TreatmentPlans from "./api/treatplans";
 import Schedules from "./api/schedules";
 import Providers from "./api/providers";
 import Operatories from "./api/operatories";
+import Payments from "./api/payments";
+import Definitions from "./api/definitions";
+import DiscountPlanSubs from "./api/discountPlanSubs";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -52,13 +55,25 @@ declare class OpenDental {
      */
     static Schedules(): Schedules;
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Providers API.
      */
     static Providers(): Providers;
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Operatories API.
      */
     static Operatories(): Operatories;
+    /**
+     * Create a new instance of the Payments API.
+     */
+    static Payments(): Payments;
+    /**
+     * Create a new instance of the Definitions API.
+     */
+    static Definitions(): Definitions;
+    /**
+     * Create a new instance of the DiscountPlanSubs API.
+     */
+    static DiscountPlanSubs(): DiscountPlanSubs;
 }
 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;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;CAM5B;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;AAEtD,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;IAMzB;;OAEG;WACW,gBAAgB;CAM/B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -16,6 +16,9 @@ const treatplans_1 = __importDefault(require("./api/treatplans"));
 const schedules_1 = __importDefault(require("./api/schedules"));
 const providers_1 = __importDefault(require("./api/providers"));
 const operatories_1 = __importDefault(require("./api/operatories"));
+const payments_1 = __importDefault(require("./api/payments"));
+const definitions_1 = __importDefault(require("./api/definitions"));
+const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
 class OpenDental {
     static httpClient;
     /**
@@ -111,7 +114,7 @@ class OpenDental {
         return new schedules_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Providers API.
      */
     static Providers() {
         if (!this.httpClient) {
@@ -120,7 +123,7 @@ class OpenDental {
         return new providers_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Schedules API.
+     * Create a new instance of the Operatories API.
      */
     static Operatories() {
         if (!this.httpClient) {
@@ -128,5 +131,32 @@ class OpenDental {
         }
         return new operatories_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the Payments API.
+     */
+    static Payments() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new payments_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Definitions API.
+     */
+    static Definitions() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new definitions_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the DiscountPlanSubs API.
+     */
+    static DiscountPlanSubs() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new discountPlanSubs_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/definitionTypes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Represents a definition in the Open Dental system.
+ * Used in multiple definition-related endpoints.
+ * @see https://www.opendental.com/site/apidefinitions.html
+ */
+export interface Definition {
+    DefNum?: number;
+    ItemName?: string;
+    ItemValue?: string;
+    Category?: number;
+    category?: string;
+    isHidden?: 'true' | 'false';
+}
+/**
+ * Parameters for GET Definitions.
+ * @see https://www.opendental.com/site/apidefinitions.html
+ */
+export interface GetDefinitionsParams {
+    Category?: number;
+    includeHidden?: 'true' | 'false';
+    Offset?: number;
+}
+//# sourceMappingURL=definitionTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definitionTypes.d.ts","sourceRoot":"","sources":["../../src/types/definitionTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/definitionTypes.js

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

package/dist/types/discountPlanSubTypes.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Represents a subscription to a discount plan in the Open Dental system.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface DiscountPlanSub {
+    DiscountSubNum?: number;
+    DiscountPlanNum?: number;
+    PatNum?: number;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+/**
+ * Parameters for GET discount plan subs.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface GetDiscountPlanSubsParams {
+    PatNum?: number;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a discount plan sub.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface CreateDiscountPlanSubParams {
+    PatNum: number;
+    DiscountPlanNum: number;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+/**
+ * Parameters for updating a discount plan sub.
+ * @see https://www.opendental.com/site/apidiscountplansubs.html
+ */
+export interface UpdateDiscountPlanSubParams {
+    DiscountSubNum: number;
+    PatNum: string;
+    DateEffective?: string;
+    DateTerm?: string;
+    SubNote?: string;
+}
+//# sourceMappingURL=discountPlanSubTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discountPlanSubTypes.d.ts","sourceRoot":"","sources":["../../src/types/discountPlanSubTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/discountPlanSubTypes.js

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

package/dist/types/paymentTypes.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface Payment {
+    PayNum?: number;
+    PayType?: number;
+    payType?: string;
+    PayDate?: string;
+    PayAmt?: string;
+    CheckNum?: string;
+    BankBranch?: string;
+    PayNote?: string;
+    PatNum?: number;
+    ClinicNum?: string;
+    DateEntry?: string;
+    DepositNum?: number;
+    Receipt?: string;
+    IsRecurringCC?: 'true' | 'false';
+    PaymentSource?: string;
+    ProcessStatus?: string;
+    RecurringChargeDate?: string;
+    IsCcCompleted?: 'true' | 'false';
+    serverDateTime?: string;
+}
+/**
+ * Parameters for GET Payments.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface GetPaymentsParams {
+    PayType?: number;
+    PatNum?: number;
+    DateEntry?: string;
+    Offset?: number;
+}
+/**
+ * Parameters for creating a payment.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface CreatePaymentParams {
+    PatNum: number;
+    PayAmt: string;
+    PayType?: number;
+    PayDate?: string;
+    CheckNum?: string;
+    PayNote?: string;
+    BankBranch?: string;
+    ClinicNum?: string;
+    isPatientPreferred?: 'true' | 'false';
+    isPrepayment?: 'true' | 'false';
+    procNums?: number[];
+    payPlanNum?: number;
+}
+/**
+ * Parameters for updating a payment.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface UpdatePaymentParams {
+    PayNum: number;
+    PayType?: number;
+    CheckNum?: string;
+    BankBranch?: string;
+    PayNote?: string;
+    ProcessStatus?: 'OnlineProcessed' | 'OnlinePending';
+}
+//# sourceMappingURL=paymentTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paymentTypes.d.ts","sourceRoot":"","sources":["../../src/types/paymentTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAG,iBAAiB,GAAG,eAAe,CAAC;CACtD"}

package/dist/types/paymentTypes.js

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

package/dist/types/scheduleTypes.d.ts

@@ -8,7 +8,7 @@ export interface Schedule {
     StartTime?: string;
     StopTime?: string;
     SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP";
-    ProvNum?: number;
+    ProvNum?: string;
     BlockoutType?: string;
     blockoutType?: string;
     Note?: string;
@@ -16,7 +16,7 @@ export interface Schedule {
     EmployeeNum?: string;
 }
 /**
- * Parameters for fetching multiple patients.
+ * Parameters for fetching schedule records;
  * @see https://www.opendental.com/site/apischedules.html
  */
 export interface GetSchedulesParams {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "0.1.6",
+    "version": "1.0.0",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -15,8 +15,8 @@
         "url": "git+https://github.com/getrinsed/open-dental.git"
     },
     "dependencies": {
-        "axios": "^1.7.7",
-        "moment-timezone": "^0.5.46"
+        "axios": "^1.7.9",
+        "moment-timezone": "^0.5.47"
     },
     "devDependencies": {
         "@types/jest": "^29.5.14",

package/src/api/definitions.ts

@@ -0,0 +1,35 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Definition,
+  GetDefinitionsParams,
+} from "../types/definitionTypes";
+
+export default class Definitions {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+/**
+ * Fetch multiple definitinos with optional filtering and pagination.
+ * @param {Object} params - The parameters for filtering and pagination.
+ * @param {number} [params.Category] - Filter by category.
+ * @param {"true" | "false"} [data.includeHidden="false"] - Optional parameter that defaults to false.
+ * @param {number} [params.Offset] - Pagination offset for results.
+ * @returns {Promise<Definition[]>} - A list of appointments.
+ */
+public async getDefinitions({
+    Category,
+    includeHidden,
+    Offset,
+  }: GetDefinitionsParams = {}): Promise<Definition[]> {
+    const params = {
+      Category,
+      includeHidden,
+      Offset,
+    };
+  
+    return this.httpClient.get<Definition[]>("/definitions", params);
+  }
+}

package/src/api/discountPlanSubs.ts

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

package/src/api/index.ts

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

package/src/api/operatories.ts

@@ -12,12 +12,12 @@ export default class Operatories {
   }
 
   /**
-   * Fetch a single patfield by its ID.
+   * Fetch a single operatory by its ID.
    * @param {number} OperatoryNum - The ID of the patfield.
    * @returns {Promise<Operatory>} - The patient data.
    * @throws {Error} - If `PatNum` is not valid or the API returns an error.
    */
-  public async getPatField(OperatoryNum: number): Promise<Operatory> {
+  public async getOperatory(OperatoryNum: number): Promise<Operatory> {
     if (!OperatoryNum || typeof OperatoryNum !== "number") {
         throw new Error("Invalid parameter: PatNum must be a valid number.");
     }
@@ -26,7 +26,7 @@ export default class Operatories {
   }
 
   /**
-   * Fetch multiple patients with optional filtering and pagination.
+   * Fetch multiple operatories with optional filtering and pagination.
    * @param {Object} params - Filtering and pagination parameters.
    * @param {string} [params.ClinicNum] - Filter by clinicnum
    * @param {string} [params.Offset] - Filter by clinicnum

package/src/api/payments.ts

@@ -0,0 +1,86 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Payment,
+  GetPaymentsParams,
+  CreatePaymentParams,
+  UpdatePaymentParams,
+} from "../types/paymentTypes";
+
+export default class Payments {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+/**
+ * Fetch multiple payments with optional filtering and pagination.
+ * @param {Object} params - The parameters for filtering and pagination.
+ * @param {number} [params.PayType] - Filter by PayType, definition.DefNum where definition.Category=10.
+ * @param {number} [params.PatNum] - FK to patient.PatNum.
+ * @param {string} [params.DateEntry] - String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
+ * @param {number} [params.Offset] - Pagination offset for results.
+ * @returns {Promise<Payment[]>} - A list of payments.
+ */
+public async getPayments({
+    PayType,
+    PatNum,
+    DateEntry,
+    Offset,
+  }: GetPaymentsParams = {}): Promise<Payment[]> {
+    const params = {
+      PayType,
+      PatNum,
+      DateEntry,
+      Offset,
+    };
+  
+    return this.httpClient.get<Payment[]>("/payments", params);
+  }
+
+  /**
+   * Create a payment.
+   * @param {Object} data - Data for the new appointment.
+   * @param {string} data.PayAmt - Required: String amount of payment as 0.00 (float.toString())
+   * @param {number} data.PatNum - Required: FK to Patient
+   * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.PayDate] - Optional. String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+   * @param {string} [data.CheckNum] - Optional.
+   * @param {string} [data.PayNote] - Optional.
+   * @param {string} [data.BankBranch] - Optional.
+   * @param {string} [data.ClinicNum] - Optional: Defaults to patient.ClinicNum
+   * @param {"true" | "false"} [data.isPatientPreferred="false"] - Optional. When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+   * @param {"true" | "false"} [data.isPrepayment="false"] - Optional. Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+   * @param {number[]} [data.procNums=[]] - Optional. An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+   * @param {number} [data.payPlanNum=0] - Optional. FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+   * @returns {Promise<Payment>} - The created payment.
+   * @throws {Error} - If required fields are missing.
+   */
+    public async createPayment(data: CreatePaymentParams): Promise<Payment> {
+        if (!data.PayAmt || !data.PatNum) {
+          throw new Error("PayAmt and PatNum are required.");
+        }
+    
+        return this.httpClient.post<Payment>("/payments", data);
+      }
+
+  /**
+   * Update a payment.
+   * @param {Object} data - Data for the new appointment.
+   * @param {string} data.PayNum - Required: PK of Payment to update.
+   * @param {string} data.PayType - Optional: definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+   * @param {string} [data.CheckNum] - Optional.
+   * @param {string} [data.PayNote] - Optional.
+   * @param {string} [data.BankBranch] - Optional.
+   * @param {"OnlineProcessed" | "OnlinePending"} [data.ProcessStatus] - Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+   * @returns {Promise<Payment>} - The updated payment.
+   * @throws {Error} - If required fields are missing.
+   */
+  public async updatePayment(data: UpdatePaymentParams): Promise<Payment> {
+    if (!data.PayNum) {
+      throw new Error("PayNum is required.");
+    }
+
+    return this.httpClient.put<Payment>(`/payments/${data.PayNum}`, data);
+  }
+}

package/src/openDental.ts

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

package/src/types/definitionTypes.ts

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

package/src/types/discountPlanSubTypes.ts

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

package/src/types/paymentTypes.ts

@@ -0,0 +1,70 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apipayments.html
+ */
+export interface Payment {
+    PayNum?: number; //PK
+    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+    payType?: string; //
+    PayDate?: string; //String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+    PayAmt?: string; //
+    CheckNum?: string; //
+    BankBranch?: string; //
+    PayNote?: string; //
+    PatNum?: number; //FK to patient.PatNum.
+    ClinicNum?: string; //
+    DateEntry?: string; //
+    DepositNum?: number; //
+    Receipt?: string; //
+    IsRecurringCC?: 'true' | 'false'; //
+    PaymentSource?: string; //
+    ProcessStatus?: string; //
+    RecurringChargeDate?: string; //
+    IsCcCompleted?: 'true' | 'false'; //
+    serverDateTime?: string; //
+  }
+
+  /**
+   * Parameters for GET Payments.
+   * @see https://www.opendental.com/site/apipayments.html
+   */
+  export interface GetPaymentsParams {
+    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+    PatNum?: number; //FK to patient.PatNum.
+    DateEntry?: string; //String in "yyyy-MM-dd" format. Gets all payments made on or after a certain date.
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating a payment.
+   * @see https://www.opendental.com/site/apipayments.html
+   */
+  export interface CreatePaymentParams {
+    PatNum: number; //Required. FK to patient.PatNum.
+    PayAmt: string; //String amount of payment as 0.00 (float.toString())
+    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+    PayDate?: string; //String in "yyyy-MM-dd" format. Defaults to today's date. Follows the office's preference to allow future-dated payments.
+    CheckNum?: string; //
+    PayNote?: string; //
+    BankBranch?: string; //    
+    ClinicNum?: string; //Defaults to patient.ClinicNum
+    isPatientPreferred?: 'true' | 'false'; //When entering a payment through Open Dental directly, there is a checkbox for this option. This API field allows the same functionality. It causes the splits to go to the patient instead of being split among family members on a FIFO basis. Default "false".
+    isPrepayment?: 'true' | 'false'; //Creates a single paysplit using the default unearned type for unallocated paysplits stored in the PrepaymentUnearnedType preference. See also Unearned / Prepayment. Default "false".
+    procNums?: number[]; //An array of ProcNums, in [1,2,3] format to apply this Payment to. Procedures are paid by Procedure.ProcDate on a FIFO basis. Procedures not in the Patient's family will be silently ignored. Ignored if isPrepayment is set to "true". Default is an empty array.
+    payPlanNum?: number; //FK to payplan.PayPlanNum for a Dynamic Payment Plan. Only allowed if isPrepayment is "true" prior to version 23.3.4. Default 0.
+  }
+  
+  /**
+   * Parameters for updating a payment.
+   * @see https://www.opendental.com/site/apipayments.html
+   */
+  export interface UpdatePaymentParams {
+    PayNum: number; //Required PK
+    PayType?: number; //definition.DefNum where definition.Category=10. Defaults to the ApiPaymentType preference.
+    CheckNum?: string; //
+    BankBranch?: string; //    
+    PayNote?: string; //
+    ProcessStatus?:  'OnlineProcessed' | 'OnlinePending'; //Indicates whether a payment came from in office or online, and if the online payment is processed or pending. Either "OnlineProcessed" or "OnlinePending".
+  }
+  

package/src/types/scheduleTypes.ts

@@ -3,21 +3,21 @@
  * @see https://www.opendental.com/site/apischedules.html
  */
 export interface Schedule {
-    ScheduleNum?: number; //Unique identifier for patfield
+    ScheduleNum?: number; //Unique identifier for schedule row
     SchedDate?: string; //"YYYY-MM-DD" 
-    StartTime?: string; //"12:00:00"
-    StopTime?: string; //"12:00:00"
+    StartTime?: string; //"HH:mm:ss"
+    StopTime?: string; //"HH:mm:ss"
     SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
-    ProvNum?: number; //FK to provider.ProvNum.
-    BlockoutType?: string; //"YYYY-MM-DD" 
-    blockoutType?: string; //"YYYY-MM-DD"
-    Note?: string; //"YYYY-MM-DD"  
-    operatories?: string; //"YYYY-MM-DD" 
-    EmployeeNum?: string; //"YYYY-MM-DD" 
+    ProvNum?: string; //FK to provider.ProvNum.
+    BlockoutType?: string; //Definition.DefNum where definition.Category=25.
+    blockoutType?: string; //Definition.ItemName where Definition.DefNum == BlockoutType
+    Note?: string; //
+    operatories?: string; //String array of operatory.OperatoryNum
+    EmployeeNum?: string; //FK to employee.EmployeeNum.
   }
 
 /**
- * Parameters for fetching multiple patients.
+ * Parameters for fetching schedule records; 
  * @see https://www.opendental.com/site/apischedules.html
  */
 export interface GetSchedulesParams {