Fonctionnalités
prix
documentation

Documentation API

Documentation API – Supplier Invoice Payment

Supplier Invoice Payment Endpoint

Gérez les paiements/règlements fournisseurs à travers différents systèmes ERP avec une API REST unifiée.
Lisez et créez les paiements pour Acomba, Sage 50, Avantage et autres systèmes ERP. Un règlement peut concerner une ou plusieurs factures fournisseurs et utiliser différents modes de paiement (chèque, dépôt direct, etc.).

GET/Entity/SupplierInvoicePayment
POST/Entity/SupplierInvoicePayment

Aperçu

L’entité SupplierInvoicePayment (APPayment) représente un règlement fournisseur dans votre système ERP.
Un règlement est une transaction de paiement qui peut être appliquée à une ou plusieurs factures fournisseurs,
et utilise différents modes de paiement (chèque, dépôt direct, réception de caisse, etc.).

L’API utilise des endpoints REST standards :

  • GET /Entity/SupplierInvoicePayment – Récupérer une liste de paiements fournisseurs
  • GET /Entity/SupplierInvoicePayment/{id} – Récupérer un paiement spécifique
  • POST /Entity/SupplierInvoicePayment – Créer un nouveau paiement fournisseur (Acomba et Sage 50)

Matrice de Support

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

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

GET SupplierInvoicePayment

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

GET/Entity/SupplierInvoicePayment

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

Filtres supportés par ERP

Champ Acomba Sage 50 Avantage
Fournisseur_No ✓ ✓ ✗
DatePaiement ✓ ✓ ✓
ReferencePaiement ✗ ✓ ✗
Facture_No ✗ ✓ ✗
Get SupplierInvoicePayment
GET /Entity/SupplierInvoicePayment
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

Response (200 OK)
[
    {
                        "NumeroPaiement": "0001",
                        "NoUniqueSystemeSource": "45678",
                        "DatePaiement": "2024-11-06T00:00:00",
                        "Fournisseur_No": "000000001",
                        "Fournisseur_NoUniqueSystemeSource": "123",
                        "TotalPaiement": 1.00,
                        "TotalEscompte": 0.00,
                        "TypePaiement": "Check",
                        "NoCompteGLBanque": "10000",
                        "BankInfo_InstitutionNumber": "001",
                        "BankInfo_BranchNumber": "12345",
                        "BankInfo_AccountNumber": "1234567",
                        "ListePaiement": [
            {
                        "ModePaiement": 1,
                        "dbl_MontantPaiement": 1.00,
                        "date_DatePaiement": "2024-11-06T00:00:00"
            }
        ],
                        "Liste_PaiementFacture": [
            {
                        "Facture_No": "Test 01",
                        "Facture_NoUniqueSystemeSource": "789",
                        "dbl_MontantTotalFacture": 1.00,
                        "dbl_MontantDuPaiement": 1.00,
                        "dbl_MontantEscompte": 0.00,
                        "DateFacture": "2024-10-15T00:00:00",
                        "ClientFournisseur_No": "000000001",
                        "TypeTransaction": "Invoice"
            }
        ]
    }
]

POST SupplierInvoicePayment (Création)

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

POST/Entity/SupplierInvoicePayment
💡 Disponibilité

La création de paiements fournisseurs est supportée pour Acomba et Sage 50. Cette fonctionnalité n’est pas disponible pour Avantage, QuickBooks Online, Servex et Servicentre.

Champs requis par ERP

Champ Type Acomba Sage 50 Description
Fournisseur_No string ✓ Required ✓ Required Numéro du fournisseur (Acomba) / Nom du fournisseur (Sage 50)
DatePaiement datetime Optionnel ✓ Required Date du paiement (défaut: aujourd’hui pour Acomba)
TotalPaiement decimal ✓ Required ✓ Required Montant total du paiement (doit correspondre à la somme des lignes)
TotalEscompte decimal ✓ Required Optionnel Montant total des escomptes
TypePaiement string ✓ Required Optionnel Type de paiement (voir modes ci-dessous)
NoCompteGLBanque string ✓ Required ✓ Required Numéro du compte GL de banque
NumeroPaiement string ✓ Conditionnel Auto-généré Numéro du chèque (requis pour Check/DirectDeposit dans Acomba)
DescriptionPaiement string Optionnel Optionnel Description/Commentaire du paiement
Liste_PaiementFacture List<InvoicePayment> ✓ Required ✓ Required Liste des factures à payer (minimum 1)

Modes de paiement Acomba (TypePaiement)

