Lister les ventes par territoire

GET

/api/sales/by-territory

Regroupe les ventes de la période par territoire de la facture : ventes taxes incluses, nombre de factures, clients distincts, facture moyenne et part des ventes totales. 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. Les factures sans territoire forment un groupe à part (identifiant 0), classé avec les territoires et repris dans summary.unassigned_invoices_count et summary.unassigned_revenue ; le sommaire porte sur toutes les factures, même quand limit tronque la liste (metadata.truncated). 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

Ventes de la période par territoire, 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/by-territory?from=&to=&limit=&sort_by=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "all_territories": "/api/invoicing/territory",
        "sales_summary": "/api/sales/summary?from=2026-01-01&to=2026-06-30&group_by=month",
        "self": "/api/sales/by-territory?from=2026-01-01&to=2026-06-30&limit=50&sort_by=revenue"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-07-02T10:05:00-04:00",
        "expires_at": "2026-07-03T10:05:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:9a7c5e3b1d2f4a6c8e0b1d3f5a7c9e1b2d4f6a8c",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86400
    },
    "filter": {
        "limit": 50,
        "sort_by": "revenue"
    },
    "items": [
        {
            "_links": {
                "territory_detail": "/api/invoicing/territory/by-id/2"
            },
            "avg_invoice": 3197.66,
            "customers_count": 29,
            "first_invoice_date": "2026-01-05",
            "invoices_count": 214,
            "last_invoice_date": "2026-06-29",
            "rank": 1,
            "revenue": 684300,
            "share_pct": 54.93,
            "territory": {
                "code": 10,
                "id": 2,
                "name": "Montérégie"
            }
        },
        {
            "_links": {},
            "avg_invoice": 2341.67,
            "customers_count": 6,
            "first_invoice_date": "2026-02-11",
            "invoices_count": 18,
            "last_invoice_date": "2026-06-17",
            "rank": 4,
            "revenue": 42150,
            "share_pct": 3.38,
            "territory": {
                "id": 0,
                "name": "(territoire non assigné)"
            }
        }
    ],
    "metadata": {
        "extracted_at": "2026-07-02T10:05:00-04:00",
        "organisation_id": "entreprise_exemple",
        "scope": "invoicing_only_type_1",
        "scope_note": "Ventes du module Facturation, attribuées au territoire de chaque facture ; les factures sans territoire sont regroupées sous « non assigné ».",
        "sdk_indexes_used": {
            "invoicing": 6
        },
        "truncated": false
    },
    "period": {
        "from": "2026-01-01",
        "to": "2026-06-30"
    },
    "summary": {
        "currency": "CAD",
        "customers_count": 57,
        "invoices_count": 412,
        "revenue_total": 1245800,
        "territories_count": 3,
        "unassigned_invoices_count": 18,
        "unassigned_revenue": 42150
    }
}

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

Lister les meilleurs clients d'une période

Lister les ventes par représentant