Holiday

Get

/employers/{employerId}/reports/holiday

Returns a report summarising holiday usage for all employees.

Deprecation notice: Accept: application/pdf returns a PDF link and is deprecated. Use Accept: application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027. Legacy PDF-link responses include Deprecation (RFC 9745 date @<unix-seconds>), Sunset, Warning, and optional Link headers.

Store values

Parameters

employerId string

accruals

boolean

If set to true then you'll receive a report for holiday pay accruals instead of holiday allowances. Defaults to false. (optional)

accrualsHrs

boolean

If set to true then you'll receive a report for holiday pay accruals hours. Defaults to false. (optional)

Try it Accept:

Deprecated: application/pdf returns a PDF link. Use application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027.

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`HolidayReportReportResponse`	application/json