rotacloud 2.2.1 → 2.2.3

package/dist/endpoint.d.ts

@@ -3,6 +3,7 @@ import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.inter
 import { Message } from './interfaces/message.interface.js';
 import { AttendanceQueryParams, AvailabilityQueryParams, DailyBudgetsQueryParams, DailyRevenueQueryParams, DayNotesQueryParams, DaysOffQueryParams, DocumentsQueryParams, GroupsQueryParams, LeaveEmbargoesQueryParams, LeaveQueryParams, LeaveRequestsQueryParams, LocationsQueryParams, RolesQueryParams, SettingsQueryParams, ShiftsQueryParams, TerminalsQueryParams, ToilAccrualsQueryParams, ToilAllowanceQueryParams, UsersQueryParams } from './interfaces/query-params/index.js';
 import { RequirementsOf } from './utils.js';
+import { Invoice, InvoiceQueryParameters } from './interfaces/invoice.interface.js';
 /** Endpoint versions supported by the API */
 export type EndpointVersion = 'v1' | 'v2';
 /** Associated types for a given API endpoint */
@@ -55,6 +56,7 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
     /** Type mappings for v2 endpoints */
     v2: {
         logbook: Endpoint<LogbookEntry, LogbookQueryParameters, 'name' | 'description' | 'date' | 'userId'>;
+        invoices: Endpoint<Invoice, InvoiceQueryParameters>;
         dayNotes: Endpoint<DayNoteV2, DayNoteV2QueryParameters, 'title' | 'message' | 'startDate' | 'endDate' | 'locations' | 'visibleToEmployees'>;
         'logbook/categories': Endpoint<LogbookCategory, undefined, Pick<LogbookCategory, 'name'>>;
     };

package/dist/interfaces/invoice.interface.d.ts

@@ -0,0 +1,63 @@
+export type InvoiceStatus = 'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending';
+export type PricingModel = 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
+export interface Invoice {
+    id: string;
+    /** The status of the invoice */
+    status: InvoiceStatus;
+    /** The currency code of the invoice, e.g., GBP */
+    currencyCode: string;
+    /** The total amount of the invoice in subunits (pence, cents, etc.) */
+    total: number | null;
+    amountDue: number | null;
+    /** The date and time in ISO 8601 format when the invoice was issued  */
+    date: string | null;
+    /** The date and time in ISO 8601 format when the invoice is due  */
+    dueDate: string | null;
+    deleted: boolean;
+    /** The date and time in ISO 8601 format when the invoice was last updated  */
+    updatedAt: string | null;
+    /** The purchase order number associated with this invoice */
+    poNumber: number | null;
+    recurring: boolean | null;
+    vatNumber: string | null;
+    priceType: string | null;
+    netTermDays: number | null;
+    amountPaid: number | null;
+    amountAdjusted: number | null;
+    writeOffAmount: number | null;
+    creditsApplied: number | null;
+    /** Date and time in ISO 8601 format  */
+    paidAt: string | null;
+    dunningStatus: string | null;
+    /** Date and time in ISO 8601 format  */
+    nextRetryAt: string | null;
+    /** Date and time in ISO 8601 format  */
+    voidedAt: string | null;
+    subTotal: number | null;
+    tax: number | null;
+    lineItems: LineItem[] | null;
+}
+export interface InvoiceDownload {
+    downloadLink: string;
+    downloadLinkExpiresAt: string;
+}
+export interface LineItem {
+    unitAmount: number;
+    quantity?: number;
+    amount?: number;
+    pricingModel?: PricingModel;
+    description: string;
+    entityDescription?: string;
+}
+export interface InvoiceQueryParameters {
+    /** Invoice status to filter by */
+    status?: InvoiceStatus;
+    /** The date to filter from, e.g., 2025-01-01 */
+    dateFrom?: string;
+    /** The date to filter to, e.g., 2025-12-30 */
+    dateTo?: string;
+    /** The minimum total amount of the invoice */
+    minTotal?: number;
+    /** The maximum total amount of the invoice */
+    maxTotal?: number;
+}

package/dist/interfaces/invoice.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/main.d.ts

