@getopenpay/client/models/CreateCreditNoteRequest.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 { CreditNoteReason } from './CreditNoteReason';
import type { CreateCreditNoteLine } from './CreateCreditNoteLine';
import type { CurrencyEnum } from './CurrencyEnum';
/**
 *
 * @export
 * @interface CreateCreditNoteRequest
 */
export interface CreateCreditNoteRequest {
    /**
     * The integer amount representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.
     * @type {number}
     * @memberof CreateCreditNoteRequest
     */
    creditAmountAtom?: number;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof CreateCreditNoteRequest
     */
    currency?: CurrencyEnum;
    /**
     * ID of the invoice
     * @type {string}
     * @memberof CreateCreditNoteRequest
     */
    invoiceId: string;
    /**
     * Line items that make up the credit note.
     * @type {Array<CreateCreditNoteLine>}
     * @memberof CreateCreditNoteRequest
     */
    lines: Array<CreateCreditNoteLine>;
    /**
     *
     * @type {CreditNoteReason}
     * @memberof CreateCreditNoteRequest
     */
    reason?: CreditNoteReason | null;
    /**
     * The integer amount representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
     * @type {number}
     * @memberof CreateCreditNoteRequest
     */
    refundAmountAtom?: number;
    /**
     * The int amount representing the total amount of the credit note.
     * @type {number}
     * @memberof CreateCreditNoteRequest
     */
    totalAmountAtom: number;
}
/**
 * Check if a given object implements the CreateCreditNoteRequest interface.
 */
export declare function instanceOfCreateCreditNoteRequest(value: object): value is CreateCreditNoteRequest;
export declare function CreateCreditNoteRequestFromJSON(json: any): CreateCreditNoteRequest;
export declare function CreateCreditNoteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCreditNoteRequest;
export declare function CreateCreditNoteRequestToJSON(json: any): CreateCreditNoteRequest;
export declare function CreateCreditNoteRequestToJSONTyped(value?: CreateCreditNoteRequest | null, ignoreDiscriminator?: boolean): any;