import { APIResource } from "../core/resource.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * Compensation associated with workers */ export declare class VariableCompensationPayoutWrites extends APIResource { /** * Create and submit a payout into payroll. For ledger create-or-update of a payout * row, use POST /variable-compensation-payouts/. * * @example HTTP * Representative request and response shapes. * ``` * POST /variable-compensation-payout-writes/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * { * "amount_base": { * "currency_type": "currency_type", * "value": "value" * }, * "payee_id": "payee_id", * "payment_type": "payment_type", * "scheduled_date": "scheduled_date" * } * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "payee_id": "string", * "amount_base": { * "currency_type": "string", * "value": "string" * }, * "scheduled_date": "string", * "payment_type": "string", * "eligibility_sql": "string", * "group_name": "string", * "ai_conditions_summary": "string", * "payout_id": "string", * "status": "string" * } * ``` */ create(body: VariableCompensationPayoutWriteCreateParams, options?: RequestOptions): APIPromise; } export interface VariableCompensationPayoutWriteCreateResponse { /** * Payout amount. */ amount_base: VariableCompensationPayoutWriteCreateResponse.AmountBase; /** * ID of the worker who receives this payout. */ payee_id: string; /** * Key of the company payment type used for this payout. */ payment_type: string; /** * Date on which the payout is scheduled. */ scheduled_date: string; /** * Optional markdown summary of the eligibility conditions. */ ai_conditions_summary?: string; /** * SQL eligibility expression. Omit to use the active-role default. */ eligibility_sql?: string; /** * Optional payout group label. */ group_name?: string; /** * ID of the created payout. */ payout_id?: string; /** * Resulting payout status. */ status?: string; } export declare namespace VariableCompensationPayoutWriteCreateResponse { /** * Payout amount. */ interface AmountBase { /** * Three-letter currency code. */ currency_type: string; /** * Decimal payout amount encoded as a string. */ value: string; } } export interface VariableCompensationPayoutWriteCreateParams { /** * Payout amount. */ amount_base: VariableCompensationPayoutWriteCreateParams.AmountBase; /** * ID of the worker who receives this payout. */ payee_id: string; /** * Key of the company payment type used for this payout. */ payment_type: string; /** * Date on which the payout is scheduled. */ scheduled_date: string; /** * Optional markdown summary of the eligibility conditions. */ ai_conditions_summary?: string; /** * SQL eligibility expression. Omit to use the active-role default. */ eligibility_sql?: string; /** * Optional payout group label. */ group_name?: string; } export declare namespace VariableCompensationPayoutWriteCreateParams { /** * Payout amount. */ interface AmountBase { /** * Three-letter currency code. */ currency_type: string; /** * Decimal payout amount encoded as a string. */ value: string; } } export declare namespace VariableCompensationPayoutWrites { export { type VariableCompensationPayoutWriteCreateResponse as VariableCompensationPayoutWriteCreateResponse, type VariableCompensationPayoutWriteCreateParams as VariableCompensationPayoutWriteCreateParams, }; } //# sourceMappingURL=variable-compensation-payout-writes.d.mts.map