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

GET

/api/customers/payments/by-id/{payment_id}/invoices-paid

Retourne les factures réglées par un paiement client, à partir de l'identifiant interne du paiement. Le chemin inverse, les paiements appliqués à une facture, est /api/customers/invoice-ar/by-id/{invoice_id}/payment-allocations. Chaque ligne indique la facture réglée, le montant appliqué, l'escompte accordé et la date, de la plus ancienne à la plus récente ; un crédit appliqué apparaît avec un montant négatif. Les lignes qui ne règlent aucune facture (avance, excédent de paiement) sont retournées avec invoice=null et is_unallocated=true ; le sommaire sépare le total appliqué aux factures (total_applied), le total non alloué (total_unallocated) et les escomptes (total_discount). Le cache dure 4 h, et 24 h lorsque le paiement est archivé ; 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

Factures réglées par le paiement

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/customers/payments/by-id//invoices-paid?force_refresh=' \
--header 'x-api-key: <api-key>'

Response Example

{
    "payment": {
        "id": 4389,
        "number": "6312",
        "payment_type": {
            "id": 1,
            "code": "payment",
            "label": "Paiement"
        },
        "customer": {
            "id": 105,
            "code": "CONSTEX",
            "name": "Construction Exemple inc."
        },
        "payment_date": "2026-08-01",
        "reference": "Chèque 12345",
        "is_archived": false
    },
    "summary": {
        "lines_count": 3,
        "invoices_paid_count": 2,
        "unallocated_count": 1,
        "total_applied": 7790.94,
        "total_discount": 0,
        "total_unallocated": 500,
        "first_allocation_date": "2026-08-01",
        "last_allocation_date": "2026-08-01",
        "currency": "CAD"
    },
    "items": [
        {
            "line": {
                "line_id": 16850,
                "unique_code": "20871"
            },
            "invoice": {
                "id": 13117,
                "number": "18512",
                "type": {
                    "id": 3,
                    "code": "invoice",
                    "label": "Facture"
                },
                "invoice_date": "2026-07-15",
                "amount_invoiced": 4026.01
            },
            "allocation_date": "2026-08-01",
            "amount_applied": 4026.01,
            "discount_applied": 0,
            "amount_total": 4026.01,
            "transaction_type": {
                "id": 3,
                "code": "invoice",
                "label": "Facture"
            },
            "is_current_day": false,
            "is_unallocated": false,
            "_links": {
                "invoice_detail": "/api/customers/invoice-ar/by-id/13117",
                "invoice_payment_allocations": "/api/customers/invoice-ar/by-id/13117/payment-allocations"
            }
        },
        {
            "line": {
                "line_id": 16851,
                "unique_code": "20872"
            },
            "invoice": {
                "id": 13125,
                "number": "18520",
                "type": {
                    "id": 3,
                    "code": "invoice",
                    "label": "Facture"
                },
                "invoice_date": "2026-07-22",
                "amount_invoiced": 3764.93
            },
            "allocation_date": "2026-08-01",
            "amount_applied": 3764.93,
            "discount_applied": 0,
            "amount_total": 3764.93,
            "transaction_type": {
                "id": 3,
                "code": "invoice",
                "label": "Facture"
            },
            "is_current_day": false,
            "is_unallocated": false,
            "_links": {
                "invoice_detail": "/api/customers/invoice-ar/by-id/13125",
                "invoice_payment_allocations": "/api/customers/invoice-ar/by-id/13125/payment-allocations"
            }
        },
        {
            "line": {
                "line_id": 16852,
                "unique_code": "20873"
            },
            "allocation_date": "2026-08-01",
            "amount_applied": 500,
            "discount_applied": 0,
            "amount_total": 500,
            "transaction_type": {
                "id": 1,
                "code": "overpayment",
                "label": "Excédent"
            },
            "is_current_day": false,
            "is_unallocated": true,
            "_links": {}
        }
    ],
    "metadata": {
        "organisation_id": "construction_demo",
        "extracted_at": "2026-10-07T14:05:10-04:00",
        "sdk_indexes_used": {
            "customer_payment_line": 2,
            "customer_payment": "get_card",
            "invoice_ar": "get_card"
        },
        "scope": "all_lines_including_unallocated"
    },
    "cache": {
        "status": "miss",
        "key_hash": "sha1:9b1f0e6c2d4a8e3f7c5b1a0d9e8f7a6b5c4d3e2f",
        "cached_at": "2026-10-07T14:05:10-04:00",
        "expires_at": "2026-10-07T18:05:10-04:00",
        "age_seconds": 0,
        "ttl_remaining_seconds": 14400,
        "ttl_policy": "current_period_4h",
        "force_refreshed": false
    },
    "_links": {
        "self": "/api/customers/payments/by-id/4389/invoices-paid",
        "payment_detail": "/api/customers/payments/by-id/4389",
        "customer_overview": "/api/customers/by-id/105/overview",
        "customer_unpaid_invoices": "/api/customers/by-id/105/unpaid-invoices"
    }
}

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

Lister les produits les plus vendus d'une période

Lister les paiements appliqués à une facture client