Lire le solde d'un compte de banque par ID

GET

/api/cashflow/bank-accounts/by-id/{account_id}

Retourne le solde courant d'un compte de banque à partir de son identifiant interne, avec le détail des 13 périodes de l'exercice (variation nette et solde cumulé). Le compte doit être de catégorie banque, sinon la requête est refusée (422) ; pour les autres comptes, utilisez les soldes du plan comptable (/api/organisation/charters). Disponible aussi par numéro de compte via /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: ********************

Path Params

Query Params

Responses

🟢200

application/json

Solde du compte de banque, avec le détail par période

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/by-id/?force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "charter": "/api/organisation/charters/by-id/91",
        "charter_balances": "/api/organisation/charters/by-id/91/balances",
        "list": "/api/cashflow/bank-accounts",
        "self": "/api/cashflow/bank-accounts/by-id/91",
        "self_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
    },
    "by_period": [
        {
            "is_empty": false,
            "movement": -292346.13,
            "period": 1,
            "running_balance": -123302.41
        },
        {
            "is_empty": false,
            "movement": 17781.89,
            "period": 2,
            "running_balance": -105520.52
        },
        {
            "is_empty": false,
            "movement": 153737.88,
            "period": 3,
            "running_balance": 48217.36
        },
        {
            "is_empty": true,
            "movement": 0,
            "period": 4,
            "running_balance": 48217.36
        }
    ],
    "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
    },
    "currency": "CAD",
    "current_balance": 48217.36,
    "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",
        "fiscal_periods_count": 13,
        "last_active_period": 3,
        "note_periods": "by_period.movement est la variation nette de la période (pas le solde de fin de période) ; running_balance est le solde d'ouverture plus les variations jusqu'à cette période.",
        "organisation_id": "entreprise_exemple",
        "sdk_indexes_used": {
            "charter": 1
        }
    },
    "opening_balance": 169043.72,
    "status": {
        "is_active": true,
        "is_archived": false,
        "is_used": true
    },
    "ytd_net_movement": -120826.36
}

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

Lister les soldes des comptes de banque

Lire le solde d'un compte de banque par code