@maxio-com/advanced-billing-sdk/dist/types/models/debitNote.d.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 { Schema } from '../schema';
import { CreditNoteLineItem } from './creditNoteLineItem';
import { DebitNoteRole } from './debitNoteRole';
import { DebitNoteStatus } from './debitNoteStatus';
import { InvoiceAddress } from './invoiceAddress';
import { InvoiceCustomer } from './invoiceCustomer';
import { InvoiceDiscount } from './invoiceDiscount';
import { InvoiceRefund } from './invoiceRefund';
import { InvoiceSeller } from './invoiceSeller';
import { InvoiceTax } from './invoiceTax';
export interface DebitNote {
    /** Unique identifier for the debit note. It is generated automatically by Chargify and has the prefix "db_" followed by alphanumeric characters. */
    uid?: string;
    /** ID of the site to which the debit note belongs. */
    siteId?: number;
    /** ID of the customer to which the debit note belongs. */
    customerId?: number;
    /** ID of the subscription that generated the debit note. */
    subscriptionId?: number;
    /** A unique, identifier that appears on the debit note and in places it is referenced. */
    number?: number;
    /** A monotonically increasing number assigned to debit notes as they are created. */
    sequenceNumber?: number;
    /**
     * Unique identifier for the connected credit note. It is generated automatically by Chargify and has the prefix "cn_" followed by alphanumeric characters.
     * While the UID is long and not appropriate to show to customers, the number is usually shorter and consumable by the customer and the merchant alike.
     */
    originCreditNoteUid?: string;
    /** A unique, identifying string of the connected credit note. */
    originCreditNoteNumber?: string;
    /**
     * Date the document was issued to the customer. This is the date that the document was made available for payment.
     * The format is "YYYY-MM-DD".
     */
    issueDate?: string;
    /**
     * Debit notes are applied to invoices to offset invoiced amounts - they adjust the amount due. This field is the date the debit note document became fully applied to the invoice.
     * The format is "YYYY-MM-DD".
     */
    appliedDate?: string;
    /** Date the document is due for payment. The format is "YYYY-MM-DD". */
    dueDate?: string;
    /** Current status of the debit note. */
    status?: DebitNoteStatus;
    /** The memo printed on debit note, which is a description of the reason for the debit. */
    memo?: string;
    /** The role of the debit note. */
    role?: DebitNoteRole;
    /** The ISO 4217 currency code (3 character string) representing the currency of the credit note amount fields. */
    currency?: string;
    /** Information about the seller (merchant) listed on the masthead of the debit note. */
    seller?: InvoiceSeller;
    /** Information about the customer who is owner or recipient the debited subscription. */
    customer?: InvoiceCustomer;
    /** The billing address of the debited subscription. */
    billingAddress?: InvoiceAddress;
    /** The shipping address of the debited subscription. */
    shippingAddress?: InvoiceAddress;
    /** Line items on the debit note. */
    lineItems?: CreditNoteLineItem[];
    discounts?: InvoiceDiscount[];
    taxes?: InvoiceTax[];
    refunds?: InvoiceRefund[];
    [key: string]: unknown;
}
export declare const debitNoteSchema: Schema<DebitNote>;
//# sourceMappingURL=debitNote.d.ts.map