Valeur Description
Check Paiement par chèque (NumeroPaiement requis)
DirectDeposit Dépôt direct (NumeroPaiement requis)
CashReceipt Réception de caisse
PaymentOnHold Paiement en attente
DirectDepositOnHold Dépôt direct en attente
Créer un paiement fournisseur (Acomba)
POST /Entity/SupplierInvoicePayment
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

{
    "NumeroPaiement": "0001",
    // Obligatoire si TypePaiement est Check ou DirectDeposit. Numéro de chèque ou dépôt direct
    "Fournisseur_No": "000000001",
    // Obligatoire
    "TypePaiement": "Check",
    // Obligatoire. Valeurs: Check, DirectDeposit, CashReceipt, PaymentOnHold, DirectDepositOnHold
    "DatePaiement": "2024-11-06",
    // Optionnel, si absent sera instancié à la date d'aujourd'hui
    "TotalPaiement": 1.00,
    // Obligatoire
    "TotalEscompte": 0,
    // Obligatoire
    "NoCompteGLBanque": "10000",
    // Obligatoire, numéro du compte GL associé au compte de banque fournisseur
    "Liste_PaiementFacture": [
    // Obligatoire, doit contenir au minimum un paiement de facture
        {
            "Facture_No": "Test 01",
            // Obligatoire, numéro de la facture à payer
            "dbl_MontantDuPaiement": 1.00,
            // Obligatoire
            "dbl_MontantEscompte": 0.00
            // Obligatoire
        }
    ]
}

Créer un paiement fournisseur (Sage 50)
POST /Entity/SupplierInvoicePayment
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json

{
    "NoCompteGLBanque": "10600",
    // Obligatoire - Numéro du compte GL de banque que le paiement va retirer la somme
    "Fournisseur_No": "Abercrombie Hardware Inc.",
    // Obligatoire - Nom du fournisseur associé à ce paiement
    "DatePaiement": "2025-07-01",
    // Obligatoire
    "TotalPaiement": 1,
    // Doit correspondre à la somme des paiements des lignes de détails
    "DescriptionPaiement": "Test OERP",
    // Optionnel - Description/Commentaire du paiement
    "Liste_PaiementFacture": [
    // Liste des factures à payer, doit contenir au moins une facture
        {
            "Facture_No": "1134",
            // Numéro de facture à payer du fournisseur
            "dbl_MontantDuPaiement": 1
            // Montant partiel ou total à payer sur la facture
        }
    ]
}

Response (201 Created)
{
    "NumeroPaiement": "0001",
    "NoUniqueSystemeSource": "67890",
    "DatePaiement": "2024-11-06T00:00:00",
    "Fournisseur_No": "000000001",
    "Fournisseur_NoUniqueSystemeSource": "123",
    "TotalPaiement": 1.00,
    "TotalEscompte": 0.00,
    "TypePaiement": "Check",
    "NoCompteGLBanque": "10000",
    "Liste_PaiementFacture": [
        {
            "NoUniqueSystemeSource": "111",
            "PaiementEntete_NoUniqueSystemeSource": "67890",
            "Facture_No": "Test 01",
            "Facture_NoUniqueSystemeSource": "789",
            "dbl_MontantDuPaiement": 1.00,
            "dbl_MontantEscompte": 0.00,
            "ClientFournisseur_NoUniqueSystemeSource": "123"
        }
    ]
}

Modèle de Données Complet

En-tête de Paiement Fournisseur (APPayment)

Champ Type Description
NumeroPaiement string Numéro du paiement (chèque, dépôt direct, etc.)
NoUniqueSystemeSource string Identifiant unique interne du système ERP
Fournisseur_No string Numéro du fournisseur payé
Fournisseur_NoUniqueSystemeSource string ID unique système du fournisseur
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
DescriptionPaiement string Description/note du paiement
TypePaiement string Type/mode du paiement (Check, CashReceipt, etc.)
NoCompteGLBanque string Numéro du compte GL de banque
BankInfo_InstitutionNumber string Numéro d’institution bancaire
BankInfo_BranchNumber string Numéro de succursale bancaire
BankInfo_AccountNumber string Numéro de compte bancaire
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
dbl_MontantPaiement decimal Montant payé avec ce mode
date_DatePaiement datetime? Date de ce paiement spécifique
dbl_MontantPaiement_PerteArrondissement decimal Perte d’arrondissement
dbl_Montant_RetraitInteract decimal Montant du retrait Interac
dbl_Montant_ChangeRemit decimal Monnaie remise

Lien Facture-Paiement (InvoicePayment)

Champ Type Description
NoUniqueSystemeSource string ID unique du lien paiement-facture
PaiementEntete_NoUniqueSystemeSource string Lien vers le règlement parent (APPayment)
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 (Invoice, Credit, 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 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