Payroll
importPayrollDetails
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Reports
API Reference
Payroll
importPayrollDetails
POST
/
payroll#importPayrollDetails
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
username
string
username
string
password
string
password
string
object
method
importPayrollDetails · string
*
method
Required
string
Add Example Value
companyId
string
*
companyId
Required
string
payPeriodId
string
*
payPeriodId
Required
string
companyPayrollRecords
array
*
companyPayrollRecords
Required
array
Body
application/json
method
string
default: importPayrollDetailsrequiredcompanyId
string
requiredpayPeriodId
string
requiredcompanyPayrollRecords
object[]
requiredcompanyPayrollRecords.userId
string
requiredcompanyPayrollRecords.firstName
string
companyPayrollRecords.lastName
string
companyPayrollRecords.rate
integer
requiredcompanyPayrollRecords.numberofHours
integer
requiredcompanyPayrollRecords.amount
integer
companyPayrollRecords.additionalCompensation
object[]
companyPayrollRecords.additionalCompensation.description
enum<string>
requiredAvailable options:
Cash, Group Term Life Over $50000, Bonus, Stock Options, Educational Asst (Job Related), Educational Asst (Non-job Related), Adoption Assistance, Qualified Moving Expenses Reimbursements, Van Pool & Transit Passes, Qualified Parking, Reported Tips, HSA(125), HSA, Invalid 409A Deferral, 409A Distribution, ER STD 125 plan, ER LTD 125 plan, Agent STD 125 plan, Agent LTD 125 plan, 3rd Party STD 125 plan, 3rd Party LTD 125 plan, Golden Parachute, Domestic Partner Benefit Non-Dependent, Domestic Partner Benefit Dependent, Adult Child Health Coverage, Meals for the convenience of ER, Military Differential Pay, Same sex marriage spousal health care, Severance Pay, Severance Pay Required by law or contract, Deceased Worker Pay, Clergy Housing Allowance, Expanded Family and Medical Leave, Emergency Paid Sick Leave, S Corp 2% Shareholder Insurance Premiums, Phone Reimbursement, Well-Being Stipend companyPayrollRecords.additionalCompensation.amount
integer
requiredcompanyPayrollRecords.deductions
object[]
companyPayrollRecords.deductions.description
enum<string>
requiredAvailable options:
Medical Insurance (Employee Contribution), Dental Insurance (Employee Contribution), Vision Insurance (Employee Contribution), Life Insurance, Life Insurance - Spouse, Life Insurance - Child, Long Term Disability (LTD) Insurance, Short Term Disability (STD) Insurance, Critical Illness Insurance, Hospital Indemnity Insurance, Accident Insurance, Other Supplemental Insurance, Roth 401K Employee Contribution, Traditional IRA Employee Contribution, 401K Deferral Sup, 401K Deferral Reg, Roth 401K Sup, Roth 401K Reg, 401K CU2 Over 50 Sup, 401K CU2 Over 50 Reg, Insurance Benefits Sup, Insurance Benefits Reg, Qualified Parking Sup, Qualified Parking Reg, Vanpool and Transit Passes Sup, Vanpool and Transit Passes Reg, CN at Source, CN at Source Sup, CN RPP, CN RRSP Sup, CN RPP Sup, CN Union Dues, CN RRSP Reg, CN Union Dues Sup, 403B CU2 Over 50 Sup, 403B CU 15 year Sup, 403B CU2 Over 50 Reg, 403B Deferral Sup, 403B Deferral Reg, 403B CU 15 year Reg, 408P CU2 Over 50 Sup, 408P CU2 Over 50 Reg, 408K CU2 Over 50, 408K CU2 Over 50 Sup, 408K Deferral Sup, 408K Deferral Reg, 408P Deferral Sup, 408P Deferral Reg, 409A Deferral Sup, 409A Deferral Reg, 457 Deferral Sup, 457 Deferral Reg, 457CU Increased Limit Sup, 457CU Increased Limit Reg, 457 CU2 Over 50 Sup, 457 CU2 Over 50 Reg, 125HSA Sup, 125HSA Reg, 125DC Sup, 125DC Reg, 125HSA CU Sup, 125HSA CU Reg, 125Adoption Assistance Sup, 125Adoption Assistance Reg, 125FSA Sup, 125FSA Reg companyPayrollRecords.deductions.amount
string
requiredResponse
200 - application/json
payrollDocument
object
requiredpayrollDocument.payrolDocumentId
string
requiredpayrollDocument.status
string
requiredpayrollDocument.message
string