List Employee Benefits
list_benefitsRetrieve employee benefit records including type, status, provider, value, and dates to review health coverage and allowances.
Instructions
Get employee benefit records (health cover, allowances etc.) including type, status, provider, value and dates.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| comments | No | Return only benefits 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 benefits with this partial text within the description field | |
| end_date_to | No | Only benefits that finish on/before this date (format yyyy-mm-dd) | |
| 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. | |
| benefit_type | No | Only list records matching this benefit type | |
| end_date_from | No | Only benefits that finish on/after this date (format yyyy-mm-dd) | |
| start_date_to | No | Only benefits that started on/before this date (format yyyy-mm-dd) | |
| benefit_status | No | Only list records matching this benefit status | |
| start_date_from | No | Only benefits that started on/after this date (format yyyy-mm-dd) | |
| benefit_value_to | No | Only benefits with a value less than or equal to this figure | |
| benefit_value_from | No | Only benefits with a value greater than or equal to this figure | |
| benefit_value_period | No | Only benefits which have this value period (e.g. Month, Year) |