@mozaic-io/mozaic-sdk-node/dist/resources/PaymentCycles/PaymentCycleEntry.d.ts

The Mozaic Node SDK enables you to pay your creators easily via the Mozaic API.

import { Amount, PaymentCycleEntry as RawPaymentCycleEntry } from "../../api";
import { BaseResource } from "../BaseResource";
export declare class PaymentCycleEntry extends BaseResource {
    /**
     * The ID of the payment cycle entry. This can be used to retrieve a payment cycle entry.
     */
    id: string;
    /**
     * The name of the contact receiving the payment from the payment cycle.
     */
    name: string;
    /**
     * The email of the contact receiving the payment from the payment cycle.
     */
    email: string;
    /**
     * An object representing the amount received by the user from the payment cycle.
     */
    amount: Amount;
    /**
     * The status of payment to the user for the payment cycle.
     */
    status: string;
    /**
     * The external ID of the payment recipient from the payment cycle.
     * This ID represents the user in an external system.
     */
    externalId: string | null | undefined;
    /**
     * A free text field containing user supplied information about the payment cycle.
     * This field has a maximum length of 140 characters.
     */
    memo: string | null | undefined;
    /**
     * The raw PaymentCycleEntry object that was returned from the API
     */
    rawObject: RawPaymentCycleEntry;
    /**
     * @internal
     * Internal use only. Please use the Mozaic object to utilize this object.
     * @param paymentCycleEntry
     */
    constructor(paymentCycleEntry: RawPaymentCycleEntry);
}
//# sourceMappingURL=PaymentCycleEntry.d.ts.map