@rinse-dental/open-dental 0.1.3 → 0.1.4

package/deploy_notes.txt

@@ -0,0 +1,21 @@
+npm run build
+npm version patch //patch, minor, major
+npm pack
+git add .
+git commit -m "notes"
+git push origin main
+git tag //confirm tag
+git push origin vX.Y.Z
+gh release create vX.Y.Z --title "Release vX.Y.Z" --notes ""
+
+if the tag doesn't exist locally: 
+git tag vX.Y.Z
+git push origin vX.Y.Z
+gh release create vX.Y.Z --title "Release vX.Y.Z" --notes ""
+
+
+
+
+
+npm install /Users/casey/Dev/rinse-dental/open-dental/rinse-dental-open-dental-0.1.2.tgz
+"@rinse-dental/open-dental":"^0.1.2",

package/dist/api/index.d.ts

@@ -6,4 +6,5 @@ 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";
 //# 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"}
+{"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"}

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.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
+exports.Schedule = 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");
@@ -20,4 +20,6 @@ var recalls_1 = require("./recalls");
 Object.defineProperty(exports, "Recalls", { enumerable: true, get: function () { return __importDefault(recalls_1).default; } });
 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; } });
 // Add other APIs as needed

package/dist/api/schedules.d.ts

@@ -0,0 +1,29 @@
+import HttpClient from "../utils/httpClient";
+import { Schedule, GetSchedulesParams } from "../types/scheduleTypes";
+export default class Schedules {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single Schedule by its ID.
+     * @param {number} ScheduleNum - The ID of the patfield.
+     * @returns {Promise<Schedule>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    getSchedule(ScheduleNum: number): Promise<Schedule>;
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.date] - Optional: For a single day. Today's date by default.
+     * @param {string} [params.dateStart] - Optional: For a single day. Today's date by default.
+     * @param {string} [params.dateEnd] - Optional: For a single day. Today's date by default.
+     * @param {'Practice' | 'Provider' | 'Blockout' | 'Employee' | 'WebSchedASAP'} [params.SchedType] - Optional: Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
+     * @param {number} [params.BlockoutDefNum] - Definition.DefNum where definition.Category=25.
+     * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+     * @param {number} [params.EmployeeNum] - FK to employee.EmployeeNum.
+     * @param {number} [params.Offset] - Pagination offset.
+     * @returns {Promise<Schedule[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    getSchedules({ date, dateStart, dateEnd, SchedType, BlockoutDefNum, ProvNum, EmployeeNum, Offset, }?: GetSchedulesParams): Promise<Schedule[]>;
+}
+//# sourceMappingURL=schedules.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../src/api/schedules.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,QAAQ,EACR,kBAAkB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQhE;;;;;;;;;;;;;OAaG;IACY,YAAY,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,OAAO,EACP,SAAS,EACT,cAAc,EACd,OAAO,EACP,WAAW,EACX,MAAM,GAEP,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAanD"}

package/dist/api/schedules.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Schedules {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single Schedule by its ID.
+     * @param {number} ScheduleNum - The ID of the patfield.
+     * @returns {Promise<Schedule>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    async getSchedule(ScheduleNum) {
+        if (!ScheduleNum || typeof ScheduleNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return await this.httpClient.get(`/schedules/${ScheduleNum}`);
+    }
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.date] - Optional: For a single day. Today's date by default.
+     * @param {string} [params.dateStart] - Optional: For a single day. Today's date by default.
+     * @param {string} [params.dateEnd] - Optional: For a single day. Today's date by default.
+     * @param {'Practice' | 'Provider' | 'Blockout' | 'Employee' | 'WebSchedASAP'} [params.SchedType] - Optional: Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
+     * @param {number} [params.BlockoutDefNum] - Definition.DefNum where definition.Category=25.
+     * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+     * @param {number} [params.EmployeeNum] - FK to employee.EmployeeNum.
+     * @param {number} [params.Offset] - Pagination offset.
+     * @returns {Promise<Schedule[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    async getSchedules({ date, dateStart, dateEnd, SchedType, BlockoutDefNum, ProvNum, EmployeeNum, Offset, } = {}) {
+        return await this.httpClient.get("/schedules", {
+            date,
+            dateStart,
+            dateEnd,
+            SchedType,
+            BlockoutDefNum,
+            ProvNum,
+            EmployeeNum,
+            Offset,
+        });
+    }
+}
+exports.default = Schedules;

package/dist/openDental.d.ts

@@ -6,6 +6,7 @@ import Patients from "./api/patients";
 import ProcedureLogs from "./api/procedureLog";
 import Recalls from "./api/recalls";
 import TreatmentPlans from "./api/treatplans";
+import Schedules from "./api/schedules";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -41,9 +42,13 @@ declare class OpenDental {
      */
     static Recalls(): Recalls;
     /**
-     * Create a new instance of the Patients API.
+     * Create a new instance of the TreatmentPlans API.
      */
     static TreatmentPlans(): TreatmentPlans;
+    /**
+   * Create a new instance of the Schedules API.
+   */
+    static Schedules(): Schedules;
 }
 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;AAE9C,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;CAQ7B;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;AAGxC,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;IAO1B;;KAEC;WACa,SAAS;CAQ1B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -13,6 +13,7 @@ const patients_1 = __importDefault(require("./api/patients"));
 const procedureLog_1 = __importDefault(require("./api/procedureLog"));
 const recalls_1 = __importDefault(require("./api/recalls"));
 const treatplans_1 = __importDefault(require("./api/treatplans"));
+const schedules_1 = __importDefault(require("./api/schedules"));
 class OpenDental {
     static httpClient;
     /**
@@ -90,7 +91,7 @@ class OpenDental {
         return new recalls_1.default(this.httpClient);
     }
     /**
-     * Create a new instance of the Patients API.
+     * Create a new instance of the TreatmentPlans API.
      */
     static TreatmentPlans() {
         if (!this.httpClient) {
@@ -98,5 +99,14 @@ class OpenDental {
         }
         return new treatplans_1.default(this.httpClient);
     }
+    /**
+   * Create a new instance of the Schedules API.
+   */
+    static Schedules() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new schedules_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/scheduleTypes.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apischedules.html
+ */
+export interface Schedule {
+    ScheduleNum?: number;
+    SchedDate?: string;
+    StartTime?: string;
+    StopTime?: string;
+    SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP";
+    ProvNum?: number;
+    BlockoutType?: string;
+    blockoutType?: string;
+    Note?: string;
+    operatories?: string;
+    EmployeeNum?: string;
+}
+export interface GetSchedulesParams {
+    date?: string;
+    dateStart?: string;
+    dateEnd?: string;
+    SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP";
+    BlockoutDefNum?: string;
+    ProvNum?: number;
+    EmployeeNum?: number;
+    Offset?: number;
+}
+//# sourceMappingURL=scheduleTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleTypes.d.ts","sourceRoot":"","sources":["../../src/types/scheduleTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,CAAC;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,CAAC;IAC/E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/scheduleTypes.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": "0.1.3",
+    "version": "0.1.4",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/index.ts

@@ -6,4 +6,5 @@ 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"; 
 // Add other APIs as needed

package/src/api/schedules.ts

@@ -0,0 +1,65 @@
+import HttpClient from "../utils/httpClient";
+import {
+    Schedule,
+    GetSchedulesParams,
+} from "../types/scheduleTypes";
+
+export default class Schedules {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single Schedule by its ID.
+   * @param {number} ScheduleNum - The ID of the patfield.
+   * @returns {Promise<Schedule>} - The patient data.
+   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+   */
+  public async getSchedule(ScheduleNum: number): Promise<Schedule> {
+    if (!ScheduleNum || typeof ScheduleNum !== "number") {
+        throw new Error("Invalid parameter: PatNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<Schedule>(`/schedules/${ScheduleNum}`);
+  }
+
+  /**
+   * Fetch multiple patients with optional filtering and pagination.
+   * @param {Object} params - Filtering and pagination parameters.
+   * @param {string} [params.date] - Optional: For a single day. Today's date by default.
+   * @param {string} [params.dateStart] - Optional: For a single day. Today's date by default.
+   * @param {string} [params.dateEnd] - Optional: For a single day. Today's date by default.
+   * @param {'Practice' | 'Provider' | 'Blockout' | 'Employee' | 'WebSchedASAP'} [params.SchedType] - Optional: Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
+   * @param {number} [params.BlockoutDefNum] - Definition.DefNum where definition.Category=25.
+   * @param {number} [params.ProvNum] - FK to provider.ProvNum.
+   * @param {number} [params.EmployeeNum] - FK to employee.EmployeeNum.
+   * @param {number} [params.Offset] - Pagination offset.
+   * @returns {Promise<Schedule[]>} - A list of summarized patient data.
+   * @throws {Error} - If the API returns an error.
+   */
+    public async getSchedules({
+      date,
+      dateStart,
+      dateEnd,
+      SchedType,
+      BlockoutDefNum,
+      ProvNum,
+      EmployeeNum,
+      Offset,
+      
+    }: GetSchedulesParams = {}): Promise<Schedule[]> {
+
+      return await this.httpClient.get<Schedule[]>("/schedules", {
+        date,
+        dateStart,
+        dateEnd,
+        SchedType,
+        BlockoutDefNum,
+        ProvNum,
+        EmployeeNum,
+        Offset,
+      });
+    }
+}

package/src/openDental.ts

@@ -7,6 +7,8 @@ import Patients from "./api/patients";
 import ProcedureLogs from "./api/procedureLog";
 import Recalls from "./api/recalls";
 import TreatmentPlans from "./api/treatplans";
+import Schedules from "./api/schedules";
+
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -97,7 +99,7 @@ class OpenDental {
   }
 
   /**
-   * Create a new instance of the Patients API.
+   * Create a new instance of the TreatmentPlans API.
    */
   public static TreatmentPlans() {
     if (!this.httpClient) {
@@ -106,6 +108,16 @@ class OpenDental {
     return new TreatmentPlans(this.httpClient);
   }
 
+    /**
+   * Create a new instance of the Schedules API.
+   */
+    public static Schedules() {
+      if (!this.httpClient) {
+        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+      }
+      return new Schedules(this.httpClient);
+    }
+
 
 }
 

package/src/types/scheduleTypes.ts

@@ -0,0 +1,28 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apischedules.html
+ */
+export interface Schedule {
+    ScheduleNum?: number; //Unique identifier for patfield
+    SchedDate?: string; //"YYYY-MM-DD" 
+    StartTime?: string; //"12:00:00"
+    StopTime?: string; //"12:00:00"
+    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" 
+  }
+
+  export interface GetSchedulesParams {
+    date?: string; //"YYYY-MM-DD", For a single day. Today's date by default.
+    dateStart?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
+    dateEnd?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
+    SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
+    BlockoutDefNum?: string; //Definition.DefNum where definition.Category=25.
+    ProvNum?: number; //FK to provider.ProvNum.
+    EmployeeNum?: number; //FK to employee.EmployeeNum.
+    Offset?: number; //pagination
+  }