@insurance-broker/api-client 1.34.0 → 1.36.0

package/dist/schema.d.ts

@@ -176,6 +176,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/invoices/{id}/credit-notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The corrections issued against an invoice
+         * @description Oldest first, each with its lines. **The invoice's own figures are unchanged by any of them** - what a customer was demanded and what has since been credited are two separate records, which is what BR-010 asks for.
+         *
+         *     There is no paging: an invoice's corrections are a handful of records by nature.
+         */
+        get: operations["ListCreditNotes"];
+        put?: never;
+        /**
+         * Correct an issued invoice with a credit note
+         * @description BR-010 and ADR-0042 section 8. **A correction to an issued invoice is a new record and never an edit** - "a separate record referencing the invoice it corrects, with its own lines and its own document. Never an edit, never a negative line on the original."
+         *
+         *     **It arrives complete.** Unlike an invoice there is no draft and no route to add a line: a correction is a decision already taken, so it is immutable from the moment it is written.
+         *
+         *     **Every amount is positive.** A credit is carried by the *kind* of record rather than by the sign of a number, so the original invoice's figures are untouched and byte-identical afterwards.
+         *
+         *     **It may not credit more than the invoice demanded**, counting what earlier credit notes already credit. Crediting past the demand is a payment out rather than a correction, and a refund is its own record (WRK-004, Phase 2).
+         *
+         *     Refused against a **draft** invoice: a draft was never demanded of anybody, so it is discarded rather than credited.
+         */
+        post: operations["IssueCreditNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/invoices/{id}/discarding": {
         parameters: {
             query?: never;
@@ -348,6 +382,38 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/payments/{id}/reversal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The reversal against a payment, if there is one
+         * @description `404` when the payment has not been reversed, which is the ordinary case — a reversal is a correction and most payments never need one.
+         *
+         *     **At most one exists**, which a unique index guarantees rather than a handler, so this route answers a single record and never a list.
+         */
+        get: operations["GetPaymentReversal"];
+        put?: never;
+        /**
+         * Record that a payment's money did not arrive after all
+         * @description BR-010 and ADR-0042 section 8. **A posted payment is never edited** — a mistake is a reversal record and the original stays. That is also what keeps the phase's exit criterion safe: if a posting could be edited its external reference could be edited, and the unique index would stop guaranteeing that the same money cannot be recorded twice.
+         *
+         *     **It reverses the whole payment.** There is no amount to supply: a partial reversal would be a way to edit a figure by degrees, and money that arrived for the wrong amount was already refused at recording.
+         *
+         *     **Once per payment.** A second attempt is a `409` and is not retryable — a unique index refuses it, so a race and an ordinary re-run read identically.
+         *
+         *     **It does not re-open the charge the payment settled**, and that is deliberate rather than an oversight. A retention anchor once stamped is never moved (ADR-0038), and `Settled` records that the payments covered the debt at a knowable instant — which stayed true of that instant. What a broker owes after a reversal is collected by raising the charge again, which leaves both facts on the ledger instead of one row that has quietly changed its mind. The reversal appears in the payment's own history, which is the read a finance officer explains a payment from.
+         */
+        post: operations["ReversePayment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/payments/{id}/evidence/{evidenceId}/content": {
         parameters: {
             query?: never;
@@ -406,6 +472,122 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the statements this broker has produced
+         * @description Newest period first, paged by cursor. A `customerId` narrows the list to one customer.
+         *
+         *     **`customerId` is a filter and never an authorisation.** The broker whose statements these are comes from the session; naming a customer here selects among this broker's own rows and can reach nobody else's.
+         *
+         *     Rows carry what each statement covers and not its figures: computing every statement's balance to render one page would make a list cost what a year of reading costs.
+         */
+        get: operations["ListStatements"];
+        put?: never;
+        /**
+         * Produce a statement of account for a customer
+         * @description PAY-011. Records that a statement was produced for one customer, in one currency, over one period that has already finished, and answers its charges, payments, allocations and balances.
+         *
+         *     **The period must have ended.** A statement's figures are computed from the ledger rather than stored, so one covering a day that is still running would answer differently every time it was read - and a statement of account that changes after it has been sent is worse than none.
+         *
+         *     **One currency per statement.** A charge carries its own currency, and a balance in two of them is not a number. A customer owing in two currencies gets two statements.
+         *
+         *     **Nothing about money is stored on the row.** There is no balance column: every figure is derived from the obligations and payments the statement renders, bounded by its period and by the instant it was produced.
+         */
+        post: operations["ProduceStatement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/statements/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one statement, with its lines and figures
+         * @description PAY-011's whole sentence: the charges raised in the period, the payments recorded against them, which charge each payment went to, and the balance at either end of it.
+         *
+         *     **`closingBalance` is `openingBalance` plus `charged` less `paid`**, and `charged` is the sum of the `amountOwed` column, so the statement reconciles against its own lines.
+         *
+         *     **Each charge carries `amountOwed` beside `amount`, and the two differ when the charge has concluded.** A charge still outstanding, or one settled by payments on this statement, is owed in full. A charge the broker **cancelled** is owed nothing - it should never have existed, so money paid against it leaves the customer in credit. A charge the broker **wrote off** is owed what was actually paid against it, because a write-off forgives the remainder and never the part that arrived.
+         *
+         *     **Every figure is measured as at `producedAtUtc`.** A charge cancelled or written off after this statement was produced still shows what it was owed at the time, so `status` and `amountOwed` can disagree - and that pair is the record rather than a contradiction. A payment reversed afterwards still stands here for the same reason.
+         */
+        get: operations["GetStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/statements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the statements of account your broker has produced for you
+         * @description PAY-011. Every statement of yours, newest period first, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's statements are not in it - not filtered out of it, but absent, because a statement that is not yours is not visible to this route at all.
+         *
+         *     Each row says what the statement covers and when it was produced. Its charges, payments and balances are on its own route.
+         *
+         *     **A statement per currency.** A charge carries its own currency and a balance in two of them is not a number, so if you are billed in more than one you have a statement in each.
+         */
+        get: operations["ListOwnStatements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/statements/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one of your own statements of account
+         * @description PAY-011. What was charged in the period, what you paid, which charge each payment went to, the policies the charges relate to, and what was owed at either end of it.
+         *
+         *     **The balance is worked out from your broker's ledger rather than stored**, and it is measured as at the moment the statement was produced: a charge raised or a payment recorded afterwards is on a later statement, never added to this one. So this answer is the same today as the day it was sent to you.
+         *
+         *     **`closingBalance` is `openingBalance` plus `charged` less `paid`**, and `charged` is the sum of the `amountOwed` column, so you can add the charges up and arrive at the total.
+         *
+         *     **Each charge shows `amountOwed` as well as `amount`.** A charge still owed, or one your payments have settled, is owed in full. A charge your broker **cancelled** is owed nothing, so anything you paid against it counts in your favour. A charge your broker **wrote off** is owed only what you had already paid - the rest was forgiven, and neither of you owes it.
+         *
+         *     A payment that was reversed is listed and does not reduce what is owed, because it happened.
+         *
+         *     A statement that is not yours and one that does not exist are the same answer, because a statement belonging to somebody else is not visible here at all.
+         */
+        get: operations["GetOwnStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -4067,6 +4249,38 @@ export interface components {
             name: null | string;
             registrationNumber: null | string;
         };
+        CreditNoteLineRequest: {
+            kind: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+        };
+        CreditNoteLineResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: int32 */
+            ordinal: number | string;
+            kind: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+        };
+        CreditNoteResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            invoiceId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: double */
+            totalAmount: number | string;
+            currency: string;
+            reason: string;
+            /** Format: date-time */
+            issuedAtUtc: string;
+            issuedBySubjectId: string;
+            lines: components["schemas"]["CreditNoteLineResponse"][];
+        };
         CustomerClaimPage: {
             items: components["schemas"]["ClaimResponse"][];
             nextCursor: null | string;
@@ -4581,6 +4795,10 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             lines: components["schemas"]["InvoiceLineResponse"][];
         };
+        IssueCreditNoteRequest: {
+            reason: string;
+            lines: components["schemas"]["CreditNoteLineRequest"][];
+        };
         IssuedCustomerInvitationResponse: {
             /** Format: uuid */
             id: string;
@@ -4827,6 +5045,19 @@ export interface components {
             /** Format: date-time */
             approvedAtUtc: null | string;
         };
+        PaymentReversalResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            paymentId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            reason: string;
+            /** Format: date-time */
+            reversedAtUtc: string;
+            reversedBySubjectId: string;
+        };
         PlaceLegalHoldRequest: {
             moduleName: null | string;
             entityType: null | string;
@@ -4980,6 +5211,15 @@ export interface components {
             detail?: null | string;
             instance?: null | string;
         };
+        ProduceStatementRequest: {
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+        };
         ProductCategoryResponse: {
             /** Format: uuid */
             id: string;
@@ -5406,6 +5646,9 @@ export interface components {
             updatedAtUtc: null | string;
             setBySubjectId: null | string;
         };
+        ReversePaymentRequest: {
+            reason: string;
+        };
         ReviseComparisonSchemaBodyRequest: {
             body: null | string;
             /** Format: int32 */
@@ -5479,6 +5722,78 @@ export interface components {
             quoteRequestId: null | string;
             options: null | components["schemas"]["PresentedOptionRequest"][];
         };
+        StatementChargeResponse: {
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: double */
+            amountOwed: number | string;
+            /** Format: date */
+            dueOn: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            status: string;
+        };
+        StatementPage: {
+            items: components["schemas"]["StatementSummaryResponse"][];
+            nextCursor: null | string;
+        };
+        StatementPaymentResponse: {
+            /** Format: uuid */
+            paymentId: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: double */
+            amount: number | string;
+            source: string;
+            externalReference: string;
+            /** Format: date-time */
+            postedAtUtc: string;
+            isReversed: boolean;
+        };
+        StatementResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+            /** Format: date-time */
+            producedAtUtc: string;
+            /** Format: double */
+            openingBalance: number | string;
+            /** Format: double */
+            charged: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            closingBalance: number | string;
+            policyIds: string[];
+            charges: components["schemas"]["StatementChargeResponse"][];
+            payments: components["schemas"]["StatementPaymentResponse"][];
+        };
+        StatementSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            currency: string;
+            /** Format: date */
+            periodStart: string;
+            /** Format: date */
+            periodEnd: string;
+            /** Format: date-time */
+            producedAtUtc: string;
+        };
         SubmissionAttachmentDownloadLinkResponse: {
             url: string;
             /** Format: date-time */
@@ -5865,7 +6180,7 @@ export interface operations {
             };
         };
     };
-    DiscardInvoice: {
+    ListCreditNotes: {
         parameters: {
             query?: never;
             header?: never;
@@ -5882,7 +6197,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["InvoiceResponse"];
+                    "application/json": components["schemas"]["CreditNoteResponse"][];
                 };
             };
             /** @description Not Found */
@@ -5892,18 +6207,9 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Conflict */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ProblemDetails"];
-                };
-            };
         };
     };
-    GetInvoice: {
+    IssueCreditNote: {
         parameters: {
             query?: never;
             header?: never;
@@ -5912,15 +6218,28 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IssueCreditNoteRequest"];
+            };
+        };
         responses: {
-            /** @description OK */
-            200: {
+            /** @description Created */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["InvoiceResponse"];
+                    "application/json": components["schemas"]["CreditNoteResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
             /** @description Not Found */
@@ -5930,10 +6249,86 @@ export interface operations {
                 };
                 content?: never;
             };
-        };
-    };
-    RecordPayment: {
-        parameters: {
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    DiscardInvoice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    GetInvoice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RecordPayment: {
+        parameters: {
             query?: never;
             header?: never;
             path: {
@@ -6108,6 +6503,86 @@ export interface operations {
             };
         };
     };
+    GetPaymentReversal: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentReversalResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ReversePayment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ReversePaymentRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentReversalResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     DownloadPaymentEvidence: {
         parameters: {
             query?: never;
@@ -6227,6 +6702,162 @@ export interface operations {
             };
         };
     };
+    ListStatements: {
+        parameters: {
+            query?: {
+                customerId?: 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"]["StatementPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ProduceStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ProduceStatementRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListOwnStatements: {
+        parameters: {
+            query?: {
+                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"]["StatementPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetOwnStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatementResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "1.34.0",
+  "version": "1.36.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,