Calculer les encaissements clients d'une période

GET

/api/payments/collected

Totalise les paiements réellement reçus des clients entre from et to (dates incluses), avec une série par jour, par semaine ou par mois et les 5 clients au plus fort encaissement net. Les paiements et prélèvements comptent comme encaissements, et les remboursements versés aux clients en sont déduits (net_collected) ; les paiements saisis depuis la facturation, les paiements en attente et les paiements archivés sont exclus. Le pendant côté fournisseurs est /api/payments/disbursed. 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

Encaissements clients de la période, avec la série et les principaux clients

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "_links": {
        "sales_summary": "/api/sales/summary?from=2026-07-01&to=2026-09-30&group_by=month",
        "self": "/api/payments/collected?from=2026-07-01&to=2026-09-30&group_by=month"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T09:12:00-04:00",
        "expires_at": "2026-10-08T09:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:3f9c2a71d04be5e8a6c1f0b97d2e4a58c3b16e90",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86400
    },
    "metadata": {
        "cards_scanned": 6200,
        "extracted_at": "2026-10-07T09:12:00-04:00",
        "organisation_id": "entreprise_exemple",
        "payment_types_included": {
            "payments": [
                1,
                2
            ],
            "refunds": [
                3
            ]
        },
        "scope": "non_archived_excluding_from_invoicing",
        "sdk_indexes_used": {
            "customer_payment": 1
        }
    },
    "period": {
        "from": "2026-07-01",
        "group_by": "month",
        "to": "2026-09-30"
    },
    "series": [
        {
            "active_customers_count": 29,
            "bucket": "2026-07",
            "from": "2026-07-01",
            "is_partial": false,
            "net_collected": 111600,
            "payments_amount": 112450,
            "payments_count": 41,
            "refunds_amount": 850,
            "refunds_count": 1,
            "to": "2026-07-31"
        },
        {
            "active_customers_count": 27,
            "bucket": "2026-08",
            "from": "2026-08-01",
            "is_partial": false,
            "net_collected": 98720.5,
            "payments_amount": 98720.5,
            "payments_count": 38,
            "refunds_amount": 0,
            "refunds_count": 0,
            "to": "2026-08-31"
        },
        {
            "active_customers_count": 33,
            "bucket": "2026-09",
            "from": "2026-09-01",
            "is_partial": false,
            "net_collected": 130110.25,
            "payments_amount": 131310.25,
            "payments_count": 45,
            "refunds_amount": 1200,
            "refunds_count": 1,
            "to": "2026-09-30"
        }
    ],
    "top_customers": [
        {
            "customer": {
                "code": "CONST-EX",
                "id": 211,
                "name": "Construction Exemple inc."
            },
            "net_collected": 48300,
            "payments_amount": 48300,
            "payments_count": 9,
            "refunds_amount": 0,
            "refunds_count": 0
        },
        {
            "customer": {
                "code": "RENO-FIC",
                "id": 318,
                "name": "Rénovations Fictives enr."
            },
            "net_collected": 31025.4,
            "payments_amount": 31875.4,
            "payments_count": 7,
            "refunds_amount": 850,
            "refunds_count": 1
        }
    ],
    "totals": {
        "active_customers_count": 61,
        "average_payment": 2761.94,
        "currency": "CAD",
        "net_collected": 340430.75,
        "payments": {
            "amount": 342480.75,
            "count": 124
        },
        "refunds": {
            "amount": 2050,
            "count": 2
        }
    }
}

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

Lire une obligation de taxes à remettre par ID

Calculer les décaissements fournisseurs d'une période