Lister les factures fournisseurs à payer

GET

/api/payables/to-pay

Liste les factures fournisseurs ouvertes à payer, tous fournisseurs confondus, avec les montants en retard et dus dans les 7 prochains jours. Les montants sont nets : les crédits non appliqués sont listés à part (is_credit=true, amount_remaining négatif) et les fournisseurs dont le solde net est nul ou négatif sont exclus, sauf avec include_zero_balance=true ; sans filtre d'échéance, summary.net_to_pay égale donc le solde de ces fournisseurs dans l'âge des comptes. days_to_due_max et include_overdue ne filtrent que les factures : les crédits des fournisseurs 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 fournisseurs 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/payables/to-pay?as_of=&days_to_due_max=&include_overdue=&bucket_type=&sort_by=&limit=&include_zero_balance=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "aging_global": "/api/suppliers/aging?as_of=2026-05-13&bucket_type=standard",
        "self": "/api/payables/to-pay?as_of=2026-05-13&days_to_due_max=7&include_overdue=true&bucket_type=standard&sort_by=supplier&limit=2&include_zero_balance=false"
    },
    "as_of_date": "2026-05-13",
    "cache": {
        "age_seconds": 0,
        "cached_at": "2026-05-13T17:00:00-04:00",
        "expires_at": "2026-05-13T21:00:00-04:00",
        "force_refreshed": false,
        "key_hash": "sha1:4c2e9a7d1b3f5e8c0a6d2f4b8e1c3a5d7f9b0e2c",
        "status": "miss",
        "ttl_policy": "current_period_4h",
        "ttl_remaining_seconds": 14400
    },
    "filter": {
        "bucket_type": "standard",
        "days_to_due_max": 7,
        "include_overdue": true,
        "include_zero_balance": false,
        "limit": 2,
        "sort_by": "supplier"
    },
    "items": [
        {
            "_links": {
                "invoice_detail": "/api/suppliers/invoices-ap/by-id/4801",
                "supplier_overview": "/api/suppliers/by-id/7/overview",
                "supplier_statement": "/api/suppliers/by-id/7/statement?from=2025-05-13&to=2026-05-13"
            },
            "amount_original": 12500,
            "amount_paid": 0,
            "amount_remaining": 12500,
            "bucket": "days_0_30",
            "days_to_due": -29,
            "due_date": "2026-04-14",
            "invoice": {
                "code": "F-87521",
                "date": "2026-03-15",
                "id": 4801,
                "reference": "BC-22198",
                "transaction_type": {
                    "code": "invoice",
                    "id": 2,
                    "label": "Facture"
                }
            },
            "is_credit": false,
            "is_overdue": true,
            "supplier": {
                "code": "BETON-FIC",
                "id": 7,
                "name": "Béton Fictif inc."
            }
        },
        {
            "_links": {
                "invoice_detail": "/api/suppliers/invoices-ap/by-id/4890",
                "supplier_overview": "/api/suppliers/by-id/7/overview",
                "supplier_statement": "/api/suppliers/by-id/7/statement?from=2025-05-13&to=2026-05-13"
            },
            "amount_original": -3350,
            "amount_paid": 0,
            "amount_remaining": -3350,
            "bucket": "days_0_30",
            "days_to_due": 0,
            "due_date": "2026-04-28",
            "invoice": {
                "code": "NC-3341",
                "date": "2026-04-28",
                "id": 4890,
                "transaction_type": {
                    "code": "credit",
                    "id": 1,
                    "label": "Crédit"
                }
            },
            "is_credit": true,
            "is_overdue": false,
            "supplier": {
                "code": "BETON-FIC",
                "id": 7,
                "name": "Béton Fictif inc."
            }
        }
    ],
    "metadata": {
        "extracted_at": "2026-05-13T17:00:00-04:00",
        "limit_applied": 2,
        "organisation_id": "entreprise_exemple",
        "scope": "open_invoices_only",
        "sdk_indexes_used": {
            "invoice_ap": [
                3,
                9
            ],
            "payment_line_ap": 1
        },
        "suppliers_scanned": 39,
        "truncated": true
    },
    "summary": {
        "aging_percentages": {
            "days_0_30": 25.2,
            "days_30_60": 45.6,
            "days_60_90": 19.7,
            "days_over_90": 9.5
        },
        "aging_summary": {
            "days_0_30": 21150,
            "days_30_60": 38200,
            "days_60_90": 16500,
            "days_over_90": 8000
        },
        "credits_amount": 3350,
        "credits_count": 1,
        "currency": "CAD",
        "due_within_7d_amount": 100300,
        "due_within_7d_count": 14,
        "invoices_due_amount": 187500,
        "invoices_due_count": 28,
        "net_to_pay": 184150,
        "overdue_amount": 87200,
        "overdue_count": 14,
        "suppliers_count": 12,
        "total_amount": 184150,
        "total_invoices": 29
    }
}

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

Consulter la vue 360° d'un fournisseur par code

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