Skip to content

Rippling: POST Payroll Earnings

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

← Payroll API operations · Get started

Operation rippling.payroll_api.post_payroll_runs_payrollrunid_employees_employeepayrollrunid_earnings

Provider route: POST /platform/api/payroll_runs/{payrollRunId}/employees/{employeePayrollRunId}/earnings. 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"]["postPayrollRunsPayrollRunIdEmployeesEmployeePayrollRunIdEarnings"]>[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.postPayrollRunsPayrollRunIdEmployeesEmployeePayrollRunIdEarnings(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.post_payroll_runs_payroll_run_id_employees_employee_payroll_run_id_earnings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.payrollRunIdstringRequired within parent
path.employeePayrollRunIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.includeInactivestringOptional
bodyJSONOptional
body (anyOf 1)ModelAlternativeExpand POST Payroll Earnings — request body — body A pay earning object for an employee
body (anyOf 2)nullAlternative

Referenced models: POST Payroll Earnings — request body — body A pay earning object for an employee

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

FieldTypePresenceDescription and constraints
$ModelRootExpand POST Payroll Earnings — response body

Referenced models: POST Payroll Earnings — response body

POST Payroll Earnings — response body
FieldTypePresenceDescription and constraints
$objectRootAn employee payroll run object.
creditsarrayOptional
credits[]ModelEach itemExpand POST Payroll Earnings — response body — credits item
debitsarrayOptional
debits[]ModelEach itemExpand POST Payroll Earnings — response body — debits item
earningsarrayOptional
earnings[]JSONEach item
earnings[] (anyOf 1)ModelAlternativeExpand POST Payroll Earnings — request body — body A pay earning object for an employee
earnings[] (anyOf 2)nullAlternative
einstringOptional
garnishmentsarrayOptional
garnishments[]ModelEach itemExpand POST Payroll Earnings — response body — garnishments item
grossPaystringOptional
idstringOptional
netPaystringOptional
rolestringOptionalThe unique identifier of the employee.
runstringOptional
taxesarrayOptional
taxes[]ModelEach itemExpand POST Payroll Earnings — response body — taxes item
totalPayForPercentageDeductionsstringOptional

Referenced models: POST Payroll Earnings — response body — credits item, POST Payroll Earnings — response body — debits item, POST Payroll Earnings — response body — garnishments item, POST Payroll Earnings — response body — taxes item, POST Payroll Earnings — request body — body A pay earning object for an employee

POST Payroll Earnings — request body — body A pay earning object for an employee
FieldTypePresenceDescription and constraints
$objectRootA pay earning object for an employee.
amountstringOptional
companyEarningTypestringOptionalIdentifier of the earning type defined by the company. There can only be one entry in the earnings array for each companyEarningType.
earningTypeEnumstringOptional
hoursJSONOptional
hours (anyOf 1)stringAlternativeOnly applies to earning types that are paid hourly.
hours (anyOf 2)nullAlternative
shiftIdJSONOptional
shiftId (anyOf 1)stringAlternativeUsed to distinguish between earnings with same time labels
shiftId (anyOf 2)nullAlternative
time_labelsJSONOptional
time_labels (anyOf 1)arrayAlternativeList of Jobcodes for the Earning hours
time_labels (anyOf 1)[]stringEach item
time_labels (anyOf 2)nullAlternative
POST Payroll Earnings — response body — credits item
FieldTypePresenceDescription and constraints
$objectRootAn object representing employee credits.
amountstringOptionalCredit Amount.
namestringOptionalCredit Name.
POST Payroll Earnings — response body — debits item
FieldTypePresenceDescription and constraints
$objectRootAn object representing employee debits.
amountstringOptionalDebit Amount.
namestringOptionalDebit Name.
POST Payroll Earnings — response body — garnishments item
FieldTypePresenceDescription and constraints
$objectRootAn object representing employee garnishments. A payroll garnishment occurs when a court issues an order to withhold a certain amount from an employee's paycheck and send it directly to the organization or person owed money, until the debt is fully paid.
ctdAmtstringOptionalContribution Amount.
employeeGarnishmentstringOptionalUnique identifier of the garnishmnet type defined by the company.
namestringOptionalGarnishment Name.
POST Payroll Earnings — response body — taxes item
FieldTypePresenceDescription and constraints
$objectRootA tax object that depicts taxes paid by an employee during a payroll run.
amountstringOptional
isERTaxbooleanOptional
namestringOptional

SDK function policy ID: rippling.payroll_api.post_payroll_runs_payrollrunid_employees_employeepayrollrunid_earnings. Catalog operation: payroll-api.post-payroll_runs-payrollRunId-employees-employeePayrollRunId-earnings. 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.