@getopenpay/client/models/CreditNoteItemExternal.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 { CreditNoteLineType } from './CreditNoteLineType';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface CreditNoteItemExternal
 */
export interface CreditNoteItemExternal {
    /**
     * The integer amount representing the gross amount being credited for this credit_note_item. It is in atomic units (in USD this is cents).
     * @type {number}
     * @memberof CreditNoteItemExternal
     */
    amountAtom: number;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CreditNoteItemExternal
     */
    createdAt: Date;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof CreditNoteItemExternal
     */
    currency: CurrencyEnum;
    /**
     * Unique Identifier of the credit_note_item.
     * @type {string}
     * @memberof CreditNoteItemExternal
     */
    id: string;
    /**
     *
     * @type {string}
     * @memberof CreditNoteItemExternal
     */
    invoiceItemId?: string | null;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof CreditNoteItemExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof CreditNoteItemExternal
     */
    object?: ObjectName;
    /**
     * Quantity of the product being credited.
     * @type {number}
     * @memberof CreditNoteItemExternal
     */
    quantity?: number;
    /**
     * The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
     * @type {CreditNoteLineType}
     * @memberof CreditNoteItemExternal
     */
    type: CreditNoteLineType;
    /**
     *
     * @type {number}
     * @memberof CreditNoteItemExternal
     */
    unitAmountAtom?: number | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CreditNoteItemExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the CreditNoteItemExternal interface.
 */
export declare function instanceOfCreditNoteItemExternal(value: object): value is CreditNoteItemExternal;
export declare function CreditNoteItemExternalFromJSON(json: any): CreditNoteItemExternal;
export declare function CreditNoteItemExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreditNoteItemExternal;
export declare function CreditNoteItemExternalToJSON(json: any): CreditNoteItemExternal;
export declare function CreditNoteItemExternalToJSONTyped(value?: CreditNoteItemExternal | null, ignoreDiscriminator?: boolean): any;