Documentation API – Customer Invoice Payment

Customer Invoice Payment Endpoint

Gérez les paiements/règlements clients à travers différents systèmes ERP avec une API REST unifiée.
Lisez et créez les paiements pour Acomba, QuickBooks Online, Avantage et autres systèmes ERP. Un règlement peut concerner une ou plusieurs factures et utiliser un ou plusieurs modes de paiement.

GET/Entity/CustomerInvoicePayment

POST/Entity/CustomerInvoicePayment

Aperçu

L’entité CustomerInvoicePayment (ARPayment) représente un règlement client dans votre système ERP.
Un règlement est une transaction de paiement qui peut être appliquée à une ou plusieurs factures clients,
et peut combiner différents modes de paiement (comptant, carte de crédit, chèque, etc.).

L’API utilise des endpoints REST standards :

GET /Entity/CustomerInvoicePayment – Récupérer une liste de paiements
GET /Entity/CustomerInvoicePayment/{id} – Récupérer un paiement spécifique
POST /Entity/CustomerInvoicePayment – Créer un nouveau paiement client (Acomba seulement)

Matrice de Support

Opérations supportées pour l’entité CustomerInvoicePayment par système ERP :

Système ERP	GET	POST	PUT
Acomba	✓ Oui	✓ Oui	✗ Non
QuickBooks Online	✓ Oui	✗ Non	✗ Non
Avantage	✓ Oui	✗ Non	✗ Non
Sage 50	✗ Non	✗ Non	✗ Non
Servex	✗ Non	✗ Non	✗ Non
Servicentre	✗ Non	✗ Non	✗ Non

GET CustomerInvoicePayment

Récupère une liste de paiements clients avec support de filtrage, pagination et sélection de champs.

GET/Entity/CustomerInvoicePayment

Paramètres de requêtes

Paramètre	Type	Requis	Description
$filter	string	Optionnel	Expression de filtrage de style OData (ex: DatePaiement ge ‘2024-01-01’)
$select	string	Optionnel	Champs à retourner (séparés par des virgules)
$expand	string	Optionnel	Permet d’inclure les détails (ex: $expand=ListePaiement,Liste_PaiementFacture)
$orderby	string	Optionnel	Tri des résultats (ASC ou DESC)
$top	integer	Optionnel	Nombre maximum de résultats
$skip	integer	Optionnel	Nombre de résultats à ignorer

💡 Note importante

Pour plus de détails sur la composition des requêtes, consultez : Composer une requête à l’API d’ERP Connector

Get CustomerInvoicePayment

GET /Entity/CustomerInvoicePayment
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

Response (200 OK)

[
    {
                        "NumeroPaiement": "PAY-2024-001",
                        "NoUniqueSystemeSource": "GUID-12345",
                        "DatePaiement": "2024-01-15T10:30:00",
                        "Client_No": "C001",
                        "TotalPaiement": 1250.00,
                        "TotalEscompte": 25.00,
                        "ReferencePaiement": "CHQ-123456",
                        "TypePaiement": "Chèques",
                        "ListePaiement": [
            {
                        "ModePaiement": 4,
                        "dbl_MontantPaiement": 1250.00,
                        "date_DatePaiement": "2024-01-15T10:30:00"
            }
        ],
                        "Liste_PaiementFacture": [
            {
                        "Facture_No": "F-2024-001",
                        "dbl_MontantTotalFacture": 1456.75,
                        "dbl_MontantDuPaiement": 1225.00,
                        "dbl_MontantEscompte": 25.00,
                        "DateFacture": "2024-01-05T00:00:00"
            }
        ]
    },
    {
                        "NumeroPaiement": "PAY-2024-002",
                        "NoUniqueSystemeSource": "GUID-67890",
                        "DatePaiement": "2024-01-16T14:15:00",
                        "Client_No": "C002",
                        "TotalPaiement": 3500.00,
                        "TotalEscompte": 0.00,
                        "ReferencePaiement": "Paiement mixte",
                        "TypePaiement": "Multiple",
                        "ListePaiement": [
            {
                        "ModePaiement": 1,
                        "dbl_MontantPaiement": 1500.00,
                        "date_DatePaiement": "2024-01-16T14:15:00"
            },
            {
                        "ModePaiement": 5,
                        "dbl_MontantPaiement": 2000.00,
                        "date_DatePaiement": "2024-01-16T14:15:00"
            }
        ],
                        "Liste_PaiementFacture": [
            {
                        "Facture_No": "F-2024-010",
                        "dbl_MontantTotalFacture": 2000.00,
                        "dbl_MontantDuPaiement": 2000.00,
                        "dbl_MontantEscompte": 0.00
            },
            {
                        "Facture_No": "F-2024-011",
                        "dbl_MontantTotalFacture": 1800.00,
                        "dbl_MontantDuPaiement": 1500.00,
                        "dbl_MontantEscompte": 0.00
            }
        ]
    }
]

POST CustomerInvoicePayment (Création)

Crée un nouveau paiement client dans le système ERP. Permet d’enregistrer un règlement appliqué à une ou plusieurs factures avec un ou plusieurs modes de paiement.

POST/Entity/CustomerInvoicePayment

💡 Disponibilité

La création de paiements clients est actuellement supportée pour Acomba uniquement. Cette fonctionnalité n’est pas disponible pour QuickBooks Online et Avantage.

