Get Current Due Amount
Retrieve a list of users with their current due amounts (excluding the tenant owner). Supports pagination and sorting by various accounting fields.
Method: GET
Query Parameters:
Parameter | Type | Description |
---|---|---|
q | string | Search query to filter users by name |
page | integer | Page number for pagination (default: 1) |
size | integer | Number of items per page (default: 10) |
sort | string | Field to sort by (default: due) |
order | string | Sort order: ASC or DESC (default: DESC) |
Sortable Fields:
gross
- Total gross earningsnet
- Net earnings after deductionspaid
- Amount already paiddue
- Amount currently due (default)lastCalculatedAt
- When accounting was last calculatedJWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Search query to filter users by name or nickname
Page number for pagination
x >= 1
Number of items per page
1 <= x <= 100
Field to sort by
gross
, net
, paid
, due
, lastCalculatedAt
Sort order
ASC
, DESC
Current due amounts list retrieved successfully
The response is of type object
.