Rippling: Payroll API schemas
20 Rippling schemas with complete fields and constraints.
← Payroll API operations · All schemas
Create R&D Credit Filing — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An R&D Credit object |
company | string | Required within parent | Rippling ID of the company |
differentEin | string | Optional | If the filing is done for a different EIN, this field will contain the value of that Ein This is the company the credits came from (Can be any EIN) Please note that the credits will be added to “ein” entity only. |
ein | string | Required within parent | Ein of the company the credits need to be applied to. Note: This needs to be sent even though the company has only one legal entity This EIN does need to exist within Rippling and Rippling will throw an error message if the EIN doesn’t match an EIN present in Rippling. |
endDate | string | Required within parent | This is the last date the financial year of the year for which filing is done. Date format is MM/DD/YYYY Typically it’s 12/31/YYYY |
returnFilingDate | string | Required within parent | This is the date the company filed to the IRS. Date format is MM/DD/YYYY Format: date |
returnType | string | Required within parent | This field denotes the type of return. Available values: 'Form 1040 - Sole Proprietorship' 'Form 1065 - Partnership' 'Form 1120 - Corporate Tax Return' 'Form 1120S - S-Corp' 'Form 1120-F - Foreign Corporation' One of: 1040, 1065, 1120, 1120S, 1120F |
totalCredits | string | Required within parent | The value of the credits granted by IRS. |
useDifferentEin | boolean | Optional | If the filing is done for a different EIN, this field should be set to True. This indicates that the company is applying to a different EIN than the original 6765 filing |
GET Annual Payroll Information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Annual payroll information for a given company. |
| string | Optional | |
company_name | string | Optional | |
employees_info | array | Optional | |
employees_info[] | JSON | Each item | |
employees_info[] (anyOf 1) | object | Alternative | A summary of a Company's 401k information for a given employee. |
employees_info[] (anyOf 1).employee_details | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1) | object | Alternative | The employee details object used within the annual 401k report |
employees_info[] (anyOf 1).employee_details (anyOf 1).birth_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).first_name | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).hire_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).id | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).last_Name | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 1) | string | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 1) | string | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).ssn | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).termination_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).year | string | Optional | |
employees_info[] (anyOf 1).ytd_comp_w_2_box3 | string | Optional | |
employees_info[] (anyOf 1).ytd_ee_pretax_deferral | string | Optional | |
employees_info[] (anyOf 1).ytd_er_match | string | Optional | |
employees_info[] (anyOf 1).ytd_gross_wages | string | Optional | |
employees_info[] (anyOf 1).ytd_loan_payments | string | Optional | |
employees_info[] (anyOf 2) | null | Alternative | |
end_date | string | Optional | |
start_date | string | Optional |
GET Company Pay Schedules — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
arrearDayUnit | string | Optional | Known values: CALENDAR, BUSINESS |
arrearDays | string | Optional | |
ein | string | Optional | |
firstCheckDate | string | Optional | Format: date |
firstCheckDateOfMonth | JSON | Optional | |
firstCheckDateOfMonth (anyOf 1) | integer | Alternative | |
firstCheckDateOfMonth (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidayShift | string | Optional | Known values: LEFT, RIGHT |
id | string | Optional | |
name | string | Optional | |
payFrequency | string | Optional | Known values: WEEKLY, BI_WEEKLY, SEMI_MONTHLY, MONTHLY, QUARTERLY, ANNUALLY |
payrollDayOfWeek | JSON | Optional | |
payrollDayOfWeek (anyOf 1) | string | Alternative | |
payrollDayOfWeek (anyOf 2) | null | Alternative | |
roles | array | Optional | An array of role ids for employees. |
roles[] | JSON | Each item | |
secondCheckDateOfMonth | JSON | Optional | |
secondCheckDateOfMonth (anyOf 1) | integer | Alternative | |
secondCheckDateOfMonth (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
GET Company Payroll Runs — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payroll run object. |
approvalDeadline | string | Optional | |
approvedAt | JSON | Optional | |
approvedAt (anyOf 1) | string | Alternative | |
approvedAt (anyOf 2) | null | Alternative | |
checkDate | string | Optional | |
ein | string | Optional | Employer identification number, also known as the Federal Employer Identification Number or the Federal Tax Identification Number. |
id | string | Optional | The unique identifier for the payroll run. |
name | string | Optional | |
payPeriod | JSON | Optional | |
payPeriod (anyOf 1) | object | Alternative | |
payPeriod (anyOf 1).endDate | string | Optional | |
payPeriod (anyOf 1).paySchedule | JSON | Optional | |
payPeriod (anyOf 1).paySchedule (anyOf 1) | string | Alternative | |
payPeriod (anyOf 1).paySchedule (anyOf 2) | null | Alternative | |
payPeriod (anyOf 1).startDate | string | Optional | |
payPeriod (anyOf 2) | null | Alternative | |
runState | string | Optional | DRAFT means the admin hasn't approved the run yet. APPROVED means the admin has approved the run, but the check date has not arrived yet. PAID means the check date has arrived and the run was paid. FAILED means the check date arrived, but the run was not paid. CLOSED means the payroll run was canceled before being paid. Known values: DRAFT, APPROVED, PAID, FAILED, CLOSED |
runType | string | Optional | Known values: INIT, REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, RECONCILIATION, NEW_HIRE, POP, TRANSITION, CORRECTION_DISPLAY, EXCESS_HOURS, SIGN_ON_BONUS, S_CORP, FRINGE_BENEFITS, CONTRACTOR_LATE_PAYMENTS |
GET Earning Types — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An earning type object. |
earningType | string | Optional | |
id | string | Optional | |
name | string | Optional |
GET Employee 401k Deduction — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 401k Deduction Model. |
caps | JSON | Optional | |
caps (anyOf 1) | object | Alternative | The 401k Limit Object. This object represents the caps set on both employee and employer contribution amounts for traditional and ROTH 401ks. |
caps (anyOf 1).employee_401k_limit | JSON | Optional | |
caps (anyOf 1).employee_401k_limit (anyOf 1) | JSON | Alternative | |
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 1) | number | Alternative | For all 401k accounts (Roth, and Traditional) Format: float Minimum: 0 |
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
caps (anyOf 1).employee_401k_limit (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1) | object | Alternative | |
caps (anyOf 1).roth (anyOf 1).ee | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1).ee (anyOf 1) | string | Alternative | Employee Roth 401k Limit |
caps (anyOf 1).roth (anyOf 1).ee (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth (anyOf 1).er | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1).er (anyOf 1) | string | Alternative | Employer Roth 401k limit |
caps (anyOf 1).roth (anyOf 1).er (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth (anyOf 2) | null | Alternative | |
caps (anyOf 1).total_401k_limit | JSON | Optional | |
caps (anyOf 1).total_401k_limit (anyOf 1) | number | Alternative | Total contribution limit from the employee and the employer. Format: float Minimum: 0 |
caps (anyOf 1).total_401k_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
caps (anyOf 1).traditional | object | Optional | |
caps (anyOf 1).traditional.ee | JSON | Optional | |
caps (anyOf 1).traditional.ee (anyOf 1) | string | Alternative | Employee traditional 401k limit. |
caps (anyOf 1).traditional.ee (anyOf 2) | null | Alternative | |
caps (anyOf 1).traditional.employee_401k_limit | JSON | Optional | |
caps (anyOf 1).traditional.employee_401k_limit (anyOf 1) | string | Alternative | The traditional employee 401k limit. |
caps (anyOf 1).traditional.employee_401k_limit (anyOf 2) | null | Alternative | |
caps (anyOf 1).traditional.er | JSON | Optional | |
caps (anyOf 1).traditional.er (anyOf 1) | string | Alternative | Employer traditional 401k limit. |
caps (anyOf 1).traditional.er (anyOf 2) | null | Alternative | |
caps (anyOf 2) | null | Alternative | |
employer | string | Optional | Either a flat dollar or % employer traditional contribution amount. This should be used in conjunction with employer_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match. If the field is omitted, it will not be updated. |
employer_roth_is_percent | boolean | Optional | Whether the employer ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match. |
employer_traditional_is_percent | boolean | Optional | Whether the employer traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match. |
loan | string | Optional | Either a flat dollar or % loan contribution amount. This should be used in conjunction with loan_is_percent. |
loan_is_percent | boolean | Optional | Whether the loan contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
roth | string | Optional | Either a flat dollar or % contribution amount. This should be used in conjunction with roth_is_percent. |
roth_employer | string | Optional | Either a flat dollar or % employer ROTH contribution amount. This should be used in conjunction with employer_roth_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match. |
roth_is_percent | boolean | Optional | Whether the ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
traditional | string | Optional | Either a flat dollar or % contribution amount. This should be used in conjunction with traditional_is_percent. |
traditional_is_percent | boolean | Optional | Whether the traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
GET Employee Deductions — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An Employee Deduction object instance is created for every employee with a deduction. This will be inherited automatically by the company deduction type, but can be specified at the employee level as well, by directly modifying an employee's employee deduction object. |
companyContribution | string | Optional | Sets the companyContribution at the employee level. This will overwrite the values set by the company deduction type, associated with the employee deduction type. |
companyDeductionType | string | Optional | Unique identifier of the Company Deduction Type that is associated with this Employee Deduction Type. |
employeeDeduction | string | Optional | Stes the employeeDeduction at the employee level. This will override the values set by the company deduction type associated with this employee deduction type. |
id | string | Optional | Unique identifier of the employee deduction type. |
isEEPercent | boolean | Optional | If the employee deduction is a percentage. If false, then it will be a flat dollar amount. |
isERPecent | string | Optional | True if the value for an employee is a percentage of the employee's pay, or false if it is set to a flat dollar amount. |
isMonthly | JSON | Optional | |
isMonthly (anyOf 1) | boolean | Alternative | Corresponds to whether the deduction type is set to be monthly for the company deduction type associated with this role. |
isMonthly (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the employee deduction type. |
role | string | Optional | Role identifier of the employee deduction type that the company deduction type belong to. |
GET Payroll Activity — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
checkDate | string | Optional | Represents the date when the employees will receive funds |
employees | array | Optional | |
employees[] | object | Each item | |
employees[].401kCompanyContribution | string | Optional | |
employees[].401kDeduction | string | Optional | |
employees[].401kLoanPayment | string | Optional | |
employees[].ein | string | Optional | |
employees[].grossPay | string | Optional | |
employees[].hours | JSON | Optional | |
employees[].hours (anyOf 1) | string | Alternative | |
employees[].hours (anyOf 2) | null | Alternative | |
employees[].role | string | Optional | |
employees[].roth401kCompanyContribution | string | Optional | |
employees[].roth401kDeduction | string | Optional | |
employees[].totalPayForPercentageDeductions | string | Optional | |
endDate | string | Optional | |
id | string | Optional | |
parentPayrollRun | JSON | Optional | |
parentPayrollRun (anyOf 1) | object | Alternative | Parent payroll object used in an older endpoint for payroll activity. |
parentPayrollRun (anyOf 1).attribute... | string | Optional | |
parentPayrollRun (anyOf 2) | null | Alternative | |
payScheduled | string | Optional | |
processDate | string | Optional | Represents the check date or correction pay date in the case of the run type being CORRECTION |
runState | string | Optional | |
runType | string | Optional | |
startDate | string | Optional |
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 |
GET Upcoming pay periods — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pay period schedule object |
approvalDate | string | Optional | Format: date |
checkDate | string | Optional | Format: date |
ppEnd | string | Optional | Format: date |
ppStart | string | Optional | Format: date |
PATCH Company Deduction — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company deduction object. |
allowedEarningTypeForPercentCalc | array | Optional | The earning types this company deduction type applies to. |
allowedEarningTypeForPercentCalc[] | string | Each item | |
companyContribution | JSON | Optional | |
companyContribution (anyOf 1) | string | Alternative | The amount the company pays on the employee's behalf. |
companyContribution (anyOf 2) | null | Alternative | |
deductionType | string | Optional | The deduction type. One of: MEDICAL, DENTAL, VISION, HSA, FSA_MEDICAL, FSA_DEPENDENT_CARE, SIMPLE_IRA, _401K, ROTH_401K, OTHER_TAXABLE, OTHER_NON_TAXABLE, COMMUTER_TRANSIT, COMMUTER_PARKING, _401K_LOAN_PAYMENT, SHORT_DISABILITY, LONG_DISABILITY, LIFE, SEP_IRA, SARSEP, CUSTOM_TAXABLE, _403B, ROTH_403B, STUDENT_LOAN |
employeeDeduction | JSON | Optional | |
employeeDeduction (anyOf 1) | string | Alternative | The amount the employee pays out of their pocket. |
employeeDeduction (anyOf 2) | null | Alternative | |
employerMatch401K | object | Optional | This field earlier returned tiered match in case only one tiered match is set up for a company. This field is now deprecated. Additional keys: not allowed |
id | string | Optional | The company deduction unique identifier. |
isEEPercent | boolean | Optional | If the amount given in a employee deduction is a % than true. Otherwise false, if the amount if an absolute dollar amount value. |
isERPercent | boolean | Optional | If the amount given in a company contribution is a % than true. Otherwise false, if the amount if an absolute dollar amount value. |
isMonthly | JSON | Optional | |
isMonthly (anyOf 1) | boolean | Alternative | Indicates that the admin has set up deduction amounts per month. It is true only when the admin explicitly selects 'Monthy' while setting up the Company Deduction Type (CDT). If it is false, then the defaults set up are used per pay period. |
isMonthly (anyOf 2) | null | Alternative | |
matchingScheme401k | string | Optional | The defined matching scheme. Safe harbor is used if you want to use tiered matching. One of: NON_ELECTIVE, SAFE_HARBOR |
name | string | Optional | Name of the company deduction. |
tiered_401k_matches | array | Optional | This returns an array of tiered match object ids. We can use these ids with API https://api.rippling.com /platform/api/tiered_match_401k/{id} to query tiered matches for a company. |
tiered_401k_matches[] | string | Each item |
POST Payroll Earnings — request body — body A pay earning object for an employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pay earning object for an employee. |
amount | string | Optional | |
companyEarningType | string | Optional | Identifier of the earning type defined by the company. There can only be one entry in the earnings array for each companyEarningType. |
earningTypeEnum | string | Optional | |
hours | JSON | Optional | |
hours (anyOf 1) | string | Alternative | Only applies to earning types that are paid hourly. |
hours (anyOf 2) | null | Alternative | |
shiftId | JSON | Optional | |
shiftId (anyOf 1) | string | Alternative | Used to distinguish between earnings with same time labels |
shiftId (anyOf 2) | null | Alternative | |
time_labels | JSON | Optional | |
time_labels (anyOf 1) | array | Alternative | List of Jobcodes for the Earning hours |
time_labels (anyOf 1)[] | string | Each item | |
time_labels (anyOf 2) | null | Alternative |
POST Payroll Earnings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee payroll run object. |
credits | array | Optional | |
credits[] | Model | Each item | Expand POST Payroll Earnings — response body — credits item |
debits | array | Optional | |
debits[] | Model | Each item | Expand POST Payroll Earnings — response body — debits item |
earnings | array | Optional | |
earnings[] | JSON | Each item | |
earnings[] (anyOf 1) | Model | Alternative | Expand POST Payroll Earnings — request body — body A pay earning object for an employee |
earnings[] (anyOf 2) | null | Alternative | |
ein | string | Optional | |
garnishments | array | Optional | |
garnishments[] | Model | Each item | Expand POST Payroll Earnings — response body — garnishments item |
grossPay | string | Optional | |
id | string | Optional | |
netPay | string | Optional | |
role | string | Optional | The unique identifier of the employee. |
run | string | Optional | |
taxes | array | Optional | |
taxes[] | Model | Each item | Expand POST Payroll Earnings — response body — taxes item |
totalPayForPercentageDeductions | string | Optional |
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 — response body — credits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing employee credits. |
amount | string | Optional | Credit Amount. |
name | string | Optional | Credit Name. |
POST Payroll Earnings — response body — debits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing employee debits. |
amount | string | Optional | Debit Amount. |
name | string | Optional | Debit Name. |
POST Payroll Earnings — response body — garnishments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An 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. |
ctdAmt | string | Optional | Contribution Amount. |
employeeGarnishment | string | Optional | Unique identifier of the garnishmnet type defined by the company. |
name | string | Optional | Garnishment Name. |
POST Payroll Earnings — response body — taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tax object that depicts taxes paid by an employee during a payroll run. |
amount | string | Optional | |
isERTax | boolean | Optional | |
name | string | Optional |
PUT Employee 401k Deduction — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 401k Deduction Model. |
caps | JSON | Optional | |
caps (anyOf 1) | object | Alternative | The 401k Limit Object. This object represents the caps set on both employee and employer contribution amounts for traditional and ROTH 401ks. |
caps (anyOf 1).employee_401k_limit | JSON | Optional | |
caps (anyOf 1).employee_401k_limit (anyOf 1) | number | Alternative | For all 401k accounts (Roth, and Traditional) Format: float Minimum: 0 |
caps (anyOf 1).employee_401k_limit (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1) | object | Alternative | |
caps (anyOf 1).roth (anyOf 1).ee | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1).ee (anyOf 1) | string | Alternative | Employee Roth 401k Limit |
caps (anyOf 1).roth (anyOf 1).ee (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth (anyOf 1).er | JSON | Optional | |
caps (anyOf 1).roth (anyOf 1).er (anyOf 1) | string | Alternative | Employer Roth 401k limit |
caps (anyOf 1).roth (anyOf 1).er (anyOf 2) | null | Alternative | |
caps (anyOf 1).roth (anyOf 2) | null | Alternative | |
caps (anyOf 1).total_401k_limit | number | Optional | Total contribution limit from the employee and the employer. Format: float Minimum: 0 |
caps (anyOf 1).traditional | object | Optional | |
caps (anyOf 1).traditional.ee | JSON | Optional | |
caps (anyOf 1).traditional.ee (anyOf 1) | string | Alternative | Employee traditional 401k limit. |
caps (anyOf 1).traditional.ee (anyOf 2) | null | Alternative | |
caps (anyOf 1).traditional.employee_401k_limit | JSON | Optional | |
caps (anyOf 1).traditional.employee_401k_limit (anyOf 1) | string | Alternative | The traditional employee 401k limit. |
caps (anyOf 1).traditional.employee_401k_limit (anyOf 2) | null | Alternative | |
caps (anyOf 1).traditional.er | JSON | Optional | |
caps (anyOf 1).traditional.er (anyOf 1) | string | Alternative | Employer traditional 401k limit. |
caps (anyOf 1).traditional.er (anyOf 2) | null | Alternative | |
caps (anyOf 2) | null | Alternative | |
employer | string | Optional | Either a flat dollar or % employer traditional contribution amount. This should be used in conjunction with employer_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match. If the field is omitted, it will not be updated. |
employer_roth_is_percent | boolean | Optional | Whether the employer ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match. |
employer_traditional_is_percent | boolean | Optional | Whether the employer traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. Note, this field should not be set if the employer is using a tiered match. |
loan | string | Optional | Either a flat dollar or % loan contribution amount. This should be used in conjunction with loan_is_percent. |
loan_is_percent | boolean | Optional | Whether the loan contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
roth | string | Optional | Either a flat dollar or % contribution amount. This should be used in conjunction with roth_is_percent. |
roth_employer | string | Optional | Either a flat dollar or % employer ROTH contribution amount. This should be used in conjunction with employer_roth_is_percent. Note, this field should not be set if the employer is using a tiered match. This value will be overridden by the calculated match using the tiered match. |
roth_is_percent | boolean | Optional | Whether the ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
traditional | string | Optional | Either a flat dollar or % contribution amount. This should be used in conjunction with traditional_is_percent. |
traditional_is_percent | boolean | Optional | Whether the traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount. |
PUT Tiered Match 401 K — request body — 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 | integer | Optional | Tier number |
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 | One of: SAFE_HARBOR_BASIC, SAFE_HARBOR_ENHANCED, CUSTOM |
Retrieve R&D credits — response body — credits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An R&D Credit object |
company | string | Optional | Rippling ID of the company |
differentEin | string | Optional | If the filing is done for a different EIN, this field will contain the value of that Ein This is the company the credits came from (Can be any EIN) Please note that the credits will be added to “ein” entity only. |
ein | string | Required within parent | Ein of the company the credits need to be applied to. Note: This needs to be sent even though the company has only one legal entity This EIN does need to exist within Rippling and Rippling will throw an error message if the EIN doesn’t match an EIN present in Rippling. |
endDate | string | Required within parent | This is the last date the financial year of the year for which filing is done. Date format is MM/DD/YYYY Typically it’s 12/31/YYYY |
returnFilingDate | string | Required within parent | This is the date the company filed to the IRS. Date format is MM/DD/YYYY Format: date |
returnType | string | Optional | This field denotes the type of return. Available values: 'Form 1040 - Sole Proprietorship' 'Form 1065 - Partnership' 'Form 1120 - Corporate Tax Return' 'Form 1120S - S-Corp' 'Form 1120-F - Foreign Corporation' Known values: 1040, 1065, 1120, 1120S, 1120F |
totalCredits | string | Required within parent | The value of the credits granted by IRS. |
useDifferentEin | boolean | Optional | If the filing is done for a different EIN, this field should be set to True. This indicates that the company is applying to a different EIN than the original 6765 filing |