Lister les paiements appliqués à une facture fournisseur

GET

/api/suppliers/invoice-ap/by-id/{invoice_id}/payment-allocations

Retourne les paiements qui ont réglé une facture fournisseur, à partir de l'identifiant interne de la facture. Le chemin inverse, les factures réglées par un paiement, est /api/suppliers/payments-ap/by-id/{payment_id}/invoices-paid. Chaque allocation indique le montant appliqué, l'escompte obtenu, la date et le paiement d'origine, de la plus ancienne à la plus récente ; un crédit appliqué à la facture apparaît avec un montant négatif. Le sommaire calcule le montant restant à appliquer (remaining_to_allocate = montant facturé − total appliqué − total des escomptes) et is_fully_allocated vaut true quand ce montant est inférieur à 0,01 $. Par défaut, les paiements archivés sont exclus, si bien qu'une facture ancienne peut présenter une liste vide : ajoutez include_archived=true pour les inclure. Le cache dure 4 h, et 24 h lorsque la facture est payée en entier et archivée ; conventions communes (cache, 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

Paiements appliqués à la facture

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/suppliers/invoice-ap/by-id//payment-allocations?include_archived=&force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "invoice": {
        "id": 34269,
        "number": "20260301",
        "type": {
            "id": 2,
            "code": "invoice",
            "label": "Facture"
        },
        "supplier": {
            "id": 416,
            "code": "QUINFICT",
            "name": "Quincaillerie Fictive ltée"
        }
    },
    "invoice_date": "2026-02-02",
    "due_date": "2026-03-04",
    "amount_invoiced": 695.23,
    "filter": {
        "include_archived": false
    },
    "summary": {
        "allocations_count": 2,
        "total_allocated": 695.23,
        "total_discount": 0,
        "amount_invoiced": 695.23,
        "is_fully_allocated": true,
        "remaining_to_allocate": 0,
        "first_allocation_date": "2026-03-02",
        "last_allocation_date": "2026-06-01",
        "currency": "CAD"
    },
    "items": [
        {
            "allocation": {
                "line_id": 34748,
                "unique_code": "53382"
            },
            "allocation_date": "2026-03-02",
            "amount_applied": 463.51,
            "discount_applied": 0,
            "amount_total": 463.51,
            "payment": {
                "id": 6948,
                "number": "9005336",
                "payment_type": {
                    "id": 1,
                    "code": "check",
                    "label": "Chèque"
                },
                "payment_date": "2026-03-02",
                "is_archived": false
            },
            "is_current_day": false,
            "_links": {
                "payment_detail": "/api/suppliers/payments/by-id/6948",
                "payment_invoices_paid": "/api/suppliers/payments-ap/by-id/6948/invoices-paid"
            }
        },
        {
            "allocation": {
                "line_id": 35591,
                "unique_code": "54350"
            },
            "allocation_date": "2026-06-01",
            "amount_applied": 231.72,
            "discount_applied": 0,
            "amount_total": 231.72,
            "payment": {
                "id": 7151,
                "number": "9005374",
                "payment_type": {
                    "id": 1,
                    "code": "check",
                    "label": "Chèque"
                },
                "payment_date": "2026-06-01",
                "is_archived": false
            },
            "is_current_day": false,
            "_links": {
                "payment_detail": "/api/suppliers/payments/by-id/7151",
                "payment_invoices_paid": "/api/suppliers/payments-ap/by-id/7151/invoices-paid"
            }
        }
    ],
    "metadata": {
        "organisation_id": "construction_demo",
        "extracted_at": "2026-10-07T14:06:16-04:00",
        "sdk_indexes_used": {
            "payment_ap_line": 1,
            "payment_ap": "get_card",
            "invoice_ap": "get_card"
        },
        "scope": "non_archived_only"
    },
    "cache": {
        "status": "miss",
        "key_hash": "sha1:5d0c2a7e91f4b3c86a1e0d7f2b9c4e1a3f6d8b20",
        "cached_at": "2026-10-07T14:06:16-04:00",
        "expires_at": "2026-10-07T18:06:16-04:00",
        "age_seconds": 0,
        "ttl_remaining_seconds": 14400,
        "ttl_policy": "current_period_4h",
        "force_refreshed": false
    },
    "_links": {
        "self": "/api/suppliers/invoice-ap/by-id/34269/payment-allocations?include_archived=false",
        "invoice_detail": "/api/suppliers/invoices-ap/by-id/34269",
        "supplier_overview": "/api/suppliers/by-id/416/overview",
        "supplier_unpaid_invoices": "/api/suppliers/by-id/416/unpaid-invoices"
    }
}

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

Lister les factures réglées par un paiement fournisseur

Lister l'âge des comptes des fournisseurs