sc-cobre-facil/dist/interfaces/MonthlyPayment.d.ts

Biblioteca TypeScript para consumir a API da Cobre Fácil

import { MonthlyPaymentItem } from "./MonthlyPaymentItem";
import { MonthlyPaymentSettings } from "./MonthlyPaymentSettings";
/**
 * Represents a monthly payment with details about its configuration, status, and associated data.
 */
export interface MonthlyPayment {
    /**
     * Unique identifier for the monthly payment.
     */
    id: string;
    /**
     * Attachment associated with the payment, if any.
     */
    attachment: string | null;
    /**
     * Contract number associated with the payment, if any.
     */
    contract_number: string | null;
    /**
     * Date when the invoice was created.
     */
    create_invoice: string;
    /**
     * Identifier of the customer associated with the payment.
     */
    customer_id: string;
    /**
     * Day of the month when the payment is due.
     */
    due_day: number;
    /**
     * Final date of the monthly payment.
     */
    expires_at: string | null;
    /**
     * Due date of the first payment in the monthly payment cycle.
     */
    first_due_date: string;
    /**
     * Number of days before the due date when the payment is generated.
     */
    generate_days: number;
    /**
     * Number of intervals in the payment cycle.
     */
    interval_size: number;
    /**
     * Type of interval for the payment cycle (e.g., day or month).
     */
    interval_type: "day" | "month";
    /**
     * Array of items included in the monthly payment.
     */
    items: MonthlyPaymentItem[];
    /**
     * Date of the next payment expiration.
     */
    next_expiration: string;
    /**
     * Identifier of the notification rule associated with the payment.
     */
    notification_rule_id: string;
    /**
     * Date when the monthly payment was paused, if applicable.
     */
    paused_at: string | null;
    /**
     * Accepted payment methods for the monthly payment.
     */
    payable_with: string;
    /**
     * Identifier of the associated plan, if any.
     */
    plans_id: string | null;
    /**
     * Number of payments generated so far.
     */
    quantity_generated: number;
    /**
     * Date when the monthly payment will be reactivated, if applicable.
     */
    reactivate_at: string | null;
    /**
     * Reference type for the monthly payment.
     */
    reference: "none" | "prev" | "current" | "next";
    /**
     * Sequential number of the generated payments.
     */
    sequencial_number: string;
    /**
     * Settings object associated with the monthly payment.
     */
    settings: MonthlyPaymentSettings;
    /**
     * Current status of the monthly payment.
     */
    status: "actived" | "canceled" | "finished" | "inactived" | "paused" | "renewed" | "suspended" | "terminated" | "terminating";
    /**
     * Date when the monthly payment was created.
     */
    created_at: string;
    /**
     * Date when the monthly payment was last updated.
     */
    updated_at: string;
    /**
     * Date when the monthly payment was deleted, if applicable.
     */
    deleted_at?: string;
}
//# sourceMappingURL=MonthlyPayment.d.ts.map