@getopenpay/client/models/CreateInvoiceRequest.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { CollectionMethodEnum } from './CollectionMethodEnum';
import type { SelectedPriceQuantity } from './SelectedPriceQuantity';
import type { InvoiceItemDetails } from './InvoiceItemDetails';
import type { InvoiceType } from './InvoiceType';
/**
 *
 * @export
 * @interface CreateInvoiceRequest
 */
export interface CreateInvoiceRequest {
    /**
     *
     * @type {CollectionMethodEnum}
     * @memberof CreateInvoiceRequest
     */
    collectionMethod?: CollectionMethodEnum | null;
    /**
     *
     * @type {string}
     * @memberof CreateInvoiceRequest
     */
    couponId?: string | null;
    /**
     *
     * @type {object}
     * @memberof CreateInvoiceRequest
     */
    customFields?: object | null;
    /**
     * The external id of the customer.
     * @type {string}
     * @memberof CreateInvoiceRequest
     */
    customerId: string;
    /**
     * Description for newly created invoice
     * @type {string}
     * @memberof CreateInvoiceRequest
     */
    description?: string;
    /**
     *
     * @type {boolean}
     * @memberof CreateInvoiceRequest
     */
    emailInvoiceOnFinalization?: boolean | null;
    /**
     *
     * @type {boolean}
     * @memberof CreateInvoiceRequest
     */
    finalizeInvoiceImmediately?: boolean | null;
    /**
     *
     * @type {{ [key: string]: InvoiceItemDetails; }}
     * @memberof CreateInvoiceRequest
     */
    invoiceItemDetails?: {
        [key: string]: InvoiceItemDetails;
    } | null;
    /**
     * The type of invoice to create. Choose standard to create the subscription based invoice and one_off to create the one-off invoices.
     * @type {InvoiceType}
     * @memberof CreateInvoiceRequest
     */
    invoiceType?: InvoiceType;
    /**
     * Whether the request is in preview mode (Invoice won't actually be created)
     * @type {boolean}
     * @memberof CreateInvoiceRequest
     */
    isPreview?: boolean;
    /**
     *
     * @type {number}
     * @memberof CreateInvoiceRequest
     */
    netD?: number | null;
    /**
     *
     * @type {string}
     * @memberof CreateInvoiceRequest
     */
    paymentMethodId?: string | null;
    /**
     * This object contains details of selected product' price and quantity.
     * @type {Array<SelectedPriceQuantity>}
     * @memberof CreateInvoiceRequest
     */
    selectedProductPriceQuantity?: Array<SelectedPriceQuantity>;
    /**
     *
     * @type {string}
     * @memberof CreateInvoiceRequest
     */
    subscriptionId?: string | null;
}
/**
 * Check if a given object implements the CreateInvoiceRequest interface.
 */
export declare function instanceOfCreateInvoiceRequest(value: object): value is CreateInvoiceRequest;
export declare function CreateInvoiceRequestFromJSON(json: any): CreateInvoiceRequest;
export declare function CreateInvoiceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateInvoiceRequest;
export declare function CreateInvoiceRequestToJSON(json: any): CreateInvoiceRequest;
export declare function CreateInvoiceRequestToJSONTyped(value?: CreateInvoiceRequest | null, ignoreDiscriminator?: boolean): any;