post https://api.bamboohr.com/api/gateway.php//v1/employee_pay_stub
Add an employee's paystub
Sample Request
{
"employeeId": 1234,
"externalRecordId": "B45381984",
"payPeriodFrom": "2015-08-16",
"payPeriodTo": "2015-08-31",
"payDate": "2015-09-05",
"payorName": "BambooHR",
"payorAdd1": "333 South 520 West",
"payorAdd2": "Suite 200",
"payorCity": "Lindon",
"payorState": "UT",
"payorZip": "84042-1911",
"payeeName": "Robert M. Binetti",
"currencyCode": "USD",
"net": 3272.50,
"gross": 5000.50,
"totalTaxes": 795.12,
"totalDeductions": 932.38,
"ytdNet": 55632.50,
"ytdGross": 85000.50,
"ytdTaxes": 13517.04,
"ytdDeductions": 15850.46,
"fedWithholding": 4,
"stateWithholding": 4,
"localWithholding": null,
"additionalFed": null,
"additionalState": null,
"additionalLocal": null,
"taxState": "UT",
"taxLocal": null,
"federalType": "2020_w4",
"twoJobs": "true",
"dependentsAmount": "6000.00",
"otherIncome": "100.00",
"deductionsAmount": "2.50",
"wages": [
{
"externalWageId": "BASE",
"wageDescription": "Salary",
"wageAmount": 5000.00,
"ytdWageAmount": 85000.00,
"wageRate": 0.0,
"hours": 0.0
}
],
"taxes": [
{
"externalTaxId": "FED",
"taxDescription": "Federal Income Tax",
"taxAmount": 278.93,
"ytdTaxAmount": 4741.81
},
{
"externalTaxId": "SS",
"taxDescription": "Social Security",
"taxAmount": 306.25,
"ytdTaxAmount": 5206.25
},
{
"externalTaxId": "MEDI",
"taxDescription": "Medicaid",
"taxAmount": 9.94,
"ytdTaxAmount": 168.98
},
{
"externalTaxId": "STATE-UT",
"taxDescription": "Utah State Income Tax",
"taxAmount": 200.00,
"ytdTaxAmount": 3400.00
}
],
"deductions": [
{
"externalDeductionId": "MED-UHC-BASE-PPO",
"deductionDescription": "Medical - UHC Traditional",
"deductionAmount": 217.24,
"ytdDeductionAmount": 3693.08
},
{
"externalDeductionId": "DENTAL-VALUE",
"deductionDescription": "Dental - Delta Value",
"deductionAmount": 47.25,
"ytdDeductionAmount": 803.25
},
{
"externalDeductionId": "401K",
"deductionDescription": "401(k)",
"deductionAmount": 667.89,
"ytdDeductionAmount": 11354.13
}
],
"deposits": [
{
"depositOrder": "1",
"depositAmount": 2272.50,
"maskedAccountNumber": "X-8601",
"accountType": "checking"
},
{
"depositOrder": "2",
"depositAmount": 1000.00,
"maskedAccountNumber": "X-7124",
"accountType": "savings"
}
]
}
Notes
The Sample Request below is what is the required minimum elements to create a paystub record
currencyCode: Please use the ISO 3 Character Currency Code
All dates need to be submitted in ISO Date Format. (YYYY-MM-DD format)
For proper grouping of wage types, taxes and deductions please keep your external IDs consistent.
maskedAccountNumber needs to be provided in the following format: X-nnnn
BambooHR does not provide any validation of YTD accumulators. the data is stored for display purposes only.