Lister les meilleurs clients d'une période

GET

/api/sales/top-customers

Classe les clients selon leurs ventes de la période : ventes taxes incluses, nombre de factures ou facture moyenne, au choix de sort_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. Le sommaire et les parts (share_pct) portent sur tous les clients, même quand limit tronque la liste (metadata.truncated) ; les factures sans client forment un groupe d'identifiant 0. 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

Meilleurs clients de la période, avec le sommaire

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "_links": {
        "sales_summary": "/api/sales/summary?from=2026-01-01&to=2026-04-30&group_by=month",
        "self": "/api/sales/top-customers?from=2026-01-01&to=2026-04-30&limit=10&sort_by=revenue"
    },
    "cache": {
        "age_seconds": 247,
        "cached_at": "2026-05-13T09:12:00-04:00",
        "expires_at": "2026-05-14T09:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:3e9b1c7a2d4f6e8a0b2c4d6e8f0a1b3c5d7e9f1a",
        "status": "hit",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86153
    },
    "filter": {
        "limit": 10,
        "sort_by": "revenue"
    },
    "items": [
        {
            "_links": {
                "customer_overview": "/api/customers/by-id/105/overview",
                "customer_statement": "/api/customers/by-id/105/statement?from=2026-01-01&to=2026-04-30"
            },
            "avg_invoice": 7813.33,
            "customer": {
                "code": "CONS-EX",
                "id": 105,
                "name": "Construction Exemple inc."
            },
            "first_invoice_date": "2026-01-14",
            "invoices_count": 24,
            "last_invoice_date": "2026-04-22",
            "rank": 1,
            "revenue": 187520,
            "share_pct": 8.67
        },
        {
            "_links": {
                "customer_overview": "/api/customers/by-id/211/overview",
                "customer_statement": "/api/customers/by-id/211/statement?from=2026-01-01&to=2026-04-30"
            },
            "avg_invoice": 10712.25,
            "customer": {
                "code": "ATEL-FIC",
                "id": 211,
                "name": "Atelier Fictif enr."
            },
            "first_invoice_date": "2026-02-03",
            "invoices_count": 9,
            "last_invoice_date": "2026-04-28",
            "rank": 2,
            "revenue": 96410.25,
            "share_pct": 4.46
        }
    ],
    "metadata": {
        "extracted_at": "2026-05-13T09:12:00-04:00",
        "organisation_id": "entreprise_exemple",
        "scope": "invoicing_only_type_1",
        "scope_note": "Ventes du module Facturation, même périmètre que la synthèse des ventes",
        "sdk_indexes_used": {
            "invoicing": 6
        },
        "truncated": true
    },
    "period": {
        "from": "2026-01-01",
        "to": "2026-04-30"
    },
    "summary": {
        "currency": "CAD",
        "customers_count": 78,
        "invoices_count": 1406,
        "revenue_total": 2162345.5
    }
}

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

Comparer les ventes de deux périodes

Lister les ventes par territoire