Consulter la vue 360° d'un fournisseur par ID

GET

/api/suppliers/by-id/{supplier_id}/overview

Retourne en une seule réponse la synthèse d'un fournisseur, à partir de son identifiant interne : fiche et conditions de paiement, solde dû, âge des comptes, indicateurs de la période et dernière activité. Disponible aussi par code fournisseur via /{code}/overview. La période couvre les period_months mois (12 par défaut) qui se terminent à la date as_of (aujourd'hui par défaut) et se compare à la période précédente de même longueur. Le solde et l'âge des comptes sont nets (factures moins crédits non appliqués) et identiques à l'âge des comptes du fournisseur ; Acomba ne gérant ni limite de crédit ni blocage pour les fournisseurs, credit_limit et is_on_hold sont absents. 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: ********************

Path Params

Query Params

Responses

🟢200

application/json

Vue 360° du fournisseur

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/suppliers/by-id//overview?as_of=&period_months=&bucket_type=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "aging": "/api/suppliers/aging/by-id/34",
        "detail": "/api/suppliers/by-id/34",
        "self": "/api/suppliers/by-id/34/overview",
        "statement": "/api/suppliers/by-id/34/statement?from=2025-05-13&to=2026-05-13"
    },
    "aging": {
        "bucket_type": "standard",
        "buckets": {
            "days_0_30": 5000,
            "days_30_60": 270,
            "days_60_90": 0,
            "days_over_90": 7180.5
        },
        "percentages": {
            "days_0_30": 40.16,
            "days_30_60": 2.17,
            "days_60_90": 0,
            "days_over_90": 57.67
        }
    },
    "as_of_date": "2026-05-13",
    "balance": {
        "days_most_overdue": 113,
        "is_past_due": true,
        "oldest_open_invoice": {
            "amount_remaining": 7180,
            "code": "F-87521",
            "date": "2025-12-21",
            "days_past_due": 113,
            "due_date": "2026-01-20",
            "id": 1850
        },
        "open_invoices_count": 4,
        "total_open": 12450.5
    },
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-05-13T09:12:00-04:00",
        "expires_at": "2026-05-13T13:12:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:6e83b1f0c2d94a7e8f5b3c1d2e4f6a8b9c0d1e2f",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "last_activity": {
        "days_since_last_activity": 13,
        "last_invoice": {
            "amount": 1500,
            "code": "F-88140",
            "date": "2026-04-22",
            "days_ago": 21,
            "id": 2201
        },
        "last_payment": {
            "amount": 1500,
            "code": "4439",
            "date": "2026-04-30",
            "days_ago": 13,
            "id": 880
        },
        "last_transaction_date": "2026-04-30"
    },
    "metadata": {
        "extracted_at": "2026-05-13T09:12:00-04:00",
        "organisation_id": "entreprise_exemple",
        "scope": "non_archived_only",
        "sdk_indexes_used": {
            "invoice_ap": 6,
            "payment_ap": 1,
            "payment_ap_line": 1
        }
    },
    "period": {
        "from": "2025-05-13",
        "months": 12,
        "to": "2026-05-13"
    },
    "period_kpis": {
        "average_days_to_pay": 32.1,
        "average_invoice": 4233.33,
        "credits_count": 1,
        "invoices_count": 6,
        "on_time_payment_rate_pct": 83.33,
        "payments_count": 5,
        "spend_current": 25400,
        "spend_growth_pct": 39.18,
        "spend_previous": 18250,
        "transactions_count": 12
    },
    "supplier": {
        "code": "QUINC-FIC",
        "id": 34,
        "is_active": true,
        "is_inactive": false,
        "name": "Quincaillerie Fictive ltée",
        "payment_terms": {
            "code": "2",
            "id": 2,
            "label": "Net 30 jours"
        }
    }
}

Modified at 2026-10-09 19:59:12

Lire le relevé de transactions d'un fournisseur par code

Consulter la vue 360° d'un fournisseur par code