Bestellungen anlegen, Rechnungen freigeben und bezahlen und den Workspace einrichten.

API-Referenz

Organisationsprofile

Das Geschäftsprofil und die Rechnungsangaben Ihres Unternehmens.

Mehr zu dieser Ressource

Das Geschäftsprofil einer Käufer- oder Lieferantenorganisation - Rechnungsangaben und Hauptansprechpartner.

Endpunkte

GET…/profile
PATCH…/profile

Organisationsprofil abrufen

Gibt Ihr Unternehmensprofil zurück.

GET/v1/workspaces/{regionId}/profile

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt das Organisationsprofil des Aufrufers für diesen Workspace zurück (Käufer oder Lieferant, je nach Rolle des Aufrufers).

Antwortfelder

billingAddressstring
Die Rechnungsadresse in einer Zeile, abgeleitet aus billingAddressParts. Bei einem Profil, das gespeichert wurde, bevor Adressen einzelne Felder hatten, der Text wie eingegeben, und billingAddressParts fehlt.
billingAddressPartsobject
Die Rechnungsadresse als einzelne Felder (siehe UpdateOrgProfile).
billingAddressNeedsReviewboolean
true, wenn eine ältere einzeilige Adresse nicht zuverlässig in Felder aufgeteilt werden konnte und ein Administrator sie prüfen sollte. Wird durch Speichern der Adresse zurückgesetzt.
billingAddressLegacyTextstring
Die einzeilige Adresse in ihrer Form vor der Aufteilung in Felder, unverändert aufbewahrt.
listedInDirectoryboolean
Nur Lieferantenprofile: Der Lieferant hat sich dafür entschieden, von Käufern bei der Suche in Pleaxy gefunden zu werden (siehe UpdateOrgProfile). Fehlt das Feld, ist er nicht gelistet.
directoryIdstring
Nur Lieferantenprofile: die nicht sprechende ID, über die Käufer einen gelisteten Lieferanten einladen, gesetzt beim ersten Listing und beibehalten, wenn es aus- und wieder eingeschaltet wird. Käufer sehen Ihre Kontakt-E-Mail nie über das Verzeichnis.

Fehler

404 Not Found - Für diesen Workspace und diese Rolle gibt es noch kein Organisationsprofil.
401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.

GET /v1/workspaces/{regionId}/profile

Anfrage

curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/profile" \
  -H "X-Api-Key: $PLEAXY_API_KEY"

Antwort · 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"
}

Organisationsprofil aktualisieren

Aktualisiert Ihr Unternehmensprofil.

PATCH/v1/workspaces/{regionId}/profile

Body

regionNamestring
Der Anzeigename der Region, bis zu 40 Zeichen.
currencystring
ISO-4217-Code, ohne Beachtung der Groß-/Kleinschreibung (in Großbuchstaben gespeichert). Die Währung eines Käufer-Workspace kann nicht mehr geändert werden, sobald er eine Bestellung (Entwürfe ausgenommen) oder Rechnung hat.
companyNamestring
Rechtlicher Name oder Anzeigename des Unternehmens.
billingEmailstring
E-Mail-Adresse, an die Rechnungen/Belege gesendet werden.
billingAddressPartsobject | null
Die Rechnungsadresse als einzelne Felder: line1 (erforderlich, bis zu 200 Zeichen), line2, city, region (Bundesstaat, Provinz oder County), postalCode und country (erforderlich, ISO 3166-1 alpha-2). Welche weiteren Felder erforderlich sind, hängt vom Land ab: city überall außer in Stadtstaaten wie SG und HK; region in US, CA, MX, BR und AU; postalCode in den meisten Ländern Europas sowie in US, CA, MX, BR, AU, IN und JP, anderswo optional, auch in den meisten Ländern Lateinamerikas. billingAddress wird daraus abgeleitet. Das Speichern einer beliebigen Adresse setzt billingAddressNeedsReview zurück. null löscht die Adresse.
billingAddressstring
Die Rechnungsadresse als eine Textzeile, bis zu 500 Zeichen. Wird ignoriert, wenn billingAddressParts gesendet wird; andernfalls ersetzt sie die Adresse und ihre einzelnen Felder.
taxIdstring
Steuernummer, bis zu 64 Zeichen. Wird mit der Rechnungsadresse auf den Rechnungs-PDFs gedruckt, die Pleaxy für Rechnungen zwischen verbundenen Unternehmen erstellt.
primaryContactNamestring
Name des Hauptansprechpartners.
primaryContactEmailstring
E-Mail-Adresse des Hauptansprechpartners.
countriesstring[]
Ersetzt die Länder der Region, als ISO-3166-1-alpha-2-Codes, eindeutig, bis zu 250. Ändert nie die Währung.
geographyPresetIdstring | null
Hält fest, aus welcher Vorlage (zum Beispiel eu, uk, apac, global) die Länderliste stammt; null entfernt den Wert.
timeZonestring
IANA-Zeitzone, z. B. Europe/London. Legt das "Heute" des Workspace für Zahlungsdaten fest.
listedInDirectoryboolean
Nur Lieferantenprofile (bei einem Käufer ignoriert): true listet Sie im Lieferantenverzeichnis, das jeder Käufer auf Pleaxy beim Einladen eines Lieferanten durchsucht, nur mit Unternehmensname und Region - nie mit Ihrer Kontakt-E-Mail. Ein Käufer kann Sie dann einladen, ohne Ihre E-Mail-Adresse zu kennen; die Einladung geht an den Kontakt Ihres Kontos. false nimmt Sie aus dem Verzeichnis heraus.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Aktualisiert ein oder mehrere Felder des Organisationsprofils des Aufrufers.

Fehler

400 Bad Request - Ein Feld besteht die Validierung nicht - zum Beispiel ist regionName länger als 40 Zeichen, currency ist kein ISO-4217-Code, oder billingAddressParts fehlt ein Bestandteil, den das Land verlangt (etwa region und postalCode bei einer US-Adresse).
409 Conflict - currency weicht von der gespeicherten Währung ab, und in diesem Käufer-Workspace sind bereits Bestellungen oder Rechnungen darin erfasst. Es wird nichts geändert. Um in einer anderen Währung einzukaufen, fügen Sie eine Region hinzu.
404 Not Found - Für diesen Workspace und diese Rolle gibt es noch kein Organisationsprofil.
401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.

PATCH /v1/workspaces/{regionId}/profile

Anfrage

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
}

Antwort · 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"
}