@getopenpay/client/models/CreateCreditNoteLine.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';
/**
 *
 * @export
 * @interface CreateCreditNoteLine
 */
export interface CreateCreditNoteLine {
    /**
     * The integer amount representing the gross amount being credited for this line item.
     * @type {number}
     * @memberof CreateCreditNoteLine
     */
    amountAtom: number;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof CreateCreditNoteLine
     */
    currency: CurrencyEnum;
    /**
     *
     * @type {string}
     * @memberof CreateCreditNoteLine
     */
    invoiceItemId?: string | null;
    /**
     *
     * @type {number}
     * @memberof CreateCreditNoteLine
     */
    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 CreateCreditNoteLine
     */
    type: CreditNoteLineType;
    /**
     *
     * @type {number}
     * @memberof CreateCreditNoteLine
     */
    unitAmountAtom?: number | null;
}
/**
 * Check if a given object implements the CreateCreditNoteLine interface.
 */
export declare function instanceOfCreateCreditNoteLine(value: object): value is CreateCreditNoteLine;
export declare function CreateCreditNoteLineFromJSON(json: any): CreateCreditNoteLine;
export declare function CreateCreditNoteLineFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCreditNoteLine;
export declare function CreateCreditNoteLineToJSON(json: any): CreateCreditNoteLine;
export declare function CreateCreditNoteLineToJSONTyped(value?: CreateCreditNoteLine | null, ignoreDiscriminator?: boolean): any;