@@ -75,6 +75,14 @@ export declare const createRotaCloudClient: (config: import("./interfaces/sdk-co
         endpointVersion: "v1";
         operations: ("get" | "delete" | "list" | "listAll" | "create" | "update")[];
     };
+    invoice: {
+        endpoint: "invoices";
+        endpointVersion: "v2";
+        operations: ("get" | "list" | "listAll")[];
+        customOperations: {
+            get: (ctx: import("./ops.js").OperationContext, id: number) => import("./ops.js").RequestConfig<void, import("./interfaces/invoice.interface.js").Invoice & import("./interfaces/invoice.interface.js").InvoiceDownload>;
+        };
+    };
     leaveEmbargo: {
         endpoint: "leave_embargoes";
         endpointVersion: "v1";

package/dist/service.d.ts

@@ -9,6 +9,7 @@ import { ShiftDropRequest } from './interfaces/drop-request.interface.js';
 import { ToilAllowanceQueryParams } from './interfaces/query-params/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
+import { Invoice, InvoiceDownload } from './interfaces/invoice.interface.js';
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
     /** Operations allowed and usable for the endpoint */
     operations: Operation[];
@@ -117,6 +118,14 @@ export declare const SERVICES: {
         endpointVersion: "v1";
         operations: ("get" | "delete" | "list" | "listAll" | "create" | "update")[];
     };
+    invoice: {
+        endpoint: "invoices";
+        endpointVersion: "v2";
+        operations: ("get" | "list" | "listAll")[];
+        customOperations: {
+            get: (ctx: OperationContext, id: number) => RequestConfig<void, Invoice & InvoiceDownload>;
+        };
+    };
     leaveEmbargo: {
         endpoint: "leave_embargoes";
         endpointVersion: "v1";

package/dist/service.js

@@ -106,6 +106,18 @@ export const SERVICES = {
         endpointVersion: 'v1',
         operations: ['create', 'get', 'list', 'listAll', 'update', 'delete'],
     },
+    invoice: {
+        endpoint: 'invoices',
+        endpointVersion: 'v2',
+        operations: ['get', 'list', 'listAll'],
+        customOperations: {
+            get: (ctx, id) => ({
+                ...ctx.request,
+                url: `${ctx.service.endpointVersion}/${ctx.service.endpoint}/${id}`,
+                method: 'GET',
+            }),
+        },
+    },
     leaveEmbargo: {
         endpoint: 'leave_embargoes',
         endpointVersion: 'v1',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "type": "module",
   "engines": {

package/src/endpoint.ts

@@ -52,6 +52,7 @@ import {
   UsersQueryParams,
 } from './interfaces/query-params/index.js';
 import { RequirementsOf } from './utils.js';
+import { Invoice, InvoiceQueryParameters } from './interfaces/invoice.interface.js';
 
 /** Endpoint versions supported by the API */
 export type EndpointVersion = 'v1' | 'v2';
@@ -120,6 +121,7 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
   /** Type mappings for v2 endpoints */
   v2: {
     logbook: Endpoint<LogbookEntry, LogbookQueryParameters, 'name' | 'description' | 'date' | 'userId'>;
+    invoices: Endpoint<Invoice, InvoiceQueryParameters>;
     dayNotes: Endpoint<
       DayNoteV2,
       DayNoteV2QueryParameters,

package/src/interfaces/invoice.interface.ts

@@ -0,0 +1,68 @@
+export type InvoiceStatus = 'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending';
+
+export type PricingModel = 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
+
+export interface Invoice {
+  id: string;
+  /** The status of the invoice */
+  status: InvoiceStatus;
+  /** The currency code of the invoice, e.g., GBP */
+  currencyCode: string;
+  /** The total amount of the invoice in subunits (pence, cents, etc.) */
+  total: number | null;
+  amountDue: number | null;
+  /** The date and time in ISO 8601 format when the invoice was issued  */
+  date: string | null;
+  /** The date and time in ISO 8601 format when the invoice is due  */
+  dueDate: string | null;
+  deleted: boolean;
+  /** The date and time in ISO 8601 format when the invoice was last updated  */
+  updatedAt: string | null;
+  /** The purchase order number associated with this invoice */
+  poNumber: number | null;
+  recurring: boolean | null;
+  vatNumber: string | null;
+  priceType: string | null;
+  netTermDays: number | null;
+  amountPaid: number | null;
+  amountAdjusted: number | null;
+  writeOffAmount: number | null;
+  creditsApplied: number | null;
+  /** Date and time in ISO 8601 format  */
+  paidAt: string | null;
+  dunningStatus: string | null;
+  /** Date and time in ISO 8601 format  */
+  nextRetryAt: string | null;
+  /** Date and time in ISO 8601 format  */
+  voidedAt: string | null;
+  subTotal: number | null;
+  tax: number | null;
+  lineItems: LineItem[] | null;
+}
+
+export interface InvoiceDownload {
+  downloadLink: string;
+  downloadLinkExpiresAt: string;
+}
+
+export interface LineItem {
+  unitAmount: number;
+  quantity?: number;
+  amount?: number;
+  pricingModel?: PricingModel;
+  description: string;
+  entityDescription?: string;
+}
+
+export interface InvoiceQueryParameters {
+  /** Invoice status to filter by */
+  status?: InvoiceStatus;
+  /** The date to filter from, e.g., 2025-01-01 */
+  dateFrom?: string;
+  /** The date to filter to, e.g., 2025-12-30 */
+  dateTo?: string;
+  /** The minimum total amount of the invoice */
+  minTotal?: number;
+  /** The maximum total amount of the invoice */
+  maxTotal?: number;
+}

package/src/service.ts

@@ -33,6 +33,7 @@ import { ShiftDropRequest } from './interfaces/drop-request.interface.js';
 import { ToilAllowanceQueryParams } from './interfaces/query-params/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
+import { Invoice, InvoiceDownload } from './interfaces/invoice.interface.js';
 
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
   /** Operations allowed and usable for the endpoint */
@@ -178,6 +179,18 @@ export const SERVICES = {
     endpointVersion: 'v1',
     operations: ['create', 'get', 'list', 'listAll', 'update', 'delete'],
   },
+  invoice: {
+    endpoint: 'invoices',
+    endpointVersion: 'v2',
+    operations: ['get', 'list', 'listAll'],
+    customOperations: {
+      get: (ctx, id: number): RequestConfig<void, Invoice & InvoiceDownload> => ({
+        ...ctx.request,
+        url: `${ctx.service.endpointVersion}/${ctx.service.endpoint}/${id}`,
+        method: 'GET',
+      }),
+    },
+  },
   leaveEmbargo: {
     endpoint: 'leave_embargoes',
     endpointVersion: 'v1',