/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Mercoa from "../../../../index.js";
/**
 * @example
 *     {
 *         isCustomer: true,
 *         foreignId: "MY-DB-ID-12345",
 *         paymentMethods: true
 *     }
 */
export interface FindEntities {
    /** If true, will include entity payment methods as part of the response */
    paymentMethods?: boolean;
    /** If true, only entities with a direct relationship to the requesting organization will be returned. If false or not provided, all entities will be returned. */
    isCustomer?: boolean;
    /** ID used to identify this entity in your system */
    foreignId?: string | string[];
    status?: Mercoa.EntityStatus | Mercoa.EntityStatus[];
    /**
     * If true, entities that are marked as payees will be returned.
     * If false or not provided, entities that are marked as payees will not be returned.
     */
    isPayee?: boolean;
    /**
     * If true or not provided, entities that are marked as payors will be returned.
     * If false, entities that are marked as payors will not be returned.
     */
    isPayor?: boolean;
    /** Use search instead. Deprecated. Filter entities by name. Partial matches are supported. */
    name?: string;
    /** Find entities by name, email, or emailTo. Partial matches are supported. */
    search?: string;
    /** Filter entities by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored. */
    metadata?: Mercoa.MetadataFilter;
    /** Return simple key/value metadata for the specified keys for the entities. For more complex metadata, use the Metadata API. */
    returnMetadata?: string | string[];
    /** Number of entities to return. Limit can range between 1 and 100, and the default is 10. */
    limit?: number;
    /** The ID of the entity to start after. If not provided, the first page of entities will be returned. */
    startingAfter?: Mercoa.EntityId;
}