Calculer la prévision de trésorerie

GET

/api/cashflow/forecast

Calcule la trésorerie attendue sur un horizon de 1 à 26 semaines à partir de as_of : factures clients à percevoir, factures fournisseurs à payer et, par défaut, paie prévue (salaires nets et charges patronales, tirés de la prévision de masse salariale), découpés par semaine ou par mois ; les factures déjà échues sont isolées dans le bloc overdue pour ne pas fausser les périodes. Les montants sont nets, comme /api/receivables/to-collect et /api/payables/to-pay : chaque portée sépare factures, crédits non appliqués et net, et les clients ou fournisseurs dont le solde net est nul ou négatif sont exclus, sauf avec include_zero_balance=true ; le net à percevoir dans l'horizon, plus le net en retard et les montants au-delà de l'horizon ou sans échéance (metadata), égale donc le net à percevoir de /api/receivables/to-collect (même principe côté fournisseurs). Les anciens totaux (ar_expected_total, ap_due_total, net_cashflow, ar_overdue_total, ap_overdue_total) sont conservés comme synonymes des montants nets et n'incluent pas la paie ; net_cashflow_with_payroll la déduit. Conventions communes (cache de 4 h si as_of est aujourd'hui, 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

Prévision de trésorerie pour l'horizon demandé

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/cashflow/forecast?as_of=&weeks=&group_by=&include_overdue=&include_zero_balance=&mode=&bucketing=&include_payroll=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "ap_detail": "/api/payables/to-pay?as_of=2026-10-07&days_to_due_max=13&include_overdue=true&include_zero_balance=false",
        "ar_detail": "/api/receivables/to-collect?as_of=2026-10-07&include_zero_balance=false",
        "self": "/api/cashflow/forecast?as_of=2026-10-07&weeks=2&group_by=week&include_overdue=true&include_zero_balance=false&mode=naive&bucketing=contractual&include_payroll=true"
    },
    "as_of_date": "2026-10-07",
    "buckets": [
        {
            "ap_due": {
                "amount": 8320.5,
                "credits_amount": 0,
                "credits_count": 0,
                "invoices_count": 2,
                "invoices_due_amount": 8320.5,
                "net_amount": 8320.5
            },
            "ar_expected": {
                "amount": 12450,
                "credits_amount": 0,
                "credits_count": 0,
                "invoices_count": 3,
                "invoices_due_amount": 12450,
                "net_amount": 12450
            },
            "bucket_index": 1,
            "bucket_label": "W1",
            "from": "2026-10-07",
            "is_partial": true,
            "net": 4129.5,
            "net_with_payroll": -42479.48,
            "payroll_outflow": {
                "amount": 46608.98,
                "future_pays_count": 1,
                "payroll_burden_cash": 13714.56,
                "payroll_net": 32894.42
            },
            "to": "2026-10-11"
        },
        {
            "ap_due": {
                "amount": 15740.25,
                "credits_amount": 0,
                "credits_count": 0,
                "invoices_count": 4,
                "invoices_due_amount": 15740.25,
                "net_amount": 15740.25
            },
            "ar_expected": {
                "amount": 27650,
                "credits_amount": 1250,
                "credits_count": 1,
                "invoices_count": 5,
                "invoices_due_amount": 28900,
                "net_amount": 27650
            },
            "bucket_index": 2,
            "bucket_label": "W2",
            "from": "2026-10-12",
            "is_partial": false,
            "net": 11909.75,
            "net_with_payroll": 11909.75,
            "payroll_outflow": {
                "amount": 0,
                "future_pays_count": 0,
                "payroll_burden_cash": 0,
                "payroll_net": 0
            },
            "to": "2026-10-18"
        },
        {
            "ap_due": {
                "amount": 0,
                "credits_amount": 0,
                "credits_count": 0,
                "invoices_count": 0,
                "invoices_due_amount": 0,
                "net_amount": 0
            },
            "ar_expected": {
                "amount": 6300,
                "credits_amount": 0,
                "credits_count": 0,
                "invoices_count": 1,
                "invoices_due_amount": 6300,
                "net_amount": 6300
            },
            "bucket_index": 3,
            "bucket_label": "W3",
            "from": "2026-10-19",
            "is_partial": true,
            "net": 6300,
            "net_with_payroll": -40308.98,
            "payroll_outflow": {
                "amount": 46608.98,
                "future_pays_count": 1,
                "payroll_burden_cash": 13714.56,
                "payroll_net": 32894.42
            },
            "to": "2026-10-20"
        }
    ],
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T09:12:00-04:00",
        "expires_at": "2026-10-07T13:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:72e5363c90bdb45b7081818dfa72a67bceb8016b",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "filter": {
        "bucketing": "contractual",
        "include_overdue": true,
        "include_payroll": true,
        "include_zero_balance": false,
        "mode": "naive"
    },
    "horizon": {
        "from": "2026-10-07",
        "group_by": "week",
        "to": "2026-10-20",
        "weeks": 2
    },
    "metadata": {
        "ap_beyond_horizon_amount": 21115.8,
        "ap_beyond_horizon_count": 3,
        "ap_invoices_excluded_count": 4,
        "ap_no_due_date_amount": 0,
        "ar_beyond_horizon_amount": 98340.15,
        "ar_beyond_horizon_count": 9,
        "ar_invoices_excluded_count": 19,
        "ar_no_due_date_amount": 0,
        "customers_in_scope": 41,
        "customers_scanned": 51,
        "extracted_at": "2026-10-07T09:12:00-04:00",
        "invoices_beyond_horizon": 12,
        "invoices_no_due_date": 0,
        "organisation_id": "entreprise_exemple",
        "payroll_future_pays_beyond_horizon": 0,
        "payroll_future_pays_in_horizon": 2,
        "payroll_future_pays_overdue": 0,
        "payroll_skipped": false,
        "scope": "open_invoices_only",
        "sdk_indexes_used": {
            "invoice_ap": [
                3,
                9
            ],
            "invoice_ar": 3
        },
        "semantic_version": "v5-payroll",
        "suppliers_in_scope": 22,
        "suppliers_scanned": 39
    },
    "overdue": {
        "ap": {
            "amount": 40604.05,
            "credits_amount": 1706.35,
            "credits_count": 1,
            "invoices_count": 17,
            "invoices_due_amount": 42310.4,
            "net_amount": 40604.05
        },
        "ar": {
            "amount": 180550.6,
            "credits_amount": 4870,
            "credits_count": 3,
            "invoices_count": 38,
            "invoices_due_amount": 185420.6,
            "net_amount": 180550.6
        }
    },
    "summary": {
        "ap_due_total": 24060.75,
        "ap_in_horizon_credits": 0,
        "ap_in_horizon_invoices_due": 24060.75,
        "ap_in_horizon_net": 24060.75,
        "ap_overdue_credits": 1706.35,
        "ap_overdue_invoices_due": 42310.4,
        "ap_overdue_net": 40604.05,
        "ap_overdue_total": 40604.05,
        "ar_expected_total": 46400,
        "ar_in_horizon_credits": 1250,
        "ar_in_horizon_invoices_due": 47650,
        "ar_in_horizon_net": 46400,
        "ar_overdue_credits": 4870,
        "ar_overdue_invoices_due": 185420.6,
        "ar_overdue_net": 180550.6,
        "ar_overdue_total": 180550.6,
        "currency": "CAD",
        "net_cashflow": 22339.25,
        "net_cashflow_with_payroll": -70878.71,
        "payroll_burden_cash_total": 27429.12,
        "payroll_future_pays_count": 2,
        "payroll_net_total": 65788.84,
        "payroll_total": 93217.96
    }
}

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

Présentation

Lister les soldes des comptes de banque