Documentation API – Supplier Order Receipt

Supplier Order Receipt API

Gérez les réceptions de commandes fournisseurs à travers différents systèmes ERP avec une API REST unifiée.
Enregistrez la réception de marchandises liées à vos commandes d’achat et mettez à jour automatiquement les quantités reçues.

POST/Entity/SupplierOrderReceipt

Aperçu

L’entité SupplierOrderReceipt représente une réception de commande fournisseur (achat) dans votre système ERP.
Cette API permet d’enregistrer la réception de marchandises liées à une commande d’achat existante,
mettant à jour les quantités reçues et le statut de livraison.

L’API utilise des endpoints REST standards avec les méthodes HTTP appropriées :

POST /Entity/SupplierOrderReceipt – Enregistrer une nouvelle réception de commande fournisseur

💡 Note importante

La réception de commande fournisseur est liée à une commande d’achat existante. Vous devez fournir le numéro de la commande fournisseur de référence ainsi que les détails des lignes reçues (numéro de ligne, produit, quantité reçue).

Matrice de Support

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

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

POST SupplierOrderReceipt (Création)

Enregistre une nouvelle réception de commande fournisseur dans le système ERP. La réception doit être liée à une commande d’achat existante et inclure au moins une ligne de détail.

POST/Entity/SupplierOrderReceipt

Champs de l’en-tête de réception (SupplierOrderReceiptHeader)

Champ	Type	Requis	Description
SupplierOrderNumberReference	string	✓ Required	Numéro de la commande fournisseur (achat) associée à cette réception
ReceiptDate	datetime	✓ Required	Date de la réception de la commande
ReceiptLines	array	✓ Required	Liste des lignes de réception
Id	string	Optional	Clé unique de l’entête de réception
IssueDate	datetime	Optional	Date de création du document de réception
Note	string	Optional	Note ou commentaire associé à la réception
Description	string	Optional	Description de la réception
SupplierNumberReference	string	Optional	Numéro du fournisseur associé
ShippingReference	string	Optional	Référence de l’expédition associée
IsComplete	bool	Optional	Indique si la réception est complète

Structure d’une ligne de réception (SupplierOrderReceiptLine)

Champ	Type	Requis	Description
LineNumber	int	✓ Required	Numéro de la ligne de la commande d’achat à recevoir
ProductNumber	string	✓ Required	Numéro du produit (doit correspondre à la ligne originale)
QuantityReceived	decimal	✓ Required	Quantité reçue du produit
Id	string	Optional	Clé unique de la ligne de réception
ProductCondition	string	Optional	Condition du produit reçu (Neuf, Endommagé, etc.)
Note	string	Optional	Note sur la ligne de réception
Description	string	Optional	Description de la ligne
QuantityToReceive	decimal	Optional	Quantité restante à recevoir
QuantityOrdered	decimal	Optional	Quantité originale commandée
QuantityBackordered	decimal	Optional	Quantité en rupture de stock
QuantityInvoiced	decimal	Optional	Quantité facturée
QuantityReturned	decimal	Optional	Quantité retournée

Créer une réception d’achat (Acomba)

POST /Entity/SupplierOrderReceipt
Host: https://v4.api.onlineerp.solution.quebec/api
Content-Type: application/json
If-None-Match: *

{
    "ReceiptDate": "2025-06-11", // La date de la réception
    "SupplierOrderNumberReference": "2424", // Numéro de l'Achat en référence
    "SupplierNumberReference": "000000001", // Numéro de fournisseur

    // Array des LIGNES à recevoir
    "ReceiptLines": [
        {   // La version ici est ultra simple : NoProduit et Qté. La description et toute autre info sera ramassé dans Acomba.
            "QuantityReceived": 1, // Quantité à Recevoir
            "ProductNumber": "22", // Numéro du produit à recevoir
            "LineNumber": 1 // Numéro de ligne
        },
        {
            "QuantityReceived": 1,
            "ProductNumber": "852-GRO-00805",
            "LineNumber": 2
        },
        {
            "QuantityReceived": 1,
            "ProductNumber": "ADA-DB25M-DB25F-5",
            "LineNumber": 10 // Il n'y a pas d'obligation d'avoir toutes les lignes de l'achat original
        },
        {
            "QuantityReceived": 1,
            "ProductNumber": "ADA-DB9FDB25M-29",
            "LineNumber": 11
        }
    ]
}

Response (201 Created)

{
  "OrigRemoteTaskID": 129015,
  "ResultType": "Success",
  "ErrorType": "None",
  "ResultMessage": "OK - Réception de l'achat : 2424 effectué avec succès.",
  "ResultPayload": [
    {
      "ErpInternalId": null,
      "BusinessKey": "SupplierOrder 2424 - Line 1",
      "ErrorMessage": null,
      "Success": true
    },
    {
      "ErpInternalId": null,
      "BusinessKey": "SupplierOrder 2424 - Line 2",
      "ErrorMessage": null,
      "Success": true
    },
    {
      "ErpInternalId": null,
      "BusinessKey": "SupplierOrder 2424 - Line 10",
      "ErrorMessage": null,
      "Success": true
    },
    {
      "ErpInternalId": null,
      "BusinessKey": "SupplierOrder 2424 - Line 11",
      "ErrorMessage": null,
      "Success": true
    }
  ],
  "IsTaskCompleted": true,
  "NbEntitiesImpacted": 4
}

⚠️ Important – Validations

Le système effectue plusieurs validations avant d’enregistrer la réception :

La commande fournisseur référencée doit exister dans le système ERP
Chaque ligne de réception doit avoir un numéro de ligne (LineNumber) correspondant à une ligne existante de la commande
Le numéro de produit (ProductNumber) doit correspondre exactement au produit de la ligne originale
La quantité reçue (QuantityReceived) doit être supérieure à 0

Modèle de Données Complet

En-tête de Réception (SupplierOrderReceiptHeader)

Champ	Type	Description
Id	string	Clé unique de l’entête de réception de commande fournisseur
ErpInternalId	string	Clé unique du système comptable (ERP)
IssueDate	datetime	Date de création du document de réception
ReceiptDate	datetime	Date de la réception de la commande fournisseur
Note	string	Note ou commentaire associé à la réception
Description	string	Description de la réception
SupplierOrderNumberReference	string	Numéro de la commande fournisseur associée à cette réception
SupplierNumberReference	string	Numéro du fournisseur associé à cette réception
ShippingReference	string	Référence de l’expédition associée à cette réception
IsComplete	bool	Indique si la réception est complète
ReceiptLines	IEnumerable<SupplierOrderReceiptLine>	Liste des lignes de réception associées

Lignes de Réception (SupplierOrderReceiptLine)

Champ	Type	Description
Id	string	Clé unique de la ligne de réception
ErpInternalId	string	Clé unique du système comptable (ERP)
LineNumber	int	Numéro de ligne de la réception (correspond à la ligne de l’achat original)
ProductNumber	string	Numéro du produit ou service associé à cette ligne
ProductCondition	string	Description de la condition du produit (Neuf, Endommagé, etc.)
Note	string	Note sur la ligne de réception
Description	string	Description de la ligne
QuantityReceived	decimal	Quantité reçue du produit
QuantityToReceive	decimal	Quantité restante à recevoir
QuantityOrdered	decimal	Quantité commandée du produit
QuantityBackordered	decimal	Quantité en rupture de stock
QuantityInvoiced	decimal	Quantité facturée du produit
QuantityReturned	decimal	Quantité retournée du produit