Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootAn R&D Credit object
companystringRequired within parentRippling ID of the company
differentEinstringOptionalIf 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.
einstringRequired within parentEin 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.
endDatestringRequired within parentThis 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
returnFilingDatestringRequired within parentThis is the date the company filed to the IRS. Date format is MM/DD/YYYY
Format: date
returnTypestringRequired within parentThis 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
totalCreditsstringRequired within parentThe value of the credits granted by IRS.
useDifferentEinbooleanOptionalIf 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

FieldTypePresenceDescription and constraints
$objectRootAnnual payroll information for a given company.
stringOptional
company_namestringOptional
employees_infoarrayOptional
employees_info[]JSONEach item
employees_info[] (anyOf 1)objectAlternativeA summary of a Company's 401k information for a given employee.
employees_info[] (anyOf 1).employee_detailsJSONOptional
employees_info[] (anyOf 1).employee_details (anyOf 1)objectAlternativeThe employee details object used within the annual 401k report
employees_info[] (anyOf 1).employee_details (anyOf 1).birth_datestringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).first_namestringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).hire_datestringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).idstringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).last_NamestringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_dateJSONOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 1)stringAlternative
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 2)nullAlternative
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_dateJSONOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 1)stringAlternative
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 2)nullAlternative
employees_info[] (anyOf 1).employee_details (anyOf 1).ssnstringOptional
employees_info[] (anyOf 1).employee_details (anyOf 1).termination_datestringOptional
employees_info[] (anyOf 1).employee_details (anyOf 2)nullAlternative
employees_info[] (anyOf 1).yearstringOptional
employees_info[] (anyOf 1).ytd_comp_w_2_box3stringOptional
employees_info[] (anyOf 1).ytd_ee_pretax_deferralstringOptional
employees_info[] (anyOf 1).ytd_er_matchstringOptional
employees_info[] (anyOf 1).ytd_gross_wagesstringOptional
employees_info[] (anyOf 1).ytd_loan_paymentsstringOptional
employees_info[] (anyOf 2)nullAlternative
end_datestringOptional
start_datestringOptional

GET Company Pay Schedules — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
arrearDayUnitstringOptionalKnown values: CALENDAR, BUSINESS
arrearDaysstringOptional
einstringOptional
firstCheckDatestringOptionalFormat: date
firstCheckDateOfMonthJSONOptional
firstCheckDateOfMonth (anyOf 1)integerAlternative
firstCheckDateOfMonth (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
holidayShiftstringOptionalKnown values: LEFT, RIGHT
idstringOptional
namestringOptional
payFrequencystringOptionalKnown values: WEEKLY, BI_WEEKLY, SEMI_MONTHLY, MONTHLY, QUARTERLY, ANNUALLY
payrollDayOfWeekJSONOptional
payrollDayOfWeek (anyOf 1)stringAlternative
payrollDayOfWeek (anyOf 2)nullAlternative
rolesarrayOptionalAn array of role ids for employees.
roles[]JSONEach item
secondCheckDateOfMonthJSONOptional
secondCheckDateOfMonth (anyOf 1)integerAlternative
secondCheckDateOfMonth (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

GET Company Payroll Runs — response body — item

FieldTypePresenceDescription and constraints
$objectRootThe payroll run object.
approvalDeadlinestringOptional
approvedAtJSONOptional
approvedAt (anyOf 1)stringAlternative
approvedAt (anyOf 2)nullAlternative
checkDatestringOptional
einstringOptionalEmployer identification number, also known as the Federal Employer Identification Number or the Federal Tax Identification Number.
idstringOptionalThe unique identifier for the payroll run.
namestringOptional
payPeriodJSONOptional
payPeriod (anyOf 1)objectAlternative
payPeriod (anyOf 1).endDatestringOptional
payPeriod (anyOf 1).payScheduleJSONOptional
payPeriod (anyOf 1).paySchedule (anyOf 1)stringAlternative
payPeriod (anyOf 1).paySchedule (anyOf 2)nullAlternative
payPeriod (anyOf 1).startDatestringOptional
payPeriod (anyOf 2)nullAlternative
runStatestringOptionalDRAFT 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
runTypestringOptionalKnown 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

FieldTypePresenceDescription and constraints
$objectRootAn earning type object.
earningTypestringOptional
idstringOptional
namestringOptional

GET Employee 401k Deduction — response body

FieldTypePresenceDescription and constraints
$objectRootThe 401k Deduction Model.
capsJSONOptional
caps (anyOf 1)objectAlternativeThe 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_limitJSONOptional
caps (anyOf 1).employee_401k_limit (anyOf 1)JSONAlternative
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 1)numberAlternativeFor all 401k accounts (Roth, and Traditional)
Format: float
Minimum: 0
caps (anyOf 1).employee_401k_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps (anyOf 1).employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).rothJSONOptional
caps (anyOf 1).roth (anyOf 1)objectAlternative
caps (anyOf 1).roth (anyOf 1).eeJSONOptional
caps (anyOf 1).roth (anyOf 1).ee (anyOf 1)stringAlternativeEmployee Roth 401k Limit
caps (anyOf 1).roth (anyOf 1).ee (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 1).erJSONOptional
caps (anyOf 1).roth (anyOf 1).er (anyOf 1)stringAlternativeEmployer Roth 401k limit
caps (anyOf 1).roth (anyOf 1).er (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 2)nullAlternative
caps (anyOf 1).total_401k_limitJSONOptional
caps (anyOf 1).total_401k_limit (anyOf 1)numberAlternativeTotal contribution limit from the employee and the employer.
Format: float
Minimum: 0
caps (anyOf 1).total_401k_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps (anyOf 1).traditionalobjectOptional
caps (anyOf 1).traditional.eeJSONOptional
caps (anyOf 1).traditional.ee (anyOf 1)stringAlternativeEmployee traditional 401k limit.
caps (anyOf 1).traditional.ee (anyOf 2)nullAlternative
caps (anyOf 1).traditional.employee_401k_limitJSONOptional
caps (anyOf 1).traditional.employee_401k_limit (anyOf 1)stringAlternativeThe traditional employee 401k limit.
caps (anyOf 1).traditional.employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).traditional.erJSONOptional
caps (anyOf 1).traditional.er (anyOf 1)stringAlternativeEmployer traditional 401k limit.
caps (anyOf 1).traditional.er (anyOf 2)nullAlternative
caps (anyOf 2)nullAlternative
employerstringOptionalEither 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_percentbooleanOptionalWhether 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_percentbooleanOptionalWhether 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.
loanstringOptionalEither a flat dollar or % loan contribution amount. This should be used in conjunction with loan_is_percent.
loan_is_percentbooleanOptionalWhether the loan contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
rothstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with roth_is_percent.
roth_employerstringOptionalEither 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_percentbooleanOptionalWhether the ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
traditionalstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with traditional_is_percent.
traditional_is_percentbooleanOptionalWhether the traditional contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.

