@maxio-com/advanced-billing-sdk/src/models/applyDebitNoteEventData.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 { expandoObject, nullable, optional, Schema, string } from '../schema';

/** Example schema for an `apply_debit_note` event */
export interface ApplyDebitNoteEventData {
  /** A unique, identifying string that appears on the debit note and in places it is referenced. */
  debitNoteNumber: string;
  /** Unique identifier for the debit note. It is generated automatically by Chargify and has the prefix "db_" followed by alphanumeric characters. */
  debitNoteUid: string;
  /** The full, original amount of the debit note. */
  originalAmount: string;
  /** The amount of the debit note applied to invoice. */
  appliedAmount: string;
  /** The debit note memo. */
  memo?: string | null;
  /** The time the debit note was applied, in ISO 8601 format, i.e. "2019-06-07T17:20:06Z" */
  transactionTime?: string | null;
  [key: string]: unknown;
}

export const applyDebitNoteEventDataSchema: Schema<ApplyDebitNoteEventData> = expandoObject(
  {
    debitNoteNumber: ['debit_note_number', string()],
    debitNoteUid: ['debit_note_uid', string()],
    originalAmount: ['original_amount', string()],
    appliedAmount: ['applied_amount', string()],
    memo: ['memo', optional(nullable(string()))],
    transactionTime: ['transaction_time', optional(nullable(string()))],
  }
);