Champs requis par ERP

Champ	Type	Acomba	Description
Client_No	string	✓ Required	Numéro du client qui effectue le paiement
DatePaiement	datetime	✓ Required	Date du paiement
TotalPaiement	decimal	✓ Required	Montant total du paiement
ListePaiement	List<Paiement>	✓ Required	Liste des modes de paiement utilisés
Liste_PaiementFacture	List<InvoicePayment>	✓ Required	Liste des factures à payer avec montants

Créer un paiement client

POST /Entity/CustomerInvoicePayment
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

{
    "ReferencePaiement": "Test",
    // Champ optionnel
    "Client_No": "1",
    // Numéro du client Acomba
    "DatePaiement": "2025-11-18",
    // Date du paiement
    "DateNotification": "2025-01-01",
    // Champ optionnel
    "ListePaiement": [
        {
            "ModePaiement": "Comptant",
            // [Comptant, Chèques, PaiementDirect, Autre_01, Autre_02, Autre_03, Autre_04, Autre_05, Autre_06]
            // Dans Acomba un seul est supporté à la fois
            "dbl_MontantPaiement": 6.00,
            "date_DatePaiement": "2025-11-18"
        }
    ],
    "Liste_PaiementFacture": [
        {
            "Facture_No": "22197",
            // Numéro de la facture à payer
            "dbl_MontantDuPaiement": 1.00,
            // Montant paiement
            "dbl_MontantEscompte": 0.00
            // Montant d'escompte à appliquer
        },
        {
            "Facture_No": "22198",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22199",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22200",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22201",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22202",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        }
    ]
}

Response (201 Created)

{
    "NumeroPaiement": "PAY-2025-001",
    "NoUniqueSystemeSource": "GUID-NEW-12345",
    "DatePaiement": "2025-11-18T00:00:00",
    "DateNotification": "2025-01-01T00:00:00",
    "Client_No": "1",
    "TotalPaiement": 6.00,
    "TotalEscompte": 0.00,
    "ReferencePaiement": "Test",
    "TypePaiement": "Comptant",
    "ListePaiement": [
        {
            "ModePaiement": "Comptant",
            "dbl_MontantPaiement": 6.00,
            "date_DatePaiement": "2025-11-18T00:00:00"
        }
    ],
    "Liste_PaiementFacture": [
        {
            "Facture_No": "22197",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22197",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22198",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22198",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22199",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22199",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22200",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22200",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22201",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22201",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        },
        {
            "Facture_No": "22202",
            "Facture_NoUniqueSystemeSource": "INV-GUID-22202",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00
        }
    ]
}

Modèle de Données Complet

En-tête de Paiement (ARPayment)

Champ	Type	Description
NumeroPaiement	string	Numéro du paiement (chèque, transaction, etc.)
NoUniqueSystemeSource	string	Identifiant unique interne du système ERP
Client_No	string	Numéro du client qui effectue le paiement
Client_NoUniqueSystemeSource	string	ID unique système du client
DatePaiement	datetime?	Date du paiement
DateNotification	datetime?	Date de notification du paiement
TotalPaiement	decimal	Montant total du paiement
TotalEscompte	decimal	Total des escomptes/rabais accordés
ReferencePaiement	string	Référence externe du paiement
DescriptionPaiementPaiement	string	Description/note du paiement
TypePaiement	string	Type/catégorie du paiement
Recevable	int	Indicateur de compte recevable
Date_FicheDerniereModification	datetime?	Date de dernière modification
ListePaiement	List<Paiement>	Liste des modes de paiement utilisés
Liste_PaiementFacture	List<InvoicePayment>	Liste des factures payées avec montants

Mode de Paiement (Paiement)

Champ	Type	Description
ModePaiement	enum	Code du mode de paiement (0-999)
dbl_MontantPaiement	decimal	Montant payé avec ce mode
date_DatePaiement	datetime?	Date de ce paiement spécifique
dbl_MontantPaiement_PerteArrondissement	decimal	Perte d’arrondissement (pour comptant)
dbl_Montant_RetraitInteract	decimal	Montant du retrait Interac
dbl_Montant_ChangeRemit	decimal	Monnaie remise au client
str_NoUniqueSystemeSource_CommandePourDepot	string	ID de la commande pour dépôt (si applicable)

Lien Facture-Paiement (InvoicePayment)

Champ	Type	Description
NoUniqueSystemeSource	string	ID unique du lien paiement-facture
PaiementEntete_NoUniqueSystemeSource	string	Lien vers le règlement parent (ARPayment)
Facture_No	string	Numéro de la facture payée
Facture_NoUniqueSystemeSource	string	ID unique système de la facture
TypeTransaction	string	Type de transaction (Facture, Crédit, etc.)
dbl_MontantTotalFacture	decimal	Montant total original de la facture
dbl_MontantDuPaiement	decimal	Montant du paiement appliqué à cette facture
dbl_MontantEscompte	decimal	Montant de l’escompte accordé
ClientFournisseur_No	string	Numéro du client/fournisseur
ClientFournisseurSoldTo_No	string	Numéro du payeur (si différent)
DateFacture	datetime	Date de la facture
Date_FicheDerniereModification	datetime?	Date de dernière modification du lien