post https://sandbox.newcraft.io/employees/:employee_id/employee_payrolls/:employee_payroll_id/get
Retrieves a specific payroll run data.
Response Definitions
Response Item | Description | Data type |
---|---|---|
id | The ID associated with the employee on payroll. Each employee ID is assigned by NewCraft. | String |
{attributes}/id | The ID associated with the employee on payroll. Each employee ID is assigned by NewCraft. | String |
{attributes}/gross_pay | The gross pay of the employee for the fiscal year so far. This includes things like any bonuses received. | String |
{attributes}/net_pay | The net pay of the employee for the fiscal year so far. | String |
{attributes}/taxes | The amount of money that has been deducted from the employee's pay for the purposes of taxes so far this fiscal year. | String |
{attributes}/check_data | The date and time the employee was last given a paycheck, in Zulu time. | String |
attributes/{pay_period_end_date} | The end date of the employee's most recent pay period, in the format "YYYY-MM-DD". | String |
attributes/{pay_period_start_date} | The start date of the employee's most recent pay period, in the format "YYYY-MM-DD". | String |
{attributes}/[deductions] | A list of deductions the employee is signed up for. This does not include the cost of each deduction, but simply the name of each one. The name of each deduction is stored as a string. | List |
{attributes}/last_refreshed_at | When this object was last refreshed, in Zulu time. | string |
Sample Response
{
"data": {
"id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
"type": "EmployeePayroll",
"attributes": {
"id": "6cfee506-f278-4d31-b9b3-01b5505fd5b3",
"gross_pay": "4055.00",
"net_pay": "3000.00",
"taxes": "600.00",
"payroll_id": "551b88cc-f808-4828-a464-142af620bdce",
"payroll_check_date": "2020-10-15",
"payroll_pay_period_end_date": "2020-10-14",
"payroll_pay_period_start_date": "2020-10-01",
"deductions": [
"Flexible Spending Account"
],
"last_refreshed_at": "2020-10-29T02:44:05Z"
}
}
}