Lister les soldes des comptes de banque

GET

/api/cashflow/bank-accounts

Retourne le solde courant de chaque compte de banque du plan comptable, avec les totaux (somme des soldes, nombre de comptes positifs, négatifs et nuls). Par défaut, les comptes inactifs et archivés sont exclus ; include_inactive et include_archived les ajoutent. Le détail par période d'un compte est disponible via /bank-accounts/by-id/{account_id} ou /bank-accounts/{code}. Le solde courant est le solde d'ouverture de l'exercice plus les variations nettes des 13 périodes ; il peut être négatif (marge de crédit, découvert). Seules les écritures transférées au grand livre sont comptées : les écritures non transférées sont exclues. Conventions communes (cache de 1 h, 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

Soldes courants des comptes de banque, avec les totaux

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/cashflow/bank-accounts?include_inactive=&include_archived=&sort_by=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "cashflow_forecast": "/api/cashflow/forecast",
        "self": "/api/cashflow/bank-accounts?include_inactive=false&include_archived=false&sort_by=code_asc"
    },
    "accounts": [
        {
            "_links": {
                "charter": "/api/organisation/charters/by-id/91",
                "detail": "/api/cashflow/bank-accounts/by-id/91",
                "detail_by_code": "/api/cashflow/bank-accounts/1015"
            },
            "account": {
                "category": {
                    "code": "Cat_Bank",
                    "id": 1,
                    "label": "Compte de catégorie Banque"
                },
                "code": "1015",
                "description": "Banque Exemple — compte courant",
                "id": 91
            },
            "currency": "CAD",
            "current_balance": 48217.36,
            "last_active_period": 3,
            "opening_balance": 169043.72,
            "status": {
                "is_active": true,
                "is_archived": false,
                "is_used": true
            },
            "ytd_net_movement": -120826.36
        },
        {
            "_links": {
                "charter": "/api/organisation/charters/by-id/92",
                "detail": "/api/cashflow/bank-accounts/by-id/92",
                "detail_by_code": "/api/cashflow/bank-accounts/1020"
            },
            "account": {
                "category": {
                    "code": "Cat_Bank",
                    "id": 1,
                    "label": "Compte de catégorie Banque"
                },
                "code": "1020",
                "description": "Banque Exemple — marge de crédit",
                "id": 92
            },
            "currency": "CAD",
            "current_balance": -17345.5,
            "last_active_period": 3,
            "opening_balance": 6220.78,
            "status": {
                "is_active": true,
                "is_archived": false,
                "is_used": true
            },
            "ytd_net_movement": -23566.28
        }
    ],
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-10-07T09:12:00-04:00",
        "expires_at": "2026-10-07T10:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:4f1c2b9a7e0d3c5b8a6f2e1d0c9b8a7f6e5d4c3b",
        "status": "miss",
        "ttl_policy": "current_period_1h",
        "ttl_remaining_seconds": 3600
    },
    "filter": {
        "include_archived": false,
        "include_inactive": false,
        "sort_by": "code_asc"
    },
    "metadata": {
        "data_freshness": "Seules les écritures transférées au grand livre sont comptées ; les écritures non transférées sont exclues.",
        "extracted_at": "2026-10-07T09:12:00-04:00",
        "organisation_id": "entreprise_exemple",
        "sdk_indexes_used": {
            "charter": 2
        }
    },
    "summary": {
        "accounts_count": 2,
        "currency": "CAD",
        "negative_count": 1,
        "positive_count": 1,
        "total_current_balance": 30871.86,
        "total_opening_balance": 175264.5,
        "total_ytd_net_movement": -144392.64,
        "zero_count": 0
    }
}

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

Calculer la prévision de trésorerie

Lire le solde d'un compte de banque par ID