feat: added overtimecarry model and api request

src/clockodo.ts

@@ -41,6 +41,7 @@ import {
   WorkTimeChangeRequestStatus,
   WorkTimeDay,
 } from "./models/workTimes.js";
+import { OvertimecarryRow } from "./models/overtimecarry.js";
 
 export class Clockodo {
   api: Api;
@@ -765,6 +766,12 @@ export class Clockodo {
       remainingParams
     );
   }
+
+  async getOvertimecarry(
+    params?: Params<OvertimecarryRowParams>
+  ): Promise<OvertimecarryRowReturnType> {
+    return this.api.get("/overtimecarry", params);
+  }
 }
 
 export type AbsenceReturnType = { absence: Absence };
@@ -1053,3 +1060,13 @@ export type AddWorkTimesChangeRequestReturnType =
        **/
       replacedChangeRequest: null;
     };
+
+export type OvertimecarryRowReturnType = {
+  overtimecarry: Array<OvertimecarryRow>;
+};
+export type OvertimecarryRowParams = {
+  /** The user ID by which the overtime carry rows should be filtered */
+  usersId?: number;
+  /** The year to which the data should be restricted to */
+  year?: number;
+};

src/index.ts

@@ -11,6 +11,7 @@ export * from "./models/holidaysquota.js";
 export * from "./models/lumpsumService.js";
 export * from "./models/nonbusinessDay.js";
 export * from "./models/nonbusinessGroup.js";
+export * from "./models/overtimecarry.js";
 export * from "./models/project.js";
 export * from "./models/service.js";
 export * from "./models/targethours.js";

src/mocks.ts

@@ -8,6 +8,7 @@ export * from "./models/entry.mocks.js";
 // export * from "./models/holidaysquota.mocks.js";
 export * from "./models/lumpsumService.mocks.js";
 export * from "./models/nonbusinessDay.mocks.js";
+export * from "./models/overtimecarry.mocks.js";
 export * from "./models/project.mocks.js";
 // export * from "./models/service.mocks.js";
 export * from "./models/targethours.mocks.js";

src/models/overtimecarry.mocks.ts

@@ -0,0 +1,16 @@
+import { faker } from "@faker-js/faker";
+import { OvertimecarryRow } from "./overtimecarry.js";
+
+export const createOvertimecarryMocks = ({
+  count = 1,
+  usersId = 0,
+}: { count?: number; usersId?: number } = {}) => {
+  return Array.from({ length: count }, (): OvertimecarryRow => {
+    return {
+      usersId,
+      year: faker.datatype.number({ min: 1900, max: 2024 }),
+      note: faker.datatype.boolean() ? faker.lorem.sentences(2) : null,
+      hours: faker.datatype.number({ min: 0, max: 100 }),
+    };
+  });
+};

src/models/overtimecarry.ts

@@ -0,0 +1,12 @@
+export type OvertimecarryRow = {
+  /** The related employee's ID */
+  usersId: number;
+  /**
+   * Year for which the overtime carryover applies
+   * Format YYYY
+   */
+  year: number;
+  /** Number of hours */
+  hours: number;
+  note: string | null;
+};