expenses
List and search expense claims
Retrieve a paginated list of expense claims with filtering and sorting capabilities.
This endpoint allows partners to:
- Search expenses by employee name
- Filter by expense status (draft, approved, paid, etc.)
- Use predefined views for common queries
- Sort by submission date, amount, or creation date
- Paginate through large result sets
Results include expense summary information and can be filtered to show only relevant expenses based on status, employee, or predefined views.
get/v1/expenses
Query parameters
pageinteger
Example:1
Page number (1-indexed)
pageSizeinteger
Example:20
Number of items per page
memberNamestring
Filter expenses by employee name (supports partial matching)
statusstring[]
Filter by expense status (can specify multiple values)
view'ALL_PENDING' | 'PENDING_ON_ME' | 'HISTORY'
Predefined view filter for common queries
sortBy'submittedAt' | 'totalAmount' | 'createdOn' | 'updatedOn'
Field to sort results by
sortOrder'ASC' | 'DESC'
Sort direction
Response
List of expenses retrieved successfully
Example response
{
"data": [
{
"expenseId": "550e8400-e29b-41d4-a716-446655440000",
"title": "Business Travel - Singapore",
"status": "APPROVED",
"totalAmount": 1250.5,
"currency": "USD",
"submittedAt": "2025-10-15T10:30:00Z",
"createdOn": "2025-10-14T08:00:00Z",
"employeeId": "123e4567-e89b-12d3-a456-426614174000",
"items": [
{
"itemId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"title": "Flight Ticket",
"amount": 850,
"date": "2025-10-10T00:00:00Z",
"category": {
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Travel"
},
"description": "Round trip flight to Singapore"
}
]
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"totalCount": 100,
"totalPages": 5
}
}