@getopenpay/client/models/CreditNoteExternal.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 { CreditNoteItemExternal } from './CreditNoteItemExternal';
import type { CreditNoteReason } from './CreditNoteReason';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface CreditNoteExternal
 */
export interface CreditNoteExternal {
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CreditNoteExternal
     */
    createdAt: Date;
    /**
     * The integer amount representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice. It is in atomic units (in USD this is cents).
     * @type {number}
     * @memberof CreditNoteExternal
     */
    creditAmountAtom: number;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof CreditNoteExternal
     */
    currency: CurrencyEnum;
    /**
     * Unique Identifier of the credit_note.
     * @type {string}
     * @memberof CreditNoteExternal
     */
    id: string;
    /**
     * Unique ID of the invoice.
     * @type {string}
     * @memberof CreditNoteExternal
     */
    invoiceId: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof CreditNoteExternal
     */
    isDeleted?: boolean;
    /**
     * List of credit_note_items.
     * @type {Array<CreditNoteItemExternal>}
     * @memberof CreditNoteExternal
     */
    items: Array<CreditNoteItemExternal>;
    /**
     *
     * @type {ObjectName}
     * @memberof CreditNoteExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {CreditNoteReason}
     * @memberof CreditNoteExternal
     */
    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. It is in atomic units (in USD this is cents).
     * @type {number}
     * @memberof CreditNoteExternal
     */
    refundAmountAtom: number;
    /**
     * The integer amount representing the total amount of the credit note. It is in atomic units (in USD this is cents).
     * @type {number}
     * @memberof CreditNoteExternal
     */
    totalAmountAtom: number;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CreditNoteExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the CreditNoteExternal interface.
 */
export declare function instanceOfCreditNoteExternal(value: object): value is CreditNoteExternal;
export declare function CreditNoteExternalFromJSON(json: any): CreditNoteExternal;
export declare function CreditNoteExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreditNoteExternal;
export declare function CreditNoteExternalToJSON(json: any): CreditNoteExternal;
export declare function CreditNoteExternalToJSONTyped(value?: CreditNoteExternal | null, ignoreDiscriminator?: boolean): any;