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

GET

/api/payments/disbursed

Totalise les paiements versés aux fournisseurs entre from et to (dates incluses), avec la ventilation par mode de paiement (chèque, dépôt direct, comptant), une série par jour, par semaine ou par mois et les 5 fournisseurs ayant reçu les plus gros montants. Contrairement aux encaissements clients, aucun paiement n'est exclu selon son origine et il n'y a pas de remboursements à déduire : tous les paiements fournisseurs comptent, sauf les paiements en attente et les paiements archivés. Le pendant côté clients est /api/payments/collected. 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

Décaissements fournisseurs de la période, avec la ventilation par mode, la série et les principaux fournisseurs

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "_links": {
        "payables_to_pay": "/api/payables/to-pay",
        "self": "/api/payments/disbursed?from=2026-07-01&to=2026-09-30&group_by=month"
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T09:14:00-04:00",
        "expires_at": "2026-10-08T09:14:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:8d41b6e07a2c95f3e1d0c4b7a9f26e51d3c08b74",
        "status": "miss",
        "ttl_policy": "historical_24h",
        "ttl_remaining_seconds": 86400
    },
    "metadata": {
        "cards_scanned": 7190,
        "extracted_at": "2026-10-07T09:14:00-04:00",
        "organisation_id": "entreprise_exemple",
        "payment_types_included": {
            "cash": 3,
            "check": 1,
            "direct_deposit": 2
        },
        "scope": "non_archived_only",
        "sdk_indexes_used": {
            "payment_ap": 1
        }
    },
    "period": {
        "from": "2026-07-01",
        "group_by": "month",
        "to": "2026-09-30"
    },
    "series": [
        {
            "active_suppliers_count": 21,
            "bucket": "2026-07",
            "disbursements_amount": 98400,
            "disbursements_count": 26,
            "from": "2026-07-01",
            "is_partial": false,
            "to": "2026-07-31"
        },
        {
            "active_suppliers_count": 18,
            "bucket": "2026-08",
            "disbursements_amount": 76150.75,
            "disbursements_count": 22,
            "from": "2026-08-01",
            "is_partial": false,
            "to": "2026-08-31"
        },
        {
            "active_suppliers_count": 23,
            "bucket": "2026-09",
            "disbursements_amount": 104320.1,
            "disbursements_count": 28,
            "from": "2026-09-01",
            "is_partial": false,
            "to": "2026-09-30"
        }
    ],
    "top_suppliers": [
        {
            "disbursements_amount": 52480,
            "disbursements_count": 11,
            "supplier": {
                "code": "MAT-EX",
                "id": 42,
                "name": "Matériaux Exemple ltée"
            }
        },
        {
            "disbursements_amount": 38915.3,
            "disbursements_count": 6,
            "supplier": {
                "code": "BETON-FIC",
                "id": 57,
                "name": "Béton Fictif inc."
            }
        }
    ],
    "totals": {
        "active_suppliers_count": 39,
        "average_disbursement": 3669.35,
        "by_payment_mode": {
            "cash": {
                "amount": 2700,
                "count": 2
            },
            "check": {
                "amount": 41230.6,
                "count": 20
            },
            "direct_deposit": {
                "amount": 234940.25,
                "count": 54
            }
        },
        "currency": "CAD",
        "disbursements": {
            "amount": 278870.85,
            "count": 76
        }
    }
}

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

Calculer les encaissements clients d'une période

Lister les clients inactifs depuis N jours