@maxio-com/advanced-billing-sdk/src/models/createInvoice.ts

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,
  expandoObject,
  lazy,
  number,
  optional,
  Schema,
  string,
} from '../schema';
import {
  CreateInvoiceAddress,
  createInvoiceAddressSchema,
} from './createInvoiceAddress';
import {
  CreateInvoiceCoupon,
  createInvoiceCouponSchema,
} from './createInvoiceCoupon';
import {
  CreateInvoiceItem,
  createInvoiceItemSchema,
} from './createInvoiceItem';
import {
  CreateInvoiceStatus,
  createInvoiceStatusSchema,
} from './createInvoiceStatus';

export interface CreateInvoice {
  lineItems?: CreateInvoiceItem[];
  issueDate?: string;
  /** By default, invoices will be created with a due date matching the date of invoice creation. If a different due date is desired, the net_terms parameter can be sent indicating the number of days in advance the due date should be. */
  netTerms?: number;
  paymentInstructions?: string;
  /** A custom memo can be sent to override the site's default. */
  memo?: string;
  /** Overrides the defaults for the site */
  sellerAddress?: CreateInvoiceAddress;
  /** Overrides the default for the customer */
  billingAddress?: CreateInvoiceAddress;
  /** Overrides the default for the customer */
  shippingAddress?: CreateInvoiceAddress;
  coupons?: CreateInvoiceCoupon[];
  status?: CreateInvoiceStatus;
  [key: string]: unknown;
}

export const createInvoiceSchema: Schema<CreateInvoice> = expandoObject({
  lineItems: [
    'line_items',
    optional(array(lazy(() => createInvoiceItemSchema))),
  ],
  issueDate: ['issue_date', optional(string())],
  netTerms: ['net_terms', optional(number())],
  paymentInstructions: ['payment_instructions', optional(string())],
  memo: ['memo', optional(string())],
  sellerAddress: [
    'seller_address',
    optional(lazy(() => createInvoiceAddressSchema)),
  ],
  billingAddress: [
    'billing_address',
    optional(lazy(() => createInvoiceAddressSchema)),
  ],
  shippingAddress: [
    'shipping_address',
    optional(lazy(() => createInvoiceAddressSchema)),
  ],
  coupons: ['coupons', optional(array(lazy(() => createInvoiceCouponSchema)))],
  status: ['status', optional(createInvoiceStatusSchema)],
});