Rippling: GET Tiered Matches 401 K
Rippling payrollApi.getTieredMatch401k: arguments, response, policy and SDK examples.
← Payroll API operations · Get started
Operation rippling.payroll_api.get_tiered_match_401k
Provider route: GET /platform/api/tiered_match_401k. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["payrollApi"]["getTieredMatch401k"]>[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.getTieredMatch401k(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_tiered_match_401k(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.ein | string | Optional |
Response
Section titled “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 |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand GET Tiered Match 401 K — response body |
Referenced models: GET Tiered Match 401 K — response body
Schemas
Section titled “Schemas”GET Tiered Match 401 K — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 401K Tiered Match object. Defines the employer match scheme for 401K contributions. |
ein | string | Optional | If set, this tiered match will only apply to employees in this entity. |
employees | array | Optional | The group of specified employees that this tiered match applies to. This field should be used if isDefault is set to false to define the group of employees that the tiered match applies to. |
employees[] | string | Each item | |
employerMatch401K | array | Optional | An employer 401k match object. |
employerMatch401K[] | JSON | Each item | |
employerMatch401K[] (anyOf 1) | object | Alternative | |
employerMatch401K[] (anyOf 1).eePercentComp | string | Optional | Employee percent |
employerMatch401K[] (anyOf 1).erMatchPercent | string | Optional | Employer match percentage |
employerMatch401K[] (anyOf 1).tierNum | JSON | Optional | |
employerMatch401K[] (anyOf 1).tierNum (anyOf 1) | integer | Alternative | Tier number |
employerMatch401K[] (anyOf 1).tierNum (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
employerMatch401K[] (anyOf 2) | null | Alternative | |
id | string | Optional | Unique identifier of the 401K Tiered Match object. |
isDefault | boolean | Optional | If set to true, this tiered match will be applied to all employees by default unless its overridden. If set to false, it will only apply to the applicable employees. |
matchingScheme401K | string | Required within parent | Known values: SAFE_HARBOR_BASIC, SAFE_HARBOR_ENHANCED, CUSTOM |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.payroll_api.get_tiered_match_401k. Catalog operation: payroll-api.get-tiered_match_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.