Statistiques des factures

Aperçu

Renvoie les statistiques globales de vos factures.

Requête

curl -X POST https://api.bitsby.app/statistics/invoices \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
  -F "startDate=2000-01-01" \
  -F "endDate=2030-01-01"

Paramètres de la requête

Paramètre	Type de données	Description	Exemple	Obligatoire ?
startDate	String	Date de début de création des factures, au format Y-m-d	2000-01-01	non
endDate	String	Date de fin de création des factures, au format Y-m-d	2030-01-01	non

Exemple de réponse

{
    "result": "success",
    "data": {
        "invoicesTotalNum": 51,
        "invoicesPaidNum": 24,
        "invoicesTotalUSD": 335.03,
        "invoicesByProjects": {
            "9deea1e2-0c08-41a3-bdc2-a34eada3892d": 335.03
        },
        "invoicesByCurrencies": {
            "USD": 335.03
        },
        "invoicesByMonths": {
            "March-2024": 42,
            "February-2024": 293.03
        },
        "invoicesByDate": {
            "2024-03-04": {
                "date": 1709510400000,
                "value": 21
            },
            "2024-03-03": {
                "date": 1709424000000,
                "value": 10
            },
            "2024-03-01": {
                "date": 1709251200000,
                "value": 11
            },
            "2024-02-27": {
                "date": 1708992000000,
                "value": 12
            },
            "2024-02-26": {
                "date": 1708905600000,
                "value": 281.03
            }
        }
    }
}

Paramètres de la réponse

Paramètre	Description
invoicesTotalNum	Nombre total de factures
invoicesPaidNum	Nombre de factures payées (au statut Payée)
invoicesTotalUSD	Total de toutes les factures payées en USD
invoicesByProjects	Total de toutes les factures payées par projet, en USD
invoicesByCurrencies	Total de toutes les factures payées par devise
invoicesByMonths	Total de toutes les factures payées par mois, en USD
invoicesByDate	Total de toutes les factures payées par jour, en USD
invoicesByDate.date	Date en timestamp Unix, en millisecondes
invoicesByDate.value	Total de toutes les factures payées pour la date donnée, en USD