Référence de l’API

Risque fournisseur

Ce qui mérite un regard chez chaque fournisseur : coordonnées bancaires, filtrage des sanctions et documents manquants.

En savoir plus sur cette ressource

Pleaxy tient trois contrôles sur chaque fournisseur d’un acheteur et les résume en un niveau : ok, attention ou blocked. Coordonnées bancaires : le compte sur lequel chaque facture demande à être payée est conservé par canal de facturation, et une facture qui indique un compte nouveau ou différent attend l’approbation d’une personne avant de pouvoir être exportée pour paiement. Filtrage des sanctions : lorsqu’il est activé, les noms du fournisseur sont comparés aux listes de l’OFAC, de l’UE, du Royaume-Uni et de l’ONU, et les paiements attendent tant qu’une correspondance possible est examinée. Questionnaires : réponses signalées et documents manquants. Ces endpoints ne font que lire. L’approbation d’un compte bancaire et la décision sur une correspondance du filtrage sont faites par une personne connectée dans Pleaxy.

Lister le risque fournisseur

Liste le niveau de risque de chaque fournisseur et les contrôles sur lesquels il repose.

GET/v1/workspaces/{regionId}/supplier-risk

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie le niveau de chaque fournisseur avec ses lignes : bank, screening, flaggedAnswers et missingDocuments, chacune avec un état ok, attention, blocked ou none. Dans cette liste, un filtrage sans rien de signalé apparaît comme none ; lisez un fournisseur avec GetSupplierRisk pour son état bancaire et de filtrage complet.

Nécessite l’accès 'view' aux fournisseurs.

Champs de la réponse

  • level"ok" | "attention" | "blocked"

    L’état le plus grave parmi les lignes que l’espace de travail prend en compte pour le niveau. blocked signifie une correspondance de sanctions confirmée. C’est un niveau, jamais un score.

  • bankobject

    Les comptes bancaires enregistrés du fournisseur : waiting compte les comptes en attente d’approbation.

  • screeningobject

    Le filtrage des sanctions du fournisseur : son statut et la date de la dernière vérification. status vaut off tant que le filtrage n’est pas activé.

  • flaggedAnswersobject

    Combien de réponses du questionnaire du fournisseur sont signalées pour examen.

  • missingDocumentsobject

    Les libellés des documents obligatoires du questionnaire que le fournisseur n’a pas fournis.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/supplier-risk
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/supplier-risk" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
[
   {
      "connectionId": "string",
      "supplierName": "string",
      "level": "ok" | "attention" | "blocked",
      "bank": { "state": "ok" | "attention" | "blocked" | "none", "waiting": number, "status": "none" | "approved" | "waiting" | "changing" },
      "screening": { "state": "ok" | "attention" | "blocked" | "none", "status": "off" | "not_screened" | "clear" | "possible_match" | "confirmed_match", "checkedAt": "string" },
      "flaggedAnswers": { "state": "ok" | "attention" | "blocked" | "none", "count": number },
      "missingDocuments": { "state": "ok" | "attention" | "blocked" | "none", "fields": [ "string" ] }
   }
]

Obtenir le risque d’un fournisseur

Obtient le niveau de risque d’un fournisseur et les contrôles sur lesquels il repose.

GET/v1/workspaces/{regionId}/supplier-risk/{connectionId}

Paramètres

  • connectionIdstringObligatoire

    L’id de connexion du fournisseur dans cet espace de travail.

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie le risque d’un fournisseur comme le fait ListSupplierRisk, avec bank.status ainsi que le statut et checkedAt du filtrage renseignés.

Nécessite l’accès 'view' aux fournisseurs.

Champs de la réponse

  • level"ok" | "attention" | "blocked"

    L’état le plus grave parmi les lignes que l’espace de travail prend en compte pour le niveau. blocked signifie une correspondance de sanctions confirmée. C’est un niveau, jamais un score.

  • bankobject

    Les comptes bancaires enregistrés du fournisseur : waiting compte les comptes en attente d’approbation.

  • screeningobject

    Le filtrage des sanctions du fournisseur : son statut et la date de la dernière vérification. status vaut off tant que le filtrage n’est pas activé.

  • flaggedAnswersobject

    Combien de réponses du questionnaire du fournisseur sont signalées pour examen.

  • missingDocumentsobject

    Les libellés des documents obligatoires du questionnaire que le fournisseur n’a pas fournis.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/supplier-risk/{connectionId}
Requête
GET /v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.buyer/supplier-risk/SC-1A2B3C4D
Réponse · 200 OK
{
   "connectionId": "SC-1A2B3C4D",
   "supplierName": "Northwind Hosting",
   "level": "attention",
   "bank": { "state": "attention", "waiting": 1, "status": "changing" },
   "screening": { "state": "ok", "status": "clear", "checkedAt": "2026-11-10T06:00:00.000Z" },
   "flaggedAnswers": { "state": "ok", "count": 0 },
   "missingDocuments": { "state": "ok", "fields": [] }
}

Lister les comptes bancaires à approuver

Liste les comptes bancaires de fournisseurs qui attendent l’approbation d’une personne.

GET/v1/workspaces/{regionId}/bank-accounts/review

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie les comptes bancaires qui attendent une approbation : le premier compte d’un canal de facturation (statut unverified), ou un changement sur un compte déjà approuvé (statut changing, avec pendingChange). Les factures à payer sur ces comptes attendent qu’une personne les approuve.

Nécessite l’accès 'view' aux factures. Approuver un compte, refuser un changement et afficher les numéros complets sont faits par une personne connectée dans Pleaxy.

Champs de la réponse

  • laneKeystring

    Le canal de facturation auquel le compte appartient : un bénéficiaire et une devise de ce fournisseur.

  • detailsobject

    Les coordonnées de paiement enregistrées, avec les numéros de compte masqués sauf les quatre derniers caractères.

  • status"unverified" | "verified" | "changing"

    unverified : le premier compte du canal, en attente d’approbation. verified : approuvé. changing : une facture a indiqué d’autres coordonnées, conservées dans pendingChange jusqu’à ce qu’une personne les approuve ou les refuse.

  • approvalobject

    Comment le compte a été approuvé. verification vaut supplier_confirmed, buyer_approved ou paid_before, et check.method indique comment l’acheteur l’a vérifié.

  • historyArray<object>

    Les événements les plus récents du compte, avec le numéro de compte masqué.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/bank-accounts/review
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
[
   {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   }
]

Lister les comptes bancaires d’un fournisseur

Liste les comptes bancaires enregistrés d’un fournisseur, avec la façon dont chacun a été approuvé.

GET/v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}

Paramètres

  • connectionIdstringObligatoire

    L’id de connexion du fournisseur dans cet espace de travail.

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie les comptes bancaires enregistrés d’un fournisseur, un par canal de facturation (un bénéficiaire et une devise), avec le statut de chaque compte, la façon dont il a été approuvé et ses 10 derniers événements.

Nécessite l’accès 'view' aux factures. Approuver un compte, refuser un changement et afficher les numéros complets sont faits par une personne connectée dans Pleaxy.

Champs de la réponse

  • laneKeystring

    Le canal de facturation auquel le compte appartient : un bénéficiaire et une devise de ce fournisseur.

  • detailsobject

    Les coordonnées de paiement enregistrées, avec les numéros de compte masqués sauf les quatre derniers caractères.

  • status"unverified" | "verified" | "changing"

    unverified : le premier compte du canal, en attente d’approbation. verified : approuvé. changing : une facture a indiqué d’autres coordonnées, conservées dans pendingChange jusqu’à ce qu’une personne les approuve ou les refuse.

  • approvalobject

    Comment le compte a été approuvé. verification vaut supplier_confirmed, buyer_approved ou paid_before, et check.method indique comment l’acheteur l’a vérifié.

  • historyArray<object>

    Les événements les plus récents du compte, avec le numéro de compte masqué.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
[
   {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   }
]

Obtenir le compte bancaire d’une facture

Indique si le paiement d’une facture attend à cause du compte bancaire de son fournisseur.

GET/v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account

Paramètres

  • invoiceIdstringObligatoire

    L’id de la facture, p. ex. INV-7F3A9C21.

  • buyerstring

    Pour un appelant fournisseur, l’acheteur auquel la facture appartient, comme dans GetInvoice.

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Indique si cette facture attend à cause du compte bancaire de son fournisseur. hold vaut first_payment quand le compte du canal de facturation n’est pas encore approuvé, differs_from_file quand la facture indique d’autres coordonnées que le compte approuvé, et est absent quand la facture peut être payée. Tant qu’elle attend, la facture ne peut pas être exportée pour paiement ; l’enregistrement d’un paiement fait ailleurs et le paiement via Pleaxy ne sont pas retenus.

Nécessite l’accès 'view' aux factures. Un appelant fournisseur ne reçoit que hold.

Champs de la réponse

  • hold"first_payment" | "differs_from_file"

    Pourquoi le paiement attend. Absent quand il n’attend pas.

  • accountobject

    Le compte enregistré du canal de facturation, avec les numéros masqués sauf les quatre derniers caractères.

Erreurs

  • 404 Not Found - Aucune facture avec cet id que l’appelant puisse voir.
  • 409 Conflict - Appelants fournisseurs uniquement. Code INVOICE_ID_AMBIGUOUS : plusieurs de vos acheteurs détiennent une facture de votre part avec cet id (les id ne sont uniques qu’au sein d’un même acheteur), donc Pleaxy ne devine pas laquelle vous visez. Rien n’est lu ni modifié. Le champ buyers du corps liste l’ID de l’espace de travail et le nom de chaque acheteur : relancez l’appel avec ?buyer=<that Workspace ID>.
  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
{
   "hold": "first_payment" | "differs_from_file",
   "account": {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   },
   "supplierKey": "string"
}

Lister les correspondances du filtrage

Liste les fournisseurs dont le filtrage des sanctions a une correspondance à examiner ou une correspondance confirmée.

GET/v1/workspaces/{regionId}/screening/review

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie les fournisseurs dont le statut de filtrage est possible_match ou confirmed_match. Les paiements qui leur sont destinés attendent, et un fournisseur avec une correspondance confirmée ne reçoit ni nouvelles commandes ni factures saisies par l’acheteur. La liste est vide tant que le filtrage est désactivé. Une correspondance est une ressemblance entre des noms qu’une personne doit examiner, pas un constat que le fournisseur est sanctionné.

Nécessite l’accès 'view' aux fournisseurs. Écarter ou confirmer une correspondance est fait par une personne connectée dans Pleaxy.

Champs de la réponse

  • status"not_screened" | "clear" | "possible_match" | "confirmed_match"

    possible_match : au moins une correspondance attend l’examen d’une personne. confirmed_match : une personne a confirmé que le fournisseur est la partie inscrite sur la liste.

  • subjectsArray<object>

    Les noms qui ont été filtrés : le nom du fournisseur, un nom antérieur et les bénéficiaires de ses comptes bancaires.

  • listVersionsobject

    La version de chaque liste de sanctions par rapport à laquelle le fournisseur a été filtré en dernier.

  • matchesArray<object>

    Chaque entrée de liste à laquelle un nom filtré ressemble : la liste, les noms, pays et programmes de l’entrée, et le score. state vaut open jusqu’à ce qu’une personne l’écarte ou la confirme, avec qui a décidé et pourquoi. closed signifie que l’entrée a quitté la liste ou ne correspond plus.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/screening/review
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
[
   {
      "connectionId": "string",
      "supplierKey": "string",
      "supplierName": "string",
      "status": "not_screened" | "clear" | "possible_match" | "confirmed_match",
      "checkedAt": "string",
      "listVersions": { "ofac": "string", "eu": "string", "uk": "string", "un": "string" },
      "subjects": [ { "role": "name" | "former_name" | "payee", "name": "string" } ],
      "countries": [ "string" ],
      "matches": [
         {
            "id": "string",
            "entryId": "string",
            "list": "ofac" | "eu" | "uk" | "un" | "jurisdiction",
            "entryName": "string",
            "matchedName": "string",
            "subject": { "role": "name" | "former_name" | "payee", "name": "string" },
            "score": number,
            "countryMismatch": boolean,
            "entry": { "kind": "entity" | "individual" | "other", "names": [ "string" ], "countries": [ "string" ], "programmes": [ "string" ], "listedOn": "string" },
            "state": "open" | "dismissed" | "confirmed" | "closed",
            "foundAt": "string",
            "decidedAt": "string",
            "decidedBy": { "sub": "string", "name": "string" },
            "reason": "string",
            "closedReason": "entry_removed" | "no_longer_matches"
         }
      ],
      "history": [ { "at": "string", "event": "screened" | "dismissed" | "confirmed" | "reopened" | "closed", "matchId": "string", "by": "string" } ],
      "version": number
   }
]

Obtenir le filtrage d’un fournisseur

Obtient le filtrage des sanctions d’un fournisseur et ses correspondances.

GET/v1/workspaces/{regionId}/screening/suppliers/{connectionId}

Paramètres

  • connectionIdstringObligatoire

    L’id de connexion du fournisseur dans cet espace de travail.

Retour

200 OK avec l’objet présenté dans la réponse.

Plus de détails

Renvoie si le filtrage est activé et, quand le fournisseur a été filtré, son filtrage : les noms filtrés, les versions des listes et chaque correspondance avec son état.

Nécessite l’accès 'view' aux fournisseurs. Écarter ou confirmer une correspondance est fait par une personne connectée dans Pleaxy.

Champs de la réponse

  • enabledboolean

    Si le filtrage des sanctions est activé.

  • status"not_screened" | "clear" | "possible_match" | "confirmed_match"

    possible_match : au moins une correspondance attend l’examen d’une personne. confirmed_match : une personne a confirmé que le fournisseur est la partie inscrite sur la liste.

  • subjectsArray<object>

    Les noms qui ont été filtrés : le nom du fournisseur, un nom antérieur et les bénéficiaires de ses comptes bancaires.

  • listVersionsobject

    La version de chaque liste de sanctions par rapport à laquelle le fournisseur a été filtré en dernier.

  • matchesArray<object>

    Chaque entrée de liste à laquelle un nom filtré ressemble : la liste, les noms, pays et programmes de l’entrée, et le score. state vaut open jusqu’à ce qu’une personne l’écarte ou la confirme, avec qui a décidé et pourquoi. closed signifie que l’entrée a quitté la liste ou ne correspond plus.

Erreurs

  • 401 Unauthorized - Aucun identifiant n’a été fourni, ou la valeur du jeton Bearer / de X-Api-Key est manquante, invalide, expirée ou révoquée.
  • 403 Forbidden - Le jeton Bearer ou la clé API de l’appelant ne donne pas accès à cet espace de travail (regionId), ou n’a pas le rôle requis.
GET /v1/workspaces/{regionId}/screening/suppliers/{connectionId}
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
{
   "enabled": boolean,
   "screening": {
      "connectionId": "string",
      "supplierKey": "string",
      "supplierName": "string",
      "status": "not_screened" | "clear" | "possible_match" | "confirmed_match",
      "checkedAt": "string",
      "listVersions": { "ofac": "string", "eu": "string", "uk": "string", "un": "string" },
      "subjects": [ { "role": "name" | "former_name" | "payee", "name": "string" } ],
      "countries": [ "string" ],
      "matches": [
         {
            "id": "string",
            "entryId": "string",
            "list": "ofac" | "eu" | "uk" | "un" | "jurisdiction",
            "entryName": "string",
            "matchedName": "string",
            "subject": { "role": "name" | "former_name" | "payee", "name": "string" },
            "score": number,
            "countryMismatch": boolean,
            "entry": { "kind": "entity" | "individual" | "other", "names": [ "string" ], "countries": [ "string" ], "programmes": [ "string" ], "listedOn": "string" },
            "state": "open" | "dismissed" | "confirmed" | "closed",
            "foundAt": "string",
            "decidedAt": "string",
            "decidedBy": { "sub": "string", "name": "string" },
            "reason": "string",
            "closedReason": "entry_removed" | "no_longer_matches"
         }
      ],
      "history": [ { "at": "string", "event": "screened" | "dismissed" | "confirmed" | "reopened" | "closed", "matchId": "string", "by": "string" } ],
      "version": number
   }
}
Nous contacter