Skip to content

Rippling: GET Employee 401k Deduction

Rippling payrollApi.getEmployeesEmployeeIdDeductions401k: arguments, response, policy and SDK examples.

← Payroll API operations · Get started

Operation rippling.payroll_api.get_employees_employeeid_deductions_401k

Provider route: GET /platform/api/employees/{employeeId}/deductions_401k. Alter supplies the connection’s credentials and routing.

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["payrollApi"]["getEmployeesEmployeeIdDeductions401k"]>[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.payrollApi.getEmployeesEmployeeIdDeductions401k(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.payroll_api.get_employees_employee_id_deductions_401k(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.employeeIdstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand GET Employee 401k Deduction — response body

Referenced models: GET Employee 401k Deduction — response body

GET Employee 401k Deduction — response body
FieldTypePresenceDescription and constraints
$objectRootThe 401k Deduction Model.
capsJSONOptional
caps (anyOf 1)objectAlternativeThe 401k Limit Object. This object represents the caps set on both employee and employer contribution amounts for traditional and ROTH 401ks.
caps (anyOf 1).employee_401k_limitJSONOptional
caps (anyOf 1).employee_401k_limit (anyOf 1)JSONAlternative
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 1)numberAlternativeFor all 401k accounts (Roth, and Traditional)
Format: float
Minimum: 0
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps (anyOf 1).employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).rothJSONOptional
caps (anyOf 1).roth (anyOf 1)objectAlternative
caps (anyOf 1).roth (anyOf 1).eeJSONOptional
caps (anyOf 1).roth (anyOf 1).ee (anyOf 1)stringAlternativeEmployee Roth 401k Limit
caps (anyOf 1).roth (anyOf 1).ee (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 1).erJSONOptional
caps (anyOf 1).roth (anyOf 1).er (anyOf 1)stringAlternativeEmployer Roth 401k limit
caps (anyOf 1).roth (anyOf 1).er (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 2)nullAlternative
caps (anyOf 1).total_401k_limitJSONOptional
caps (anyOf 1).total_401k_limit (anyOf 1)numberAlternativeTotal contribution limit from the employee and the employer.
Format: float
Minimum: 0
caps (anyOf 1).total_401k_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps (anyOf 1).traditionalobjectOptional
caps (anyOf 1).traditional.eeJSONOptional
caps (anyOf 1).traditional.ee (anyOf 1)stringAlternativeEmployee traditional 401k limit.
caps (anyOf 1).traditional.ee (anyOf 2)nullAlternative
caps (anyOf 1).traditional.employee_401k_limitJSONOptional
caps (anyOf 1).traditional.employee_401k_limit (anyOf 1)stringAlternativeThe traditional employee 401k limit.
caps (anyOf 1).traditional.employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).traditional.erJSONOptional
caps (anyOf 1).traditional.er (anyOf 1)stringAlternativeEmployer traditional 401k limit.
caps (anyOf 1).traditional.er (anyOf 2)nullAlternative
caps (anyOf 2)nullAlternative
employerstringOptionalEither a flat dollar or % employer traditional contribution amount. This should be used in conjunction with employer_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match. If the field is omitted, it will not be updated.
employer_roth_is_percentbooleanOptionalWhether the employer ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match.
employer_traditional_is_percentbooleanOptionalWhether the employer traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match.
loanstringOptionalEither a flat dollar or % loan contribution amount. This should be used in conjunction with loan_is_percent.
loan_is_percentbooleanOptionalWhether the loan contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
rothstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with roth_is_percent.
roth_employerstringOptionalEither a flat dollar or % employer ROTH contribution amount. This should be used in conjunction with employer_roth_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match.
roth_is_percentbooleanOptionalWhether the ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
traditionalstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with traditional_is_percent.
traditional_is_percentbooleanOptionalWhether the traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.

SDK function policy ID: rippling.payroll_api.get_employees_employeeid_deductions_401k. Catalog operation: payroll-api.get-employees-employeeId-deductions_401k. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.