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

Biblioteca TypeScript para consumir a API da Cobre Fácil

/** Parameters for listing customers with optional filters and pagination.
 *
 * @property taxpayer_id - Search by the customer's CPF (Cadastro de Pessoas Físicas).
 * @property ein - Search by the company's CNPJ (Cadastro Nacional da Pessoa Jurídica).
 * @property email - Search by the customer's email address.
 * @property personal_name - Search by the customer's personal name.
 * @property company_name - Search by the company's name.
 * @property sort_by - Field to be used for sorting, defaults to `created_at`.
 * @property order_by - Defines the sorting order, either `asc` for ascending or `desc` for descending. Defaults to `desc`.
 * @property limit - Maximum number of records to retrieve, defaults to 100.
 * @property offset - Number of records to skip, defaults to 0.
 */
export interface ListCustomersParams {
    taxpayer_id?: string;
    ein?: string;
    email?: string;
    personal_name?: string;
    company_name?: string;
    sort_by?: string;
    order_by?: "asc" | "desc";
    limit?: number;
    offset?: number;
}
//# sourceMappingURL=ListCustomersParams.d.ts.map