List Employee Renewables
list_renewablesRetrieve employee renewable documents such as licences, certifications, and visas, with issue and renewal dates, filtering by employee, department, or date range.
Instructions
Get employee renewable document records (licences, certifications, visas etc.) including type, description, issue date and renewal due date.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| comments | No | Return only records with this partial text within the comments field | |
| employee | No | Employee code to only return records for that particular employee | |
| department | No | One or more department names (separated by commas) to filter by | |
| description | No | Return only records with this partial text within the description field | |
| max_records | No | Optional client-side limit on the number of records returned. Use to keep responses small when exploring data; the API itself does not paginate. | |
| issue_date_to | No | Only renewables issued on/before this date (format yyyy-mm-dd) | |
| renewable_type | No | Only list records matching this renewable type | |
| issue_date_from | No | Only renewables issued on/after this date (format yyyy-mm-dd) | |
| renewal_date_to | No | Only renewables due for renewal on/before this date (format yyyy-mm-dd) | |
| renewal_date_from | No | Only renewables due for renewal on/after this date (format yyyy-mm-dd) |