Rippling: GET Timecards for an Employee
Rippling tandAapi.getTimecardsForRole: arguments, response, policy and SDK examples.
← Tand aapi operations · Get started
Operation rippling.t_and_a_api.get_timecards_for_role
Provider route: GET /platform/api/timecards/for_role. 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["tandAapi"]["getTimecardsForRole"]>[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.tandAapi.getTimecardsForRole(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.tand_aapi.get_timecards_for_role(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.role | string | Required within parent | |
query.limit | integer | Optional | |
query.offset | integer | 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 Timecard — response body |
Referenced models: GET Timecard — response body
Schemas
Section titled “Schemas”GET Timecard — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A timecard object is an instance that tracks a role's time logged in T&A across an entire pay period. The object specifically references a TimecardSummary instance, which takes down all of the hours logged for the role in the pay period in T&A and breaks them down. |
id | string | Optional | Unique identifier for timecard |
payPeriod | Model | Optional | Expand GET Pay Periods for an Employee — response body — item |
role | string | Optional | Rippling identifier for target user |
timecardSummary | Model | Optional | Expand GET Timecard — response body — timecard Summary |
Referenced models: GET Pay Periods for an Employee — response body — item, GET Timecard — response body — timecard Summary
GET Pay Periods for an Employee — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pay period object. |
endDate | string | Optional | |
paySchedule | string or null | Optional | |
startDate | string | Optional |
GET Timecard — response body — timecard Summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A timecard summary object is a breakdown of all hours that match a specific timecard. The object breaks down all earned hours by earning id, all premium hours by earning id, all hours by job codes, amongst others. |
| string | Optional | |
approved_hours | string | Optional | Total approved hours in the timecard. |
earnings | object | Optional | A breakdown of total worked hours by earning type id in the timecard. |
earnings.[earning_id] | string | Optional | |
job_codes | array | Optional | A breakdown of total worked hours by job codes in the timecard. |
job_codes[] | object | Each item | |
job_codes[].codes | array | Optional | |
job_codes[].codes[] | string | Each item | |
job_codes[].hours | string | Optional | |
overtime_hours | string | Optional | Total overtime hours in the timecard. |
paid_hours | string | Optional | Total paid hours in the timecard. |
premiums | object | Optional | A breakdown of total premium hours by earning type id in the timecard. |
premiums.[earning_id] | string | Optional | |
regular_hours | string | Optional | Total regular hours (base pay) in the timecard. |
total_holiday_hours | string | Optional | Total paid holiday hours in the timecard. |
total_hours | string | Optional | Total worked hours in the timecard. |
total_paid_time_off_hours | string | Optional | Total paid time off hours in the timecard. |
total_unpaid_time_off_hours | string | Optional | Total unpaid time off hours in the timecard. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.t_and_a_api.get_timecards_for_role. Catalog operation: t-and-a-api.get-timecards-for_role. 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.