@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.
72 lines • 3.45 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { CollectionMethod } from './collectionMethod';
import { InvoiceAddress } from './invoiceAddress';
import { InvoiceConsolidationLevel } from './invoiceConsolidationLevel';
import { InvoiceCustomer } from './invoiceCustomer';
import { InvoiceCustomField } from './invoiceCustomField';
import { InvoiceLineItem } from './invoiceLineItem';
import { InvoiceSeller } from './invoiceSeller';
import { ProformaInvoiceCredit } from './proformaInvoiceCredit';
import { ProformaInvoiceDiscount } from './proformaInvoiceDiscount';
import { ProformaInvoicePayment } from './proformaInvoicePayment';
import { ProformaInvoiceRole } from './proformaInvoiceRole';
import { ProformaInvoiceStatus } from './proformaInvoiceStatus';
import { ProformaInvoiceTax } from './proformaInvoiceTax';
export interface ProformaInvoice {
uid?: string;
siteId?: number;
customerId?: number | null;
subscriptionId?: number | null;
number?: number | null;
sequenceNumber?: number | null;
createdAt?: string;
deliveryDate?: string;
status?: ProformaInvoiceStatus;
/** The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`. */
collectionMethod?: CollectionMethod;
paymentInstructions?: string;
currency?: string;
/**
* Consolidation level of the invoice, which is applicable to invoice consolidation. It will hold one of the following values:
* * "none": A normal invoice with no consolidation.
* * "child": An invoice segment which has been combined into a consolidated invoice.
* * "parent": A consolidated invoice, whose contents are composed of invoice segments.
* "Parent" invoices do not have lines of their own, but they have subtotals and totals which aggregate the member invoice segments.
* See also the [invoice consolidation documentation](https://maxio.zendesk.com/hc/en-us/articles/24252269909389-Invoice-Consolidation).
*/
consolidationLevel?: InvoiceConsolidationLevel;
productName?: string;
productFamilyName?: string;
/** 'proforma' value is deprecated in favor of proforma_adhoc and proforma_automatic */
role?: ProformaInvoiceRole;
/** Information about the seller (merchant) listed on the masthead of the invoice. */
seller?: InvoiceSeller;
/** Information about the customer who is owner or recipient the invoiced subscription. */
customer?: InvoiceCustomer;
memo?: string;
billingAddress?: InvoiceAddress;
shippingAddress?: InvoiceAddress;
subtotalAmount?: string;
discountAmount?: string;
taxAmount?: string;
totalAmount?: string;
creditAmount?: string;
paidAmount?: string;
refundAmount?: string;
dueAmount?: string;
lineItems?: InvoiceLineItem[];
discounts?: ProformaInvoiceDiscount[];
taxes?: ProformaInvoiceTax[];
credits?: ProformaInvoiceCredit[];
payments?: ProformaInvoicePayment[];
customFields?: InvoiceCustomField[];
publicUrl?: string | null;
[key: string]: unknown;
}
export declare const proformaInvoiceSchema: Schema<ProformaInvoice>;
//# sourceMappingURL=proformaInvoice.d.ts.map