platform-types 1.10.839 → 1.10.840

package/dist/purchaseWithdrawal.d.ts

@@ -151,6 +151,20 @@ declare global {
     type PurchaseWithdrawalIneligibleReason = (typeof PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS)[number];
     type PurchaseWithdrawalGuestIntent = (typeof PURCHASE_WITHDRAWAL_GUEST_INTENTS)[number];
     type PurchaseWithdrawalFiscalInFlightCause = (typeof PURCHASE_WITHDRAWAL_FISCAL_IN_FLIGHT_CAUSES)[number];
+    /** A withdrawal credit note's failure cause: a return's, plus one only a withdrawal stores. */
+    type PurchaseWithdrawalCreditNoteErrorCode = ReturnCreditNoteErrorCode | 'RETURN_LEDGER_BASIS_UNAVAILABLE';
+    /** Why a withdrawal's credit note is `not_requested`: FAC already credited, no FAC yet, FAC rejected. */
+    type PurchaseWithdrawalCreditNoteSkip = 'fac-credited' | 'no-fac-counsel-pending' | 'fac-rejected';
+    /**
+     * The `return-credit-note` retry's refusal codes for a withdrawal's note: a return's, plus
+     * `PURCHASE_WITHDRAWAL_NOT_FOUND` (404) — no withdrawal row under that `orderId` and `withdrawalId`.
+     * Two of a return's codes cover more for a withdrawal:
+     * - `NC_OUTCOME_UNCONFIRMED` (503) also answers the handled waits — the factura the note credits, or an
+     *   earlier credit note of it, is still `pending_cae`. Nothing was issued; the `message` names which one.
+     * - `NC_NOT_REQUESTED` (409) also answers a `rejected` note stored without its allocation and order-index
+     *   subset: what to credit could not be determined, so the note is issued by hand, never retried.
+     */
+    type PurchaseWithdrawalCreditNoteRetryErrorCode = ReturnCreditNoteRetryErrorCode | 'PURCHASE_WITHDRAWAL_NOT_FOUND';
     /** One withdrawn order line, by its index in `Order.items`. */
     interface PurchaseWithdrawalLine {
         orderItemIndex: number;
@@ -247,6 +261,16 @@ declare global {
         declineReason?: PurchaseWithdrawalDeclineReason;
         /** The operator's own words on a decline. Removed by a customer erasure; never in an audit row. */
         declineNote?: string;
+        /** The credit note of the order's cancellation; absent when none was planned. Never moves `revision`. */
+        ncStatus?: ReturnCreditNoteStatus;
+        /** The credit note's ARCA voucher NUMBER (`String(invoice.invoiceNumber)`), once `authorized` — not an INVOICE id. */
+        creditNoteId?: string;
+        /** Machine-readable cause when `ncStatus` is `rejected`. */
+        ncErrorCode?: PurchaseWithdrawalCreditNoteErrorCode;
+        /** Unix ms — when the credit note last went into `pending`. */
+        ncPendingSince?: number;
+        /** Why `ncStatus` is `not_requested`. */
+        creditNoteSkip?: PurchaseWithdrawalCreditNoteSkip;
         /** Bumped by every move, for a compare-and-set. */
         revision: number;
         /** Unix ms. */
@@ -254,6 +278,11 @@ declare global {
         /** Unix ms of the last move. */
         revisedAt: number;
     }
+    /**
+     * What the `return-credit-note` retry answers for a withdrawal's note: its credit-note fields and the ids that
+     * name it, nothing else — the retry is open to a `creditNote` holder who may not read customers.
+     */
+    type PurchaseWithdrawalCreditNoteView = Pick<PurchaseWithdrawal, 'withdrawalId' | 'orderId' | 'ncStatus' | 'creditNoteId' | 'ncErrorCode' | 'ncPendingSince' | 'creditNoteSkip'>;
     /**
      * The undecided request an order carries, stamped on the ORDER row while
      * the request is `requested` and removed in the decision's transaction. Its

package/dist/return.d.ts

@@ -1011,6 +1011,14 @@ declare global {
         mode: 'return-credit-note';
         returnId: string;
     }
+    /** The same retry for the credit note of a purchase withdrawal's cancellation. */
+    interface RetryPurchaseWithdrawalCreditNoteRequest {
+        mode: 'return-credit-note';
+        orderId: string;
+        withdrawalId: string;
+    }
+    /** The `return-credit-note` body: a return's, or a purchase withdrawal's — never both. */
+    type RetryCreditNoteRequest = RetryReturnCreditNoteRequest | RetryPurchaseWithdrawalCreditNoteRequest;
     /**
      * `POST /orders` with `mode: 'return-disposition'` — re-grade ONE line of a
      * committed return. ADMIN/MANAGER only, and the `Idempotency-Key` header is

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.839",
+	"version": "1.10.840",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",