@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/resources/billingEngine/creditNotes.d.ts

@@ -0,0 +1,655 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Credit notes (`cn_…`, ADR 0018 §4): a finalized invoice credited — on an
+ * `open` one it reduces what is due; on a `paid` one it is given back
+ * (refunded through the invoice's payment, credited to the customer balance,
+ * or recorded as returned outside Orbit).
+ */
+export declare const creditNoteLineItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"credit_note_line_item">;
+    type: z.ZodEnum<{
+        invoice_line_item: "invoice_line_item";
+        custom_line_item: "custom_line_item";
+    }>;
+    invoice_line_item: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    quantity: z.ZodNullable<z.ZodNumber>;
+    amount: z.ZodString;
+    tax_amount: z.ZodString;
+}, z.core.$strict>;
+export type CreditNoteLineItem = z.output<typeof creditNoteLineItemSchema>;
+export declare const creditNoteSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"credit_note">;
+    livemode: z.ZodBoolean;
+    number: z.ZodString;
+    invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+    customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+    status: z.ZodEnum<{
+        void: "void";
+        issued: "issued";
+    }>;
+    type: z.ZodEnum<{
+        pre_payment: "pre_payment";
+        post_payment: "post_payment";
+    }>;
+    reason: z.ZodNullable<z.ZodEnum<{
+        duplicate: "duplicate";
+        fraudulent: "fraudulent";
+        order_change: "order_change";
+        product_unsatisfactory: "product_unsatisfactory";
+    }>>;
+    currency: z.ZodEnum<{
+        FAIR: "FAIR";
+        EUR: "EUR";
+        USD: "USD";
+        GBP: "GBP";
+        CHF: "CHF";
+        SEK: "SEK";
+        NOK: "NOK";
+        DKK: "DKK";
+        PLN: "PLN";
+        CZK: "CZK";
+        CAD: "CAD";
+        AUD: "AUD";
+        JPY: "JPY";
+    }>;
+    lines: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"credit_note_line_item">;
+            type: z.ZodEnum<{
+                invoice_line_item: "invoice_line_item";
+                custom_line_item: "custom_line_item";
+            }>;
+            invoice_line_item: z.ZodNullable<z.ZodString>;
+            description: z.ZodNullable<z.ZodString>;
+            quantity: z.ZodNullable<z.ZodNumber>;
+            amount: z.ZodString;
+            tax_amount: z.ZodString;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    subtotal: z.ZodString;
+    tax: z.ZodString;
+    total: z.ZodString;
+    refund_amount: z.ZodString;
+    credit_amount: z.ZodString;
+    out_of_band_amount: z.ZodString;
+    refund: z.ZodNullable<z.ZodString>;
+    customer_balance_transaction: z.ZodNullable<z.ZodString>;
+    memo: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    voided_at: z.ZodNullable<z.ZodNumber>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type CreditNote = Expand<z.output<typeof creditNoteSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        credit_note: CreditNote;
+    }
+}
+/**
+ * Credit `lines`, or a whole `amount` (custom).
+ *
+ * On a `paid` invoice the credit must be distributed: `refund_amount` (through
+ * the invoice's payment; card only), `credit_amount` (to the customer balance)
+ * and `out_of_band_amount` must add up to the total. Omitted, all of it is
+ * refunded on a card invoice and credited to the balance otherwise. On an
+ * `open` invoice it reduces `amount_due` and none of the three apply.
+ */
+export declare const createCreditNoteParams: z.ZodObject<{
+    lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        quantity: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodEnum<{
+            invoice_line_item: "invoice_line_item";
+            custom_line_item: "custom_line_item";
+        }>;
+        invoice_line_item: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    invoice: z.ZodString;
+    amount: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodEnum<{
+        duplicate: "duplicate";
+        fraudulent: "fraudulent";
+        order_change: "order_change";
+        product_unsatisfactory: "product_unsatisfactory";
+    }>>;
+    memo: z.ZodOptional<z.ZodString>;
+    refund_amount: z.ZodOptional<z.ZodString>;
+    credit_amount: z.ZodOptional<z.ZodString>;
+    out_of_band_amount: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type CreateCreditNoteParams = z.input<typeof createCreditNoteParams>;
+/** The create's fields as a query (`lines[0][type]=…`). */
+export declare const previewCreditNoteQuery: z.ZodObject<{
+    lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        quantity: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        type: z.ZodEnum<{
+            invoice_line_item: "invoice_line_item";
+            custom_line_item: "custom_line_item";
+        }>;
+        invoice_line_item: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>>;
+    invoice: z.ZodString;
+    amount: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodEnum<{
+        duplicate: "duplicate";
+        fraudulent: "fraudulent";
+        order_change: "order_change";
+        product_unsatisfactory: "product_unsatisfactory";
+    }>>;
+    memo: z.ZodOptional<z.ZodString>;
+    refund_amount: z.ZodOptional<z.ZodString>;
+    credit_amount: z.ZodOptional<z.ZodString>;
+    out_of_band_amount: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type PreviewCreditNoteParams = z.input<typeof previewCreditNoteQuery>;
+export declare const voidCreditNoteParams: z.ZodObject<{
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type VoidCreditNoteParams = z.input<typeof voidCreditNoteParams>;
+export declare const listCreditNotesQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    invoice: z.ZodOptional<z.ZodString>;
+    customer: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type CreditNoteListParams = z.input<typeof listCreditNotesQuery>;
+export declare const creditNoteRoutes: readonly [{
+    readonly operationId: "createCreditNote";
+    readonly method: "post";
+    readonly path: "/v1/credit_notes";
+    readonly tag: "Credit notes";
+    readonly summary: "Issue a credit note";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            quantity: z.ZodOptional<z.ZodNumber>;
+            type: z.ZodEnum<{
+                invoice_line_item: "invoice_line_item";
+                custom_line_item: "custom_line_item";
+            }>;
+            invoice_line_item: z.ZodOptional<z.ZodString>;
+            amount: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        invoice: z.ZodString;
+        amount: z.ZodOptional<z.ZodString>;
+        reason: z.ZodOptional<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        memo: z.ZodOptional<z.ZodString>;
+        refund_amount: z.ZodOptional<z.ZodString>;
+        credit_amount: z.ZodOptional<z.ZodString>;
+        out_of_band_amount: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"credit_note">;
+        livemode: z.ZodBoolean;
+        number: z.ZodString;
+        invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        status: z.ZodEnum<{
+            void: "void";
+            issued: "issued";
+        }>;
+        type: z.ZodEnum<{
+            pre_payment: "pre_payment";
+            post_payment: "post_payment";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        lines: z.ZodObject<{
+            object: z.ZodLiteral<"list">;
+            data: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                object: z.ZodLiteral<"credit_note_line_item">;
+                type: z.ZodEnum<{
+                    invoice_line_item: "invoice_line_item";
+                    custom_line_item: "custom_line_item";
+                }>;
+                invoice_line_item: z.ZodNullable<z.ZodString>;
+                description: z.ZodNullable<z.ZodString>;
+                quantity: z.ZodNullable<z.ZodNumber>;
+                amount: z.ZodString;
+                tax_amount: z.ZodString;
+            }, z.core.$strict>>;
+            has_more: z.ZodBoolean;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        subtotal: z.ZodString;
+        tax: z.ZodString;
+        total: z.ZodString;
+        refund_amount: z.ZodString;
+        credit_amount: z.ZodString;
+        out_of_band_amount: z.ZodString;
+        refund: z.ZodNullable<z.ZodString>;
+        customer_balance_transaction: z.ZodNullable<z.ZodString>;
+        memo: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        voided_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "creditNotes.create";
+    readonly expandable: "credit_note";
+}, {
+    readonly operationId: "listCreditNotes";
+    readonly method: "get";
+    readonly path: "/v1/credit_notes";
+    readonly tag: "Credit notes";
+    readonly summary: "List credit notes";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        invoice: z.ZodOptional<z.ZodString>;
+        customer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"credit_note">;
+            livemode: z.ZodBoolean;
+            number: z.ZodString;
+            invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+            customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+            status: z.ZodEnum<{
+                void: "void";
+                issued: "issued";
+            }>;
+            type: z.ZodEnum<{
+                pre_payment: "pre_payment";
+                post_payment: "post_payment";
+            }>;
+            reason: z.ZodNullable<z.ZodEnum<{
+                duplicate: "duplicate";
+                fraudulent: "fraudulent";
+                order_change: "order_change";
+                product_unsatisfactory: "product_unsatisfactory";
+            }>>;
+            currency: z.ZodEnum<{
+                FAIR: "FAIR";
+                EUR: "EUR";
+                USD: "USD";
+                GBP: "GBP";
+                CHF: "CHF";
+                SEK: "SEK";
+                NOK: "NOK";
+                DKK: "DKK";
+                PLN: "PLN";
+                CZK: "CZK";
+                CAD: "CAD";
+                AUD: "AUD";
+                JPY: "JPY";
+            }>;
+            lines: z.ZodObject<{
+                object: z.ZodLiteral<"list">;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    object: z.ZodLiteral<"credit_note_line_item">;
+                    type: z.ZodEnum<{
+                        invoice_line_item: "invoice_line_item";
+                        custom_line_item: "custom_line_item";
+                    }>;
+                    invoice_line_item: z.ZodNullable<z.ZodString>;
+                    description: z.ZodNullable<z.ZodString>;
+                    quantity: z.ZodNullable<z.ZodNumber>;
+                    amount: z.ZodString;
+                    tax_amount: z.ZodString;
+                }, z.core.$strict>>;
+                has_more: z.ZodBoolean;
+                url: z.ZodString;
+            }, z.core.$strict>;
+            subtotal: z.ZodString;
+            tax: z.ZodString;
+            total: z.ZodString;
+            refund_amount: z.ZodString;
+            credit_amount: z.ZodString;
+            out_of_band_amount: z.ZodString;
+            refund: z.ZodNullable<z.ZodString>;
+            customer_balance_transaction: z.ZodNullable<z.ZodString>;
+            memo: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            voided_at: z.ZodNullable<z.ZodNumber>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "creditNotes.list";
+    readonly expandable: "credit_note";
+}, {
+    readonly operationId: "previewCreditNote";
+    readonly method: "get";
+    readonly path: "/v1/credit_notes/preview";
+    readonly tag: "Credit notes";
+    readonly summary: "Preview a credit note";
+    readonly description: "The note `POST /v1/credit_notes` would issue with the same fields, computed and never stored (its `id` and `number` are empty).";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            quantity: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            type: z.ZodEnum<{
+                invoice_line_item: "invoice_line_item";
+                custom_line_item: "custom_line_item";
+            }>;
+            invoice_line_item: z.ZodOptional<z.ZodString>;
+            amount: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        invoice: z.ZodString;
+        amount: z.ZodOptional<z.ZodString>;
+        reason: z.ZodOptional<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        memo: z.ZodOptional<z.ZodString>;
+        refund_amount: z.ZodOptional<z.ZodString>;
+        credit_amount: z.ZodOptional<z.ZodString>;
+        out_of_band_amount: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"credit_note">;
+        livemode: z.ZodBoolean;
+        number: z.ZodString;
+        invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        status: z.ZodEnum<{
+            void: "void";
+            issued: "issued";
+        }>;
+        type: z.ZodEnum<{
+            pre_payment: "pre_payment";
+            post_payment: "post_payment";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        lines: z.ZodObject<{
+            object: z.ZodLiteral<"list">;
+            data: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                object: z.ZodLiteral<"credit_note_line_item">;
+                type: z.ZodEnum<{
+                    invoice_line_item: "invoice_line_item";
+                    custom_line_item: "custom_line_item";
+                }>;
+                invoice_line_item: z.ZodNullable<z.ZodString>;
+                description: z.ZodNullable<z.ZodString>;
+                quantity: z.ZodNullable<z.ZodNumber>;
+                amount: z.ZodString;
+                tax_amount: z.ZodString;
+            }, z.core.$strict>>;
+            has_more: z.ZodBoolean;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        subtotal: z.ZodString;
+        tax: z.ZodString;
+        total: z.ZodString;
+        refund_amount: z.ZodString;
+        credit_amount: z.ZodString;
+        out_of_band_amount: z.ZodString;
+        refund: z.ZodNullable<z.ZodString>;
+        customer_balance_transaction: z.ZodNullable<z.ZodString>;
+        memo: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        voided_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "creditNotes.preview";
+}, {
+    readonly operationId: "retrieveCreditNote";
+    readonly method: "get";
+    readonly path: "/v1/credit_notes/{id}";
+    readonly tag: "Credit notes";
+    readonly summary: "Retrieve a credit note";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The credit note (`cn_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"credit_note">;
+        livemode: z.ZodBoolean;
+        number: z.ZodString;
+        invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        status: z.ZodEnum<{
+            void: "void";
+            issued: "issued";
+        }>;
+        type: z.ZodEnum<{
+            pre_payment: "pre_payment";
+            post_payment: "post_payment";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        lines: z.ZodObject<{
+            object: z.ZodLiteral<"list">;
+            data: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                object: z.ZodLiteral<"credit_note_line_item">;
+                type: z.ZodEnum<{
+                    invoice_line_item: "invoice_line_item";
+                    custom_line_item: "custom_line_item";
+                }>;
+                invoice_line_item: z.ZodNullable<z.ZodString>;
+                description: z.ZodNullable<z.ZodString>;
+                quantity: z.ZodNullable<z.ZodNumber>;
+                amount: z.ZodString;
+                tax_amount: z.ZodString;
+            }, z.core.$strict>>;
+            has_more: z.ZodBoolean;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        subtotal: z.ZodString;
+        tax: z.ZodString;
+        total: z.ZodString;
+        refund_amount: z.ZodString;
+        credit_amount: z.ZodString;
+        out_of_band_amount: z.ZodString;
+        refund: z.ZodNullable<z.ZodString>;
+        customer_balance_transaction: z.ZodNullable<z.ZodString>;
+        memo: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        voided_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "creditNotes.retrieve";
+    readonly expandable: "credit_note";
+}, {
+    readonly operationId: "voidCreditNote";
+    readonly method: "post";
+    readonly path: "/v1/credit_notes/{id}/void";
+    readonly tag: "Credit notes";
+    readonly summary: "Void a credit note";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The credit note (`cn_…`).";
+    };
+    readonly body: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"credit_note">;
+        livemode: z.ZodBoolean;
+        number: z.ZodString;
+        invoice: z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>;
+        customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
+        status: z.ZodEnum<{
+            void: "void";
+            issued: "issued";
+        }>;
+        type: z.ZodEnum<{
+            pre_payment: "pre_payment";
+            post_payment: "post_payment";
+        }>;
+        reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            order_change: "order_change";
+            product_unsatisfactory: "product_unsatisfactory";
+        }>>;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        lines: z.ZodObject<{
+            object: z.ZodLiteral<"list">;
+            data: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                object: z.ZodLiteral<"credit_note_line_item">;
+                type: z.ZodEnum<{
+                    invoice_line_item: "invoice_line_item";
+                    custom_line_item: "custom_line_item";
+                }>;
+                invoice_line_item: z.ZodNullable<z.ZodString>;
+                description: z.ZodNullable<z.ZodString>;
+                quantity: z.ZodNullable<z.ZodNumber>;
+                amount: z.ZodString;
+                tax_amount: z.ZodString;
+            }, z.core.$strict>>;
+            has_more: z.ZodBoolean;
+            url: z.ZodString;
+        }, z.core.$strict>;
+        subtotal: z.ZodString;
+        tax: z.ZodString;
+        total: z.ZodString;
+        refund_amount: z.ZodString;
+        credit_amount: z.ZodString;
+        out_of_band_amount: z.ZodString;
+        refund: z.ZodNullable<z.ZodString>;
+        customer_balance_transaction: z.ZodNullable<z.ZodString>;
+        memo: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        voided_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "creditNotes.voidCreditNote";
+    readonly expandable: "credit_note";
+}];