GET Employee Deductions — response body — item

FieldTypePresenceDescription and constraints
$objectRootAn 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.
companyContributionstringOptionalSets the companyContribution at the employee level. This will overwrite the values set by the company deduction type, associated with the employee deduction type.
companyDeductionTypestringOptionalUnique identifier of the Company Deduction Type that is associated with this Employee Deduction Type.
employeeDeductionstringOptionalStes the employeeDeduction at the employee level. This will override the values set by the company deduction type associated with this employee deduction type.
idstringOptionalUnique identifier of the employee deduction type.
isEEPercentbooleanOptionalIf the employee deduction is a percentage. If false, then it will be a flat dollar amount.
isERPecentstringOptionalTrue 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.
isMonthlyJSONOptional
isMonthly (anyOf 1)booleanAlternativeCorresponds to whether the deduction type is set to be monthly for the company deduction type associated with this role.
isMonthly (anyOf 2)nullAlternative
namestringOptionalName of the employee deduction type.
rolestringOptionalRole identifier of the employee deduction type that the company deduction type belong to.

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

GET Tiered Match 401 K — response body

FieldTypePresenceDescription and constraints
$objectRootA 401K Tiered Match object. Defines the employer match scheme for 401K contributions.
einstringOptionalIf set, this tiered match will only apply to employees in this entity.
employeesarrayOptionalThe 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[]stringEach item
employerMatch401KarrayOptionalAn employer 401k match object.
employerMatch401K[]JSONEach item
employerMatch401K[] (anyOf 1)objectAlternative
employerMatch401K[] (anyOf 1).eePercentCompstringOptionalEmployee percent
employerMatch401K[] (anyOf 1).erMatchPercentstringOptionalEmployer match percentage
employerMatch401K[] (anyOf 1).tierNumJSONOptional
employerMatch401K[] (anyOf 1).tierNum (anyOf 1)integerAlternativeTier number
employerMatch401K[] (anyOf 1).tierNum (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
employerMatch401K[] (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the 401K Tiered Match object.
isDefaultbooleanOptionalIf 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.
matchingScheme401KstringRequired within parentKnown values: SAFE_HARBOR_BASIC, SAFE_HARBOR_ENHANCED, CUSTOM

GET Upcoming pay periods — response body — item

FieldTypePresenceDescription and constraints
$objectRootA pay period schedule object
approvalDatestringOptionalFormat: date
checkDatestringOptionalFormat: date
ppEndstringOptionalFormat: date
ppStartstringOptionalFormat: date

PATCH Company Deduction — request body — body

FieldTypePresenceDescription and constraints
$objectRootA company deduction object.
allowedEarningTypeForPercentCalcarrayOptionalThe earning types this company deduction type applies to.
allowedEarningTypeForPercentCalc[]stringEach item
companyContributionJSONOptional
companyContribution (anyOf 1)stringAlternativeThe amount the company pays on the employee's behalf.
companyContribution (anyOf 2)nullAlternative
deductionTypestringOptionalThe 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
employeeDeductionJSONOptional
employeeDeduction (anyOf 1)stringAlternativeThe amount the employee pays out of their pocket.
employeeDeduction (anyOf 2)nullAlternative
employerMatch401KobjectOptionalThis 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
idstringOptionalThe company deduction unique identifier.
isEEPercentbooleanOptionalIf the amount given in a employee deduction is a % than true. Otherwise false, if the amount if an absolute dollar amount value.
isERPercentbooleanOptionalIf the amount given in a company contribution is a % than true. Otherwise false, if the amount if an absolute dollar amount value.
isMonthlyJSONOptional
isMonthly (anyOf 1)booleanAlternativeIndicates 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)nullAlternative
matchingScheme401kstringOptionalThe defined matching scheme. Safe harbor is used if you want to use tiered matching.
One of: NON_ELECTIVE, SAFE_HARBOR
namestringOptionalName of the company deduction.
tiered_401k_matchesarrayOptionalThis 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[]stringEach item

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

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 — 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

PUT Employee 401k Deduction — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe 401k Deduction Model.
capsJSONOptional
caps (anyOf 1)objectAlternativeThe 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_limitJSONOptional
caps (anyOf 1).employee_401k_limit (anyOf 1)numberAlternativeFor all 401k accounts (Roth, and Traditional)
Format: float
Minimum: 0
caps (anyOf 1).employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).rothJSONOptional
caps (anyOf 1).roth (anyOf 1)objectAlternative
caps (anyOf 1).roth (anyOf 1).eeJSONOptional
caps (anyOf 1).roth (anyOf 1).ee (anyOf 1)stringAlternativeEmployee Roth 401k Limit
caps (anyOf 1).roth (anyOf 1).ee (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 1).erJSONOptional
caps (anyOf 1).roth (anyOf 1).er (anyOf 1)stringAlternativeEmployer Roth 401k limit
caps (anyOf 1).roth (anyOf 1).er (anyOf 2)nullAlternative
caps (anyOf 1).roth (anyOf 2)nullAlternative
caps (anyOf 1).total_401k_limitnumberOptionalTotal contribution limit from the employee and the employer.
Format: float
Minimum: 0
caps (anyOf 1).traditionalobjectOptional
caps (anyOf 1).traditional.eeJSONOptional
caps (anyOf 1).traditional.ee (anyOf 1)stringAlternativeEmployee traditional 401k limit.
caps (anyOf 1).traditional.ee (anyOf 2)nullAlternative
caps (anyOf 1).traditional.employee_401k_limitJSONOptional
caps (anyOf 1).traditional.employee_401k_limit (anyOf 1)stringAlternativeThe traditional employee 401k limit.
caps (anyOf 1).traditional.employee_401k_limit (anyOf 2)nullAlternative
caps (anyOf 1).traditional.erJSONOptional
caps (anyOf 1).traditional.er (anyOf 1)stringAlternativeEmployer traditional 401k limit.
caps (anyOf 1).traditional.er (anyOf 2)nullAlternative
caps (anyOf 2)nullAlternative
employerstringOptionalEither 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_percentbooleanOptionalWhether 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_percentbooleanOptionalWhether 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.
loanstringOptionalEither a flat dollar or % loan contribution amount. This should be used in conjunction with loan_is_percent.
loan_is_percentbooleanOptionalWhether the loan contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
rothstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with roth_is_percent.
roth_employerstringOptionalEither 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_percentbooleanOptionalWhether the ROTH contribution amount provided is a percentage of the gross wages or a flat dollar contribution amount.
traditionalstringOptionalEither a flat dollar or % contribution amount. This should be used in conjunction with traditional_is_percent.
traditional_is_percentbooleanOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRootA 401K Tiered Match object. Defines the employer match scheme for 401K contributions.
einstringOptionalIf set, this tiered match will only apply to employees in this entity.
employeesarrayOptionalThe 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[]stringEach item
employerMatch401KarrayOptionalAn employer 401k match object.
employerMatch401K[]JSONEach item
employerMatch401K[] (anyOf 1)objectAlternative
employerMatch401K[] (anyOf 1).eePercentCompstringOptionalEmployee percent
employerMatch401K[] (anyOf 1).erMatchPercentstringOptionalEmployer match percentage
employerMatch401K[] (anyOf 1).tierNumintegerOptionalTier number
employerMatch401K[] (anyOf 2)nullAlternative
idstringOptionalUnique identifier of the 401K Tiered Match object.
isDefaultbooleanOptionalIf 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.
matchingScheme401KstringRequired within parentOne of: SAFE_HARBOR_BASIC, SAFE_HARBOR_ENHANCED, CUSTOM

Retrieve R&D credits — response body — credits item

FieldTypePresenceDescription and constraints
$objectRootAn R&D Credit object
companystringOptionalRippling ID of the company
differentEinstringOptionalIf 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.
einstringRequired within parentEin 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.
endDatestringRequired within parentThis 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
returnFilingDatestringRequired within parentThis is the date the company filed to the IRS. Date format is MM/DD/YYYY
Format: date
returnTypestringOptionalThis 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
totalCreditsstringRequired within parentThe value of the credits granted by IRS.
useDifferentEinbooleanOptionalIf 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

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.