Reporting
Dashboards, revenue/receivables/profit-loss reports, and exports
Get aged receivables report
GET /api/v1/reports/aged-receivables
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/aged-receivables" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"
Get dashboard statistics
GET /api/v1/reports/dashboard
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
period |
query | string | non |
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
| 422 |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/dashboard" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"
Export data (CSV/JSON)
POST /api/v1/reports/export
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.export
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
resource |
string | oui | |
format |
string | non | |
date_from |
string | non | |
date_to |
string | non |
Réponses
| Statut | Description |
|---|---|
| 200 | |
| 422 |
Exemple de requête
curl -X POST "https://kworia.com/api/v1/reports/export" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"resource": "string",
"format": "string",
"date_from": "string",
"date_to": "string"
}'
Get profit & loss report
GET /api/v1/reports/profit-loss
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
date_from |
query | string | oui | |
date_to |
query | string | oui |
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
| 422 |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/profit-loss" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"
Get revenue report
GET /api/v1/reports/revenue
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
date_from |
query | string | oui | |
date_to |
query | string | oui | |
group_by |
query | string | non |
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
| 422 |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/revenue" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"
Get top customers report
GET /api/v1/reports/top-customers
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
limit |
query | integer | non |
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
| 422 |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/top-customers" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"
VAT / tax summary for a period
GET /api/v1/reports/vat
Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.
Portée du jeton API : reports.view
Output tax collected on outbound invoices vs input tax paid on VAT-deductible expenses, and the net position — bucketed by tax rate (and category). Params: date_from, date_to (required), grouping (monthly|quarterly|annual). Amounts are decimal strings in the organization currency; multi-currency periods return per-currency sections in rows.
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
date_from |
query | string | oui | |
date_to |
query | string | oui | |
grouping |
query | string | non |
Réponses
| Statut | Description |
|---|---|
| 200 | For non-paginated data, return as before |
| 422 |
Exemple de requête
curl -X GET "https://kworia.com/api/v1/reports/vat" \
-H "Authorization: Bearer {{access_token}}" \
-H "X-Organization-Id: {{organization_id}}" \
-H "Accept: application/json"