@insurance-broker/api-client 1.33.0 → 1.35.0

package/dist/schema.d.ts

@@ -74,6 +74,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/obligations/{id}/write-off": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Forgive a debt that will not be collected
+         * @description PAY-002, and ADR-0042 section 12's anchoring event. Records that a **real** debt will not be collected, with the reason on the record.
+         *
+         *     **This is not a cancellation.** Cancelling says the charge should never have existed; writing off says it should have been paid and will not be. A broker asking "how much did we forgive" needs the two apart, so they are separate acts with separate audit actions.
+         *
+         *     **The reason is required and is the broker's own words.** This platform declares no vocabulary of write-off reasons, because why a debt is forgiven is a broker's collections policy rather than a platform's.
+         *
+         *     **It is why an obligation nobody will chase is not kept for ever.** An unsettled charge has no retention anchor and is therefore kept (ADR-0038 section 2); writing one off is the event that starts its clock.
+         *
+         *     Refused on a charge that has already concluded — a settled one was paid and a cancelled one was never owed — rather than silently re-stamping an anchor.
+         */
+        post: operations["WriteOffObligation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/invoices": {
         parameters: {
             query?: never;
@@ -148,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;
@@ -320,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;
@@ -4039,6 +4133,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;
@@ -4553,6 +4679,10 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             lines: components["schemas"]["InvoiceLineResponse"][];
         };
+        IssueCreditNoteRequest: {
+            reason: string;
+            lines: components["schemas"]["CreditNoteLineRequest"][];
+        };
         IssuedCustomerInvitationResponse: {
             /** Format: uuid */
             id: string;
@@ -4641,6 +4771,7 @@ export interface components {
             raisedAtUtc: string;
             /** Format: date-time */
             retentionAnchorAtUtc: null | string;
+            writeOffReason: null | string;
         };
         OfferedFormResponse: {
             /** Format: uuid */
@@ -4798,6 +4929,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;
@@ -5377,6 +5521,9 @@ export interface components {
             updatedAtUtc: null | string;
             setBySubjectId: null | string;
         };
+        ReversePaymentRequest: {
+            reason: string;
+        };
         ReviseComparisonSchemaBodyRequest: {
             body: null | string;
             /** Format: int32 */
@@ -5551,6 +5698,9 @@ export interface components {
         WriteClaimNoteRequest: {
             body: string;
         };
+        WriteOffObligationRequest: {
+            reason: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -5660,6 +5810,57 @@ export interface operations {
             };
         };
     };
+    WriteOffObligation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WriteOffObligationRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ObligationResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     DraftInvoice: {
         parameters: {
             query?: never;
@@ -5782,6 +5983,86 @@ export interface operations {
             };
         };
     };
+    ListCreditNotes: {
+        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"]["CreditNoteResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    IssueCreditNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IssueCreditNoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreditNoteResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     DiscardInvoice: {
         parameters: {
             query?: never;
@@ -6025,6 +6306,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;

package/package.json

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