@maxio-com/advanced-billing-sdk/src/models/invoicePayment.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 {
  boolean,
  expandoObject,
  lazy,
  nullable,
  number,
  optional,
  Schema,
  string,
} from '../schema.js';
import {
  InvoicePaymentMethod,
  invoicePaymentMethodSchema,
} from './invoicePaymentMethod.js';

export interface InvoicePayment {
  transactionTime?: string;
  memo?: string;
  originalAmount?: string;
  appliedAmount?: string;
  paymentMethod?: InvoicePaymentMethod;
  transactionId?: number;
  prepayment?: boolean;
  gatewayHandle?: string | null;
  gatewayUsed?: string;
  /** The transaction ID for the payment as returned from the payment gateway */
  gatewayTransactionId?: string | null;
  /**
   * Date reflecting when the payment was received from a customer. Must be in the past. Applicable only to
   * `external` payments.
   */
  receivedOn?: string | null;
  uid?: string;
  [key: string]: unknown;
}

export const invoicePaymentSchema: Schema<InvoicePayment> = lazy(() =>
  expandoObject({
    transactionTime: ['transaction_time', optional(string())],
    memo: ['memo', optional(string())],
    originalAmount: ['original_amount', optional(string())],
    appliedAmount: ['applied_amount', optional(string())],
    paymentMethod: ['payment_method', optional(invoicePaymentMethodSchema)],
    transactionId: ['transaction_id', optional(number())],
    prepayment: ['prepayment', optional(boolean())],
    gatewayHandle: ['gateway_handle', optional(nullable(string()))],
    gatewayUsed: ['gateway_used', optional(string())],
    gatewayTransactionId: [
      'gateway_transaction_id',
      optional(nullable(string())),
    ],
    receivedOn: ['received_on', optional(nullable(string()))],
    uid: ['uid', optional(string())],
  })
);