Authentication
- X-API-KEY (HTTP header): required
- api_key (query param): alternative if header is not supported
1. List Clients
Parameter |
Type |
Default |
Description |
page |
integer |
1 |
Page number |
limit |
integer |
10 |
Results per page (max 100) |
Sample Response:
{
"success": true,
"page": 1,
"limit": 3,
"total": 5,
"clients": [
{
"id": 1,
"name": "Sample Client",
"email": "client@example.com"
}
]
}
2. List Transactions
Parameter |
Type |
Default |
Description |
page |
integer |
1 |
Page number |
limit |
integer |
10 |
Results per page (max 100) |
daterange |
string |
Last 7 days |
Format: "YYYY-MM-DD to YYYY-MM-DD" |
client_id |
integer |
- |
Filter by client |
Sample Response:
{
"success": true,
"page": 1,
"limit": 2,
"total": 6,
"transactions": [
{
"id": 11,
"client_id": 2,
"user_id": 1,
"amount": 45.50,
"type": "expense",
"description": "Invoice payment",
"date": "2024-06-06"
}
]
}
3. List Transactions for a Specific Client
Parameter |
Type |
Default |
Description |
id |
integer |
- |
The client ID (in URL path) |
page |
integer |
1 |
Page number |
limit |
integer |
10 |
Results per page (max 100) |
daterange |
string |
Last 7 days |
Format: "YYYY-MM-DD to YYYY-MM-DD" |
Sample Response:
{
"success": true,
"page": 1,
"limit": 2,
"total": 2,
"transactions": [
{
"id": 11,
"client_id": 1,
"user_id": 1,
"amount": 45.50,
"type": "income",
"description": "June payment",
"date": "2024-06-01"
}
]
}