Calculer la synthèse des ventes d'une période

GET

/api/sales/summary

Retourne les totaux des ventes d'une période (avant et après taxes, nombre de factures, clients facturés, facture moyenne) et leur répartition par jour, semaine, mois, trimestre ou année selon group_by. Les ventes sont les factures datées dans la période, payées ou non, taxes incluses ; les crédits émis depuis la facturation y sont comptés comme des factures de montant négatif, alors que les crédits saisis directement aux comptes clients, les commandes et les soumissions sont exclus. La série contient tous les intervalles de la période, même sans vente ; le premier et le dernier peuvent être partiels (is_partial). Conventions communes (cache de 4 h si la période se termine aujourd'hui ou plus tard, 24 h sinon, force_refresh, _links, metadata) : voir la présentation de la section Tableaux de bord.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

Synthèse des ventes de la période

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/sales/summary?from=&to=&group_by=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "self": "/api/sales/summary?from=2026-01-01&to=2026-04-30&group_by=month"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-05-13T09:12:00-04:00",
        "expires_at": "2026-05-13T13:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:aff479c00fb088436e5e544ceaf45071c7777953",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "currency": "CAD",
    "metadata": {
        "credits_scope": "none",
        "extracted_at": "2026-05-13T09:12:00-04:00",
        "invoice_types_included": [
            "invoice"
        ],
        "organisation_id": "entreprise_exemple",
        "scope": "invoicing_only",
        "sdk_index_used": 6
    },
    "period": {
        "from": "2026-01-01",
        "group_by": "month",
        "to": "2026-04-30"
    },
    "series": [
        {
            "active_customers_count": 22,
            "bucket": "2026-01",
            "credits_amount": 0,
            "credits_count": 0,
            "discounts": 0,
            "from": "2026-01-01",
            "invoices_count": 32,
            "is_partial": false,
            "revenue_gross": 58200,
            "revenue_net": 58200,
            "subtotal": 50620.27,
            "taxes": 7579.73,
            "to": "2026-01-31"
        },
        {
            "active_customers_count": 24,
            "bucket": "2026-02",
            "credits_amount": 0,
            "credits_count": 0,
            "discounts": 0,
            "from": "2026-02-01",
            "invoices_count": 35,
            "is_partial": false,
            "revenue_gross": 61450,
            "revenue_net": 61450,
            "subtotal": 53446.38,
            "taxes": 8003.62,
            "to": "2026-02-28"
        }
    ],
    "totals": {
        "active_customers_count": 38,
        "average_invoice": 1750,
        "credits_amount": 0,
        "credits_count": 0,
        "discounts": 0,
        "invoices_count": 142,
        "revenue_gross": 248500,
        "revenue_net": 248500,
        "subtotal": 216135.35,
        "taxes": 32364.65
    }
}

Modified at 2026-10-10 14:01:59

Lister les clients inactifs depuis N jours

Comparer les ventes de deux périodes