List Expense Claims
list_expensesRetrieve employee expense claims with detailed, summary, or transaction report types. Filter by status, employee, project, department, date ranges, and more for targeted results.
Instructions
Get employee expense claims. The report_type controls the shape: 'detailed' returns claim headers plus expense lines and attachments, 'summary' returns claim headers only, 'transaction' returns expense lines only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Only claims with this status | |
| is_paid | No | Filter claims on whether they have been paid (true/false) | |
| project | No | The project name to filter by | |
| employee | No | Employee code to only return records for that particular employee | |
| location | No | One or more location names (separated by commas) to filter by | |
| department | No | One or more department names (separated by commas) to filter by | |
| 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. | |
| report_type | Yes | Required. 'detailed' = claim headers + lines + attachments; 'summary' = claim headers only; 'transaction' = expense lines only | |
| expense_date_to | No | Only expenses dated on/before this date (format yyyy-mm-dd) | |
| approved_date_to | No | Only claims approved on/before this date (format yyyy-mm-dd) | |
| expense_category | No | The expense category name to filter by | |
| expense_date_from | No | Only expenses dated on/after this date (format yyyy-mm-dd) | |
| submitted_date_to | No | Only claims submitted on/before this date (format yyyy-mm-dd) | |
| approved_date_from | No | Only claims approved on/after this date (format yyyy-mm-dd) | |
| submitted_date_from | No | Only claims submitted on/after this date (format yyyy-mm-dd) |