| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
Optional<String> | ✔️ | A unique identifier for an object. | 12345 |
employeeId |
JsonNullable<String> | ➖ | ID of the employee | 12345 |
companyId |
JsonNullable<String> | ➖ | The unique identifier of the company. | 23456 |
processed |
Optional<Boolean> | ✔️ | Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. | false |
processedDate |
JsonNullable<String> | ➖ | The date the payroll was processed. | 2022-04-08 |
checkDate |
Optional<String> | ✔️ | The date on which employees will be paid for the payroll. | 2022-04-08 |
startDate |
Optional<String> | ✔️ | The start date, inclusive, of the pay period. | 2022-04-08 |
endDate |
Optional<String> | ✔️ | The end date, inclusive, of the pay period. | 2022-04-21 |
totals |
Optional<PayrollTotals> | ➖ | The overview of the payroll totals. | |
compensations |
List<Compensation> | ➖ | An array of compensations for the payroll. |