Skip to content

Rippling: GET Payroll Activity

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

← Payroll API operations · Get started

Operation rippling.payroll_api.get_companies_payroll_activity

Provider route: GET /platform/api/companies/payroll_activity. 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"]["getCompaniesPayrollActivity"]>[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.getCompaniesPayrollActivity(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_companies_payroll_activity(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.fromstringOptionalFormat: date
query.tostringOptionalFormat: date
query.einstringOptional
query.exclude_unpaidstringOptional
query.send_all_rolesbooleanOptional

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand GET Payroll Activity — response body — item

Referenced models: GET Payroll Activity — response body — item

GET Payroll Activity — response body — item
FieldTypePresenceDescription and constraints
$objectRoot
checkDatestringOptionalRepresents the date when the employees will receive funds
employeesarrayOptional
employees[]objectEach item
employees[].401kCompanyContributionstringOptional
employees[].401kDeductionstringOptional
employees[].401kLoanPaymentstringOptional
employees[].einstringOptional
employees[].grossPaystringOptional
employees[].hoursJSONOptional
employees[].hours (anyOf 1)stringAlternative
employees[].hours (anyOf 2)nullAlternative
employees[].rolestringOptional
employees[].roth401kCompanyContributionstringOptional
employees[].roth401kDeductionstringOptional
employees[].totalPayForPercentageDeductionsstringOptional
endDatestringOptional
idstringOptional
parentPayrollRunJSONOptional
parentPayrollRun (anyOf 1)objectAlternativeParent payroll object used in an older endpoint for payroll activity.
parentPayrollRun (anyOf 1).attribute...stringOptional
parentPayrollRun (anyOf 2)nullAlternative
payScheduledstringOptional
processDatestringOptionalRepresents the check date or correction pay date in the case of the run type being CORRECTION
runStatestringOptional
runTypestringOptional
startDatestringOptional

SDK function policy ID: rippling.payroll_api.get_companies_payroll_activity. Catalog operation: payroll-api.get-companies-payroll_Activity. 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.