Pleaxy

Emetti ordini d’acquisto, approva e paga le fatture e configura il tuo spazio di lavoro.

Riferimento API

Profili dell’organizzazione

Il profilo aziendale e i dati di fatturazione della tua azienda.

Altro su questa risorsa

Il profilo aziendale di un’organizzazione acquirente o fornitore: dati di fatturazione e referente principale.

Endpoint

Recuperare il profilo dell’organizzazione

Restituisce il profilo della tua azienda.

GET/v1/workspaces/{regionId}/profile

Restituisce

200 OK con l’oggetto mostrato nella risposta.

Più dettagli

Restituisce il profilo dell’organizzazione del chiamante per questo workspace (acquirente o fornitore, in base al ruolo del chiamante).

Campi della risposta

  • billingAddressstring

    L’indirizzo di fatturazione su una sola riga, ricavato da billingAddressParts. Su un profilo salvato prima che gli indirizzi avessero campi separati, il testo così come era stato digitato, e billingAddressParts è assente.

  • billingAddressPartsobject

    L’indirizzo di fatturazione in campi separati (vedi UpdateOrgProfile).

  • billingAddressNeedsReviewboolean

    true quando un indirizzo su una sola riga meno recente non è stato suddiviso in campi con sicurezza e un amministratore dovrebbe verificarlo. Viene rimosso salvando l’indirizzo.

  • billingAddressLegacyTextstring

    L’indirizzo su una sola riga com’era prima di essere suddiviso in campi, conservato invariato.

  • listedInDirectoryboolean

    Solo profili fornitore: il fornitore ha scelto di essere trovato dagli acquirenti che cercano su Pleaxy (vedi UpdateOrgProfile). Se assente, non è elencato.

  • directoryIdstring

    Solo profili fornitore: l’id opaco con cui gli acquirenti invitano un fornitore elencato, impostato la prima volta che viene elencato e mantenuto se l’opzione viene disattivata e riattivata. Gli acquirenti non vedono mai la tua email di contatto tramite la directory.

Errori

  • 404 Not Found - Non esiste ancora un profilo dell’organizzazione per questo workspace e ruolo.
  • 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
  • 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
GET /v1/workspaces/{regionId}/profile
Richiesta
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/profile" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Risposta · 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"
}

Aggiornare il profilo dell’organizzazione

Aggiorna il profilo della tua azienda.

PATCH/v1/workspaces/{regionId}/profile

Corpo

  • regionNamestring

    Il nome visualizzato della regione, fino a 40 caratteri.

  • currencystring

    Codice ISO 4217, senza distinzione tra maiuscole e minuscole (memorizzato in maiuscolo). La valuta di un workspace acquirente non può cambiare una volta che ha un qualsiasi ordine d’acquisto (bozze escluse) o fattura.

  • companyNamestring

    Ragione sociale o nome visualizzato dell’azienda.

  • billingEmailstring

    Indirizzo email a cui vengono inviate fatture e ricevute.

  • billingAddressPartsobject | null

    L’indirizzo di fatturazione in campi separati: line1 (obbligatorio, fino a 200 caratteri), line2, city, region (stato, provincia o contea), postalCode e country (obbligatorio, ISO 3166-1 alpha-2). Gli altri campi obbligatori dipendono dal paese: city ovunque tranne nelle città-stato come SG e HK; region in US, CA, MX, BR e AU; postalCode nella maggior parte dell’Europa e in US, CA, MX, BR, AU, IN e JP, e facoltativo altrove, compresa la maggior parte dell’America Latina. billingAddress ne viene ricavato. Salvare un qualsiasi indirizzo rimuove billingAddressNeedsReview. null cancella l’indirizzo.

  • billingAddressstring

    L’indirizzo di fatturazione come una riga di testo, fino a 500 caratteri. Ignorato quando viene inviato billingAddressParts; altrimenti sostituisce l’indirizzo e i suoi campi separati.

  • taxIdstring

    Partita IVA o codice fiscale, fino a 64 caratteri. Stampato con l’indirizzo di fatturazione sui PDF delle fatture che Pleaxy crea per le fatture tra aziende collegate.

  • primaryContactNamestring

    Nome del referente principale.

  • primaryContactEmailstring

    Email del referente principale.

  • countriesstring[]

    Sostituisce i paesi della regione, come codici ISO 3166-1 alpha-2, univoci, fino a 250. Non cambia mai la valuta.

  • geographyPresetIdstring | null

    Registra da quale preset (ad esempio eu, uk, apac, global) deriva l’elenco dei paesi; null lo rimuove.

  • timeZonestring

    Fuso orario IANA, ad es. Europe/London. Imposta l’"oggi" del workspace per le date di pagamento.

  • listedInDirectoryboolean

    Solo profili fornitore (ignorato per un acquirente): true ti inserisce nella directory dei fornitori in cui ogni acquirente su Pleaxy cerca quando invita un fornitore, solo per ragione sociale e regione, mai per email di contatto. Un acquirente può così invitarti senza conoscere la tua email; l’invito va al contatto del tuo account. false ti rimuove dalla directory.

Restituisce

200 OK con l’oggetto mostrato nella risposta.

Più dettagli

Aggiorna uno o più campi del profilo dell’organizzazione del chiamante.

Errori

  • 400 Bad Request - Un campo non ha superato la convalida: ad esempio regionName supera i 40 caratteri, currency non è un codice ISO 4217, oppure a billingAddressParts manca una parte richiesta dal suo paese (come region e postalCode per un indirizzo statunitense).
  • 409 Conflict - currency è diversa da quella memorizzata, e questo workspace acquirente ha già ordini d’acquisto o fatture registrati. Nulla viene modificato. Per acquistare in un’altra valuta, aggiungi una regione.
  • 404 Not Found - Non esiste ancora un profilo dell’organizzazione per questo workspace e ruolo.
  • 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
  • 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
PATCH /v1/workspaces/{regionId}/profile
Richiesta
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
}
Risposta · 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"
}
Contattaci