Rippling: List earnings-inputs
Rippling restApi.listEarningsInputs: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_earnings_inputs
Provider route: GET /earnings-inputs/. 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["restApi"]["listEarningsInputs"]>[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.listEarningsInputs(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.rest_api.list_earnings_inputs(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.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | 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 |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List earnings-inputs — response body — results item |
Referenced models: List earnings-inputs — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”List earnings-inputs — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing an external earnings input record. Used by: - GET /earnings-inputs/ (list) |
amount | string | Optional | Earning amount as a string-encoded decimal. |
assignment_type | string | Optional | How the earning is assigned (e.g. BY_PAY_PERIOD). |
company_entity_id | string | Optional | Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company. |
earning_code | string | Optional | Code identifying the earning type (e.g. regular_salary). |
earning_end_date | string | Optional | End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
earning_start_date | string | Optional | Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run. |
external_id | string | Optional | External reference identifier for this earning. |
hours | string | Optional | Hours associated with this earning as a string-encoded decimal. |
id | string | Optional | Unique identifier for the earnings input. |
is_overridden | boolean | Optional | Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings. |
pay_period_basis_date | string | Optional | The pay period basis date for this earning. |
run_id | string | Optional | Identifier of the payroll run this earning is assigned to, if any. |
status | string | Optional | Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED). |
time_labels | array | Optional | Time tracking labels associated with this earning. |
time_labels[] | string | Each item | |
worker_id | string | Optional | Identifier of the worker (role ID). |
List Sites — response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_earnings_inputs. Catalog operation: list-earnings-inputs. 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: ["earnings-inputs.read"]
Provider entitlements: ["Global_Payroll"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}