@maxio-com/advanced-billing-sdk/dist/esm/models/invoice.js

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.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */
import { array, bigint, expandoObject, lazy, nullable, number, optional, string, } from '../schema';
import { collectionMethodSchema } from './collectionMethod';
import { invoiceAddressSchema } from './invoiceAddress';
import { invoiceAvataxDetailsSchema, } from './invoiceAvataxDetails';
import { invoiceConsolidationLevelSchema, } from './invoiceConsolidationLevel';
import { invoiceCreditSchema } from './invoiceCredit';
import { invoiceCustomerSchema } from './invoiceCustomer';
import { invoiceCustomFieldSchema, } from './invoiceCustomField';
import { invoiceDebitSchema } from './invoiceDebit';
import { invoiceDiscountSchema } from './invoiceDiscount';
import { invoiceDisplaySettingsSchema, } from './invoiceDisplaySettings';
import { invoiceLineItemSchema } from './invoiceLineItem';
import { invoicePayerSchema } from './invoicePayer';
import { invoicePaymentSchema } from './invoicePayment';
import { invoicePreviousBalanceSchema, } from './invoicePreviousBalance';
import { invoiceRefundSchema } from './invoiceRefund';
import { invoiceRoleSchema } from './invoiceRole';
import { invoiceSellerSchema } from './invoiceSeller';
import { invoiceStatusSchema } from './invoiceStatus';
import { invoiceTaxSchema } from './invoiceTax';
export const invoiceSchema = expandoObject({
    id: ['id', optional(bigint())],
    uid: ['uid', optional(string())],
    siteId: ['site_id', optional(number())],
    customerId: ['customer_id', optional(number())],
    subscriptionId: ['subscription_id', optional(number())],
    number: ['number', optional(string())],
    sequenceNumber: ['sequence_number', optional(number())],
    transactionTime: ['transaction_time', optional(string())],
    createdAt: ['created_at', optional(string())],
    updatedAt: ['updated_at', optional(string())],
    issueDate: ['issue_date', optional(string())],
    dueDate: ['due_date', optional(string())],
    paidDate: ['paid_date', optional(nullable(string()))],
    status: ['status', optional(invoiceStatusSchema)],
    role: ['role', optional(invoiceRoleSchema)],
    parentInvoiceId: ['parent_invoice_id', optional(nullable(number()))],
    collectionMethod: ['collection_method', optional(collectionMethodSchema)],
    paymentInstructions: ['payment_instructions', optional(string())],
    currency: ['currency', optional(string())],
    consolidationLevel: [
        'consolidation_level',
        optional(invoiceConsolidationLevelSchema),
    ],
    parentInvoiceUid: ['parent_invoice_uid', optional(nullable(string()))],
    subscriptionGroupId: ['subscription_group_id', optional(nullable(number()))],
    parentInvoiceNumber: ['parent_invoice_number', optional(nullable(number()))],
    groupPrimarySubscriptionId: [
        'group_primary_subscription_id',
        optional(nullable(number())),
    ],
    productName: ['product_name', optional(string())],
    productFamilyName: ['product_family_name', optional(string())],
    seller: ['seller', optional(lazy(() => invoiceSellerSchema))],
    customer: ['customer', optional(lazy(() => invoiceCustomerSchema))],
    payer: ['payer', optional(lazy(() => invoicePayerSchema))],
    recipientEmails: ['recipient_emails', optional(array(string()))],
    netTerms: ['net_terms', optional(number())],
    memo: ['memo', optional(string())],
    billingAddress: [
        'billing_address',
        optional(lazy(() => invoiceAddressSchema)),
    ],
    shippingAddress: [
        'shipping_address',
        optional(lazy(() => invoiceAddressSchema)),
    ],
    subtotalAmount: ['subtotal_amount', optional(string())],
    discountAmount: ['discount_amount', optional(string())],
    taxAmount: ['tax_amount', optional(string())],
    totalAmount: ['total_amount', optional(string())],
    creditAmount: ['credit_amount', optional(string())],
    debitAmount: ['debit_amount', optional(string())],
    refundAmount: ['refund_amount', optional(string())],
    paidAmount: ['paid_amount', optional(string())],
    dueAmount: ['due_amount', optional(string())],
    lineItems: ['line_items', optional(array(lazy(() => invoiceLineItemSchema)))],
    discounts: ['discounts', optional(array(lazy(() => invoiceDiscountSchema)))],
    taxes: ['taxes', optional(array(lazy(() => invoiceTaxSchema)))],
    credits: ['credits', optional(array(lazy(() => invoiceCreditSchema)))],
    debits: ['debits', optional(array(lazy(() => invoiceDebitSchema)))],
    refunds: ['refunds', optional(array(lazy(() => invoiceRefundSchema)))],
    payments: ['payments', optional(array(lazy(() => invoicePaymentSchema)))],
    customFields: [
        'custom_fields',
        optional(array(lazy(() => invoiceCustomFieldSchema))),
    ],
    displaySettings: [
        'display_settings',
        optional(lazy(() => invoiceDisplaySettingsSchema)),
    ],
    avataxDetails: [
        'avatax_details',
        optional(lazy(() => invoiceAvataxDetailsSchema)),
    ],
    publicUrl: ['public_url', optional(string())],
    previousBalanceData: [
        'previous_balance_data',
        optional(lazy(() => invoicePreviousBalanceSchema)),
    ],
    publicUrlExpiresOn: ['public_url_expires_on', optional(string())],
});
//# sourceMappingURL=invoice.js.map