Rippling: Retrieve a specific variable compensation payout

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_variable_compensation_payouts

Provider route: GET /variable-compensation-payouts/{id}/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";

async function execute(input: Parameters<RipplingIntegration["restApi"]["getVariableCompensationPayouts"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.restApi.getVariableCompensationPayouts(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rest_api.get_variable_compensation_payouts(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
amount_base	object	Required within parent	Payout amount in the worker’s base currency.
amount_base.currency_type	string	Required within parent	Three-letter currency code.
amount_base.value	string	Required within parent	Decimal amount encoded as a string.
amount_usd	object	Required within parent	Payout amount converted to USD.
amount_usd.currency_type	string	Required within parent	Three-letter currency code.
amount_usd.value	string	Required within parent	Decimal amount encoded as a string.
cancel_reason	string	Optional	Reason provided when the payout was cancelled.
client	string	Required within parent	Client system that created the payout. Known values: VC_PLAN_CYCLE, VC_EVENT_DRIVEN_PLAN, CUSTOM, MANUAL_PAYOUT, HRIS_SIGN_ON, OFFLINE_RECOMMENDATION
created_at	string	Required within parent	When the payout was created.
description	string	Optional	Optional payout description.
effective_end_date	string	Required within parent	End date of the covered pay period.
effective_start_date	string	Required within parent	Start date of the covered pay period.
external_id	string	Required within parent	External identifier unique per company and client.
group_label_id	string	Optional	Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.
id	string	Required within parent	Unique identifier of the payout.
name	string	Optional	Optional payout name.
pay_classification	string	Optional	Payroll earning code resolved from the payout type.
payee_id	string	Required within parent	ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
payout_type	string	Required within parent	Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.
paystub_id	string	Optional	Paystub identifier when the payout has been synced to payroll.
scheduled_date	string	Required within parent	Date on which the payout is scheduled.
source_label_id	string	Optional	Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.
status	string	Required within parent	Current payout status. Known values: DRAFT, PENDING_APPROVAL, APPROVAL_REJECTED, SCHEDULED, RELEASED, PAID, FORFEITED, EVALUATION_FAILED, CANCELLED
updated_at	string	Required within parent	When the payout was last updated.

Referenced models: Retrieve a report run — response body — meta redacted fields item

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_variable_compensation_payouts. Catalog operation: get-variable-compensation-payouts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["variable-compensation-payouts.read"]

Provider entitlements: ["Variable_Compensation_Scheduled_Payouts_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source