@insurance-broker/api-client 5.6.0 → 5.7.0

package/dist/schema.d.ts

@@ -66,6 +66,8 @@ export interface paths {
          * @description PAY-002. Another broker's obligation and another customer's are invisible here rather than refused: the tenant and owner query filters remove them before the read runs, so all three cases answer the same `404` (ADR-0008, ADR-0030).
          *
          *     There is **no overdue field**. Whether an obligation is overdue is a comparison between its due date and the clock, and step 9.10's lists compute it at read time and return the day they measured against — ADR-0035 §4's rule, which forbids storing a status a date comparison answers.
+         *
+         *     **`paid` and `balance` are computed as the response is written** (#595), by the same rule as the list. `paid` is read a moment after the charge itself, so a payment that lands in between can show in `paid` and `balance` before `status` reflects it; read again and the two agree. `balance` is not always `amount` less `paid`: a cancelled charge is owed nothing, so money paid against one leaves the customer in credit, and a written-off charge is owed what actually arrived and no more.
          */
         get: operations["GetObligation"];
         put?: never;
@@ -133,7 +135,15 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * List what this broker has invoiced, newest first
+         * @description ADR-0042 section 8, ADR-0031. Every invoice this broker has drafted — drafts, issued invoices and discarded drafts — **most recently drafted first**, ordered by `draftedAtUtc` and then `id`, both descending, and paged by cursor. The drafting instant is the key because it never changes: an invoice keeps its place in the walk when it is issued or discarded.
+         *
+         *     `customerId`, `policyId` and `status` (`Draft`, `Issued`, `Discarded`) narrow the list and combine. **None of them is authorisation**: the broker whose invoices these are comes from the session, and naming another broker's customer selects nothing rather than refusing.
+         *
+         *     A row carries no lines; `GET /invoices/{id}` returns one invoice with its lines. There is no total and no count: `nextCursor` is null at the end of the walk (ADR-0031 section 4). A cursor this endpoint did not issue is a `400`.
+         */
+        get: operations["ListInvoices"];
         put?: never;
         /**
          * Open a draft invoice against a policy
@@ -7750,6 +7760,10 @@ export interface components {
             amount: number | string;
             currency: string;
         };
+        InvoicePage: {
+            items: components["schemas"]["InvoiceSummaryResponse"][];
+            nextCursor: null | string;
+        };
         InvoiceResponse: {
             /** Format: uuid */
             id: string;
@@ -7777,6 +7791,32 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             lines: components["schemas"]["InvoiceLineResponse"][];
         };
+        InvoiceSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: double */
+            premiumAmount: number | string;
+            currency: string;
+            /** Format: date */
+            coverStart: null | string;
+            /** Format: date */
+            coverEnd: null | string;
+            status: string;
+            /** Format: date-time */
+            draftedAtUtc: string;
+            /** Format: date-time */
+            issuedAtUtc: null | string;
+            /** Format: double */
+            totalAmount: null | number | string;
+            /** Format: date-time */
+            retentionAnchorAtUtc: null | string;
+        };
         IssueCreditNoteRequest: {
             reason: string;
             lines: components["schemas"]["CreditNoteLineRequest"][];
@@ -7965,6 +8005,10 @@ export interface components {
             productId: string;
             /** Format: double */
             amount: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            balance: number | string;
             currency: string;
             /** Format: date */
             dueOn: string;
@@ -10023,6 +10067,41 @@ export interface operations {
             };
         };
     };
+    ListInvoices: {
+        parameters: {
+            query?: {
+                customerId?: string;
+                policyId?: string;
+                status?: string;
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvoicePage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     DraftInvoice: {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
   "license": "UNLICENSED",
   "private": false,