@maxio-com/advanced-billing-sdk
Version:
Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.
25 lines • 1.25 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema.js';
import { RefundConsolidatedInvoiceSegmentUids } from './containers/refundConsolidatedInvoiceSegmentUids.js';
/** Refund consolidated invoice */
export interface RefundConsolidatedInvoice {
/** A description for the refund */
memo: string;
/** The ID of the payment to be refunded */
paymentId: number;
/** An array of segment uids to refund or the string 'all' to indicate that all segments should be refunded */
segmentUids: RefundConsolidatedInvoiceSegmentUids;
/** Flag that marks refund as external (no money is returned to the customer). Defaults to `false`. */
external?: boolean;
/** If set to true, creates credit and applies it to an invoice. Defaults to `false`. */
applyCredit?: boolean;
/** The amount of payment to be refunded in decimal format. Example: "10.50". This will default to the full amount of the payment if not provided. */
amount?: string;
[key: string]: unknown;
}
export declare const refundConsolidatedInvoiceSchema: Schema<RefundConsolidatedInvoice>;
//# sourceMappingURL=refundConsolidatedInvoice.d.ts.map