Field | Type | Required | Description | Example |
---|---|---|---|---|
id |
Nullable[str] | ✔️ | A unique identifier for an object. | 12345 |
processed |
Nullable[bool] | ✔️ | Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. | false |
check_date |
Nullable[str] | ✔️ | The date on which employees will be paid for the payroll. | 2022-04-08 |
start_date |
Nullable[str] | ✔️ | The start date, inclusive, of the pay period. | 2022-04-08 |
end_date |
Nullable[str] | ✔️ | The end date, inclusive, of the pay period. | 2022-04-21 |
company_id |
OptionalNullable[str] | ➖ | The unique identifier of the company. | 23456 |
processed_date |
OptionalNullable[str] | ➖ | The date the payroll was processed. | 2022-04-08 |
totals |
Optional[models.PayrollTotals] | ➖ | The overview of the payroll totals. | |
compensations |
List[models.Compensation] | ➖ | An array of compensations for the payroll. | |
custom_mappings |
OptionalNullable[models.CustomMappings] | ➖ | When custom mappings are configured on the resource, the result is included here. |