Lister les factures clients à percevoir

GET

/api/receivables/to-collect

Liste les factures clients ouvertes à percevoir, tous clients confondus, avec un sommaire par tranche d'âge. Les montants sont nets : les crédits non appliqués sont listés à part (is_credit=true, amount_remaining négatif) et les clients dont le solde net est nul ou négatif sont exclus, sauf avec include_zero_balance=true ; avec days_overdue_min=0, summary.net_to_collect égale donc le solde de ces clients dans l'âge des comptes. days_overdue_min ne filtre que les factures : les crédits des clients retenus restent listés. Le sommaire porte sur tous les éléments filtrés, même quand limit tronque la liste (metadata.truncated). 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

Factures et crédits clients ouverts, avec le sommaire

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/receivables/to-collect?as_of=&days_overdue_min=&bucket_type=&sort_by=&limit=&include_zero_balance=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "aging_global": "/api/customers/aging?as_of=2026-05-13&bucket_type=standard",
        "self": "/api/receivables/to-collect?as_of=2026-05-13&days_overdue_min=0&bucket_type=standard&sort_by=customer&limit=2&include_zero_balance=false"
    },
    "as_of_date": "2026-05-13",
    "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:b71a7fbc545a8ae531ae280e16e7145a7f6fe6ee",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "filter": {
        "bucket_type": "standard",
        "days_overdue_min": 0,
        "include_zero_balance": false,
        "limit": 2,
        "sort_by": "customer"
    },
    "items": [
        {
            "_links": {
                "customer_overview": "/api/customers/by-id/211/overview",
                "customer_statement": "/api/customers/by-id/211/statement?from=2025-05-13&to=2026-05-13",
                "invoice_detail": "/api/customers/invoice-ar/by-id/2214"
            },
            "amount_original": 1500,
            "amount_paid": 0,
            "amount_remaining": 1500,
            "bucket": "days_60_90",
            "customer": {
                "code": "ATEL-FIC",
                "id": 211,
                "name": "Atelier Fictif enr."
            },
            "days_overdue": 71,
            "due_date": "2026-03-03",
            "invoice": {
                "code": "15418",
                "date": "2026-02-01",
                "id": 2214,
                "reference": "Chantier rue des Érables",
                "transaction_type": {
                    "code": "invoice",
                    "id": 3,
                    "label": "Facture"
                }
            },
            "is_credit": false
        },
        {
            "_links": {
                "customer_overview": "/api/customers/by-id/211/overview",
                "customer_statement": "/api/customers/by-id/211/statement?from=2025-05-13&to=2026-05-13",
                "invoice_detail": "/api/customers/invoice-ar/by-id/2290"
            },
            "amount_original": -350,
            "amount_paid": 0,
            "amount_remaining": -350,
            "bucket": "days_0_30",
            "customer": {
                "code": "ATEL-FIC",
                "id": 211,
                "name": "Atelier Fictif enr."
            },
            "days_overdue": 0,
            "due_date": "2026-04-20",
            "invoice": {
                "code": "15466",
                "date": "2026-04-20",
                "id": 2290,
                "transaction_type": {
                    "code": "credit",
                    "id": 2,
                    "label": "Crédit"
                }
            },
            "is_credit": true
        }
    ],
    "metadata": {
        "customers_scanned": 51,
        "extracted_at": "2026-05-13T09:12:00-04:00",
        "limit_applied": 2,
        "organisation_id": "entreprise_exemple",
        "scope": "open_invoices_only",
        "sdk_indexes_used": {
            "customer_payment_line": 1,
            "invoice_ar": 3
        },
        "truncated": true
    },
    "summary": {
        "aging_percentages": {
            "days_0_30": 3.2,
            "days_30_60": 28.8,
            "days_60_90": 22.4,
            "days_over_90": 45.6
        },
        "aging_summary": {
            "days_0_30": 12350,
            "days_30_60": 110800,
            "days_60_90": 86200,
            "days_over_90": 175750
        },
        "credits_amount": 2350,
        "credits_count": 2,
        "currency": "CAD",
        "customers_count": 42,
        "invoices_due_amount": 387450,
        "invoices_due_count": 142,
        "net_to_collect": 385100,
        "total_amount": 385100,
        "total_invoices": 144
    }
}

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

Consulter la vue 360° d'un client par code

Lister les factures impayées d'un client par ID