@managemint-solutions/entities 1.6.0 → 1.7.0

package/dist/audit-trail/enum/index.d.ts

@@ -19,6 +19,7 @@ export declare enum AuditTrailEntityType {
     TASKS = "tasks",
     TIMESHEETS = "timesheets",
     BILLING_TRANSACTIONS = "billing_transactions",
+    INVOICE = "invoices",
     NOTIFICATION = "notifications",
     SUPPORT_TICKETS = "support_tickets",
     SUPPORT_MESSAGES = "support_messages",

package/dist/audit-trail/enum/index.js

@@ -24,6 +24,7 @@ var AuditTrailEntityType;
     AuditTrailEntityType["TASKS"] = "tasks";
     AuditTrailEntityType["TIMESHEETS"] = "timesheets";
     AuditTrailEntityType["BILLING_TRANSACTIONS"] = "billing_transactions";
+    AuditTrailEntityType["INVOICE"] = "invoices";
     AuditTrailEntityType["NOTIFICATION"] = "notifications";
     AuditTrailEntityType["SUPPORT_TICKETS"] = "support_tickets";
     AuditTrailEntityType["SUPPORT_MESSAGES"] = "support_messages";

package/dist/billing/invoices/dto/index.d.ts

@@ -0,0 +1,9 @@
+export type GetInvoicesDto = {
+    page: number;
+    page_size: number;
+    /** Comma-joined BillingTransactionStatus values on the wire. Absent = all invoices. */
+    status_in?: string | null;
+};
+export type InvoiceIdDto = {
+    invoiceId: string;
+};

package/dist/billing/invoices/dto/index.js

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

package/dist/billing/invoices/index.d.ts

@@ -0,0 +1,47 @@
+import { BillingTransactionStatus, BillingTransactionType } from "../enum";
+/** One priced line on an invoice document, frozen at issue time. */
+export type InvoiceLineItem = {
+    /** The bold line: the module, e.g. "Core — subscription". */
+    label: string;
+    /** The grey sub-line: "12 seats · 2 Sep – 25 Sep 2026 (23 of 31 days)". */
+    detail?: string | null;
+    unit_amount_minor: number;
+    quantity: number;
+    amount_minor: number;
+};
+/** One row of GET /billing/invoices. */
+export type InvoiceSummary = {
+    mms_id: string;
+    /** Sequential per organization; displayed as INV-000123. */
+    invoice_number: number;
+    transaction_type: BillingTransactionType;
+    /** Mirrors the backing transaction's status. */
+    status: BillingTransactionStatus;
+    issued_at: string;
+    paid_at: string | null;
+    amount_minor: number;
+    currency: string;
+};
+/**
+ * The full invoice document data. `line_items` and `billed_to` are snapshots
+ * frozen when the invoice was written — the document must not change when the
+ * organization later edits its billing address or the pricebook moves on.
+ */
+export type InvoiceEntity = InvoiceSummary & {
+    billing_transaction_id: string;
+    paystack_reference: string | null;
+    period_start: string | null;
+    period_end: string | null;
+    line_items: InvoiceLineItem[];
+    billed_to: {
+        name: string;
+        email: string | null;
+        lines: string[];
+        vat_number: string | null;
+        registration_number: string | null;
+    };
+};
+/** Response of GET /billing/invoices/:invoiceId/html — the A4 document markup. */
+export type InvoiceHtmlResponse = {
+    html: string;
+};

package/dist/billing/invoices/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {