Pleaxy

Émettez des bons de commande, validez et payez les factures, et configurez votre espace de travail.

Référence de l’API

Profils d’organisation

Le profil d’entreprise et les coordonnées de facturation de votre société.

En savoir plus sur cette ressource

Le profil d’entreprise d’une organisation acheteuse ou fournisseuse : coordonnées de facturation et contact principal.

Endpoints

Obtenir le profil d’organisation

Renvoie le profil de votre entreprise.

GET/v1/workspaces/{regionId}/profile

Retour

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

Plus de détails

Renvoie le profil d’organisation de l’appelant pour cet espace de travail (acheteur ou fournisseur, selon le rôle de l’appelant).

Champs de la réponse

  • billingAddressstring

    L’adresse de facturation sur une ligne, dérivée de billingAddressParts. Sur un profil enregistré avant que les adresses aient des champs séparés, le texte tel qu’il a été saisi, et billingAddressParts est absent.

  • billingAddressPartsobject

    L’adresse de facturation en champs séparés (voir UpdateOrgProfile).

  • billingAddressNeedsReviewboolean

    true lorsqu’une ancienne adresse sur une ligne n’a pas pu être découpée en champs de manière fiable et qu’un administrateur doit la vérifier. Effacé par l’enregistrement de l’adresse.

  • billingAddressLegacyTextstring

    L’adresse sur une ligne telle qu’elle était avant son découpage en champs, conservée inchangée.

  • listedInDirectoryboolean

    Profils fournisseur uniquement : le fournisseur a choisi d’être trouvé par les acheteurs qui font une recherche sur Pleaxy (voir UpdateOrgProfile). Absent signifie non référencé.

  • directoryIdstring

    Profils fournisseur uniquement : l’id opaque par lequel les acheteurs invitent un fournisseur référencé, défini la première fois qu’il est référencé et conservé s’il est désactivé puis réactivé. Les acheteurs ne voient jamais votre e-mail de contact via l’annuaire.

Erreurs

  • 404 Not Found - Aucun profil d’organisation n’existe encore pour cet espace de travail et ce rôle.
  • 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}/profile
Requête
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/profile" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Réponse · 200 OK
{
   "id": "string",
   "role": "buyer" | "supplier",
   "regionId": "string",
   "regionName": "string",
   "companyName": "string",
   "billingEmail": "string",
   "billingAddress": "string",
   "billingAddressParts": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
   },
   "billingAddressNeedsReview": boolean,
   "billingAddressLegacyText": "string",
   "taxId": "string",
   "currency": "string",
   "countries": [ "string" ],
   "timeZone": "string",
   "primaryContactName": "string",
   "primaryContactEmail": "string",
   "listedInDirectory": boolean,
   "directoryId": "string",
   "createdAt": "string"
}

Mettre à jour le profil d’organisation

Met à jour le profil de votre entreprise.

PATCH/v1/workspaces/{regionId}/profile

Corps

  • regionNamestring

    Le nom d’affichage de la région, jusqu’à 40 caractères.

  • currencystring

    Code ISO 4217, insensible à la casse (stocké en majuscules). La devise d’un espace de travail acheteur ne peut plus changer dès qu’il contient un bon de commande (hors brouillons) ou une facture.

  • companyNamestring

    Raison sociale ou nom d’affichage de l’entreprise.

  • billingEmailstring

    Adresse e-mail à laquelle sont envoyés les factures et reçus.

  • billingAddressPartsobject | null

    L’adresse de facturation en champs séparés : line1 (obligatoire, jusqu’à 200 caractères), line2, city, region (État, province ou comté), postalCode et country (obligatoire, ISO 3166-1 alpha-2). Les autres champs obligatoires dépendent du pays : city partout sauf dans les cités-États comme SG et HK ; region aux US, CA, MX, BR et AU ; postalCode dans la majeure partie de l’Europe et aux US, CA, MX, BR, AU, IN et JP, et facultatif ailleurs, y compris dans la majeure partie de l’Amérique latine. billingAddress en est dérivé. Enregistrer une adresse, quelle qu’elle soit, efface billingAddressNeedsReview. null efface l’adresse.

  • billingAddressstring

    L’adresse de facturation sous forme d’une ligne de texte, jusqu’à 500 caractères. Ignorée lorsque billingAddressParts est envoyé ; sinon, elle remplace l’adresse et ses champs séparés.

  • taxIdstring

    Numéro d’identification fiscale, jusqu’à 64 caractères. Imprimé avec l’adresse de facturation sur les PDF de facture que Pleaxy crée pour les factures entre entreprises connectées.

  • primaryContactNamestring

    Nom du contact principal.

  • primaryContactEmailstring

    E-mail du contact principal.

  • countriesstring[]

    Remplace les pays de la région, sous forme de codes ISO 3166-1 alpha-2, uniques, jusqu’à 250. Ne modifie jamais la devise.

  • geographyPresetIdstring | null

    Consigne le préréglage (par exemple eu, uk, apac, global) dont provient la liste de pays ; null l’efface.

  • timeZonestring

    Fuseau horaire IANA, par exemple Europe/London. Définit le « aujourd’hui » de l’espace de travail pour les dates de paiement.

  • listedInDirectoryboolean

    Profils fournisseur uniquement (ignoré pour un acheteur) : true vous référence dans l’annuaire des fournisseurs que consulte tout acheteur sur Pleaxy lorsqu’il invite un fournisseur, par raison sociale et région uniquement, jamais par votre e-mail de contact. Un acheteur peut alors vous inviter sans connaître votre e-mail ; l’invitation est envoyée au contact de votre compte. false vous retire de l’annuaire.

Retour

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

Plus de détails

Met à jour un ou plusieurs champs du profil d’organisation de l’appelant.

Erreurs

  • 400 Bad Request - Un champ a échoué à la validation, par exemple regionName dépasse 40 caractères, currency n’est pas un code ISO 4217, ou il manque à billingAddressParts un élément exigé par son pays (comme region et postalCode pour une adresse aux États-Unis).
  • 409 Conflict - currency diffère de la devise enregistrée, et cet espace de travail acheteur contient déjà des bons de commande ou des factures. Rien n’est modifié. Pour acheter dans une autre devise, ajoutez une région.
  • 404 Not Found - Aucun profil d’organisation n’existe encore pour cet espace de travail et ce rôle.
  • 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.
PATCH /v1/workspaces/{regionId}/profile
Requête
curl -X PATCH "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/profile" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "regionName": "string",
   "currency": "string",
   "companyName": "string",
   "billingEmail": "string",
   "billingAddressParts": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
   },
   "taxId": "string",
   "primaryContactName": "string",
   "primaryContactEmail": "string",
   "countries": [ "string" ],
   "geographyPresetId": "string",
   "timeZone": "string",
   "listedInDirectory": boolean
}
Réponse · 200 OK
{
   "id": "string",
   "role": "buyer" | "supplier",
   "regionId": "string",
   "regionName": "string",
   "companyName": "string",
   "billingEmail": "string",
   "billingAddress": "string",
   "billingAddressParts": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
   },
   "billingAddressNeedsReview": boolean,
   "billingAddressLegacyText": "string",
   "taxId": "string",
   "currency": "string",
   "countries": [ "string" ],
   "timeZone": "string",
   "primaryContactName": "string",
   "primaryContactEmail": "string",
   "listedInDirectory": boolean,
   "directoryId": "string",
   "createdAt": "string"
}
Nous contacter