import { APIResource } from "../core/resource.mjs"; import * as BusinessPartnersAPI from "./business-partners.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../core/pagination.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * Categories used to classify Finance transaction line items */ export declare class FinanceCategories extends APIResource { /** * A list of finance categories. * * - Requires: `Spend Management Platform API` * - Filterable fields: `name` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /finance-categories/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * { * "name": "date_of_birth", * "reason": "Insufficient entitlements" * } * ] * }, * "results": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "active": false * } * ], * "next_link": "string" * } * ``` */ list(query?: FinanceCategoryListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a specific finance category * * @example HTTP * Representative request and response shapes. * ``` * GET /finance-categories/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * {} * ] * } * } * ``` */ retrieve(id: string, options?: RequestOptions): APIPromise; } export type FinanceCategoryListResponsesPageCursorURL = PageCursorURL; /** * A Finance category used to classify transaction line items. * * Inactive categories are included so historical transactions can still resolve their category. */ export interface FinanceCategoryListResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Whether the category is active. Inactive categories remain available for * historical references. */ active?: boolean; /** * Name of the Finance category. */ name?: string; } /** * Meta information for the response. */ export interface FinanceCategoryRetrieveResponse extends BusinessPartnersAPI.Meta { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Whether the category is active. Inactive categories remain available for * historical references. */ active?: boolean; /** * Name of the Finance category. */ name?: string; } export interface FinanceCategoryListParams { cursor?: string; filter?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export declare namespace FinanceCategories { export { type FinanceCategoryListResponse as FinanceCategoryListResponse, type FinanceCategoryRetrieveResponse as FinanceCategoryRetrieveResponse, type FinanceCategoryListResponsesPageCursorURL as FinanceCategoryListResponsesPageCursorURL, type FinanceCategoryListParams as FinanceCategoryListParams, }; } //# sourceMappingURL=finance-categories.d.mts.map