Emite órdenes de compra, aprueba y paga facturas, y configura tu espacio de trabajo.

Referencia de la API

Perfiles de organización

El perfil comercial y los datos de facturación de tu empresa.

Más sobre este recurso

El perfil comercial de una organización compradora o proveedora: datos de facturación y contacto principal.

Endpoints

GET…/profile
PATCH…/profile

Obtener perfil de organización

Devuelve el perfil de tu empresa.

GET/v1/workspaces/{regionId}/profile

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve el perfil de organización del llamador para este espacio de trabajo (comprador o proveedor, según el rol del llamador).

Campos de la respuesta

billingAddressstring
La dirección de facturación en una línea, derivada de billingAddressParts. En un perfil guardado antes de que las direcciones tuvieran campos separados, el texto tal como se escribió, y billingAddressParts no aparece.
billingAddressPartsobject
La dirección de facturación en campos separados (consulta UpdateOrgProfile).
billingAddressNeedsReviewboolean
true cuando una dirección antigua de una sola línea no se pudo dividir en campos con seguridad y un administrador debería revisarla. Se borra al guardar la dirección.
billingAddressLegacyTextstring
La dirección de una sola línea tal como era antes de dividirla en campos, sin cambios.
listedInDirectoryboolean
Solo perfiles de proveedor: el proveedor eligió que lo encuentren los compradores que buscan en Pleaxy (consulta UpdateOrgProfile). Si falta, no figura en el directorio.
directoryIdstring
Solo perfiles de proveedor: el id opaco con el que los compradores invitan a un proveedor del directorio; se asigna la primera vez que figura en él y se conserva si se desactiva y se vuelve a activar. Los compradores nunca ven tu correo de contacto a través del directorio.

Errores

404 Not Found - Todavía no existe ningún perfil de organización para este espacio de trabajo y rol.
401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.

GET /v1/workspaces/{regionId}/profile

Solicitud

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

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

Actualizar perfil de organización

Actualiza el perfil de tu empresa.

PATCH/v1/workspaces/{regionId}/profile

Cuerpo

regionNamestring
El nombre visible de la región, hasta 40 caracteres.
currencystring
Código ISO 4217, sin distinguir mayúsculas (se guarda en mayúsculas). La moneda de un espacio de trabajo de comprador no puede cambiar una vez que tiene alguna orden de compra (salvo borradores) o factura.
companyNamestring
Nombre legal o visible de la empresa.
billingEmailstring
Dirección de correo a la que se envían las facturas y los recibos.
billingAddressPartsobject | null
La dirección de facturación en campos separados: line1 (obligatorio, hasta 200 caracteres), line2, city, region (estado, provincia o condado), postalCode y country (obligatorio, ISO 3166-1 alfa-2). Qué otros campos son obligatorios depende del país: city en todas partes salvo en ciudades-estado como SG y HK; region en US, CA, MX, BR y AU; postalCode en la mayor parte de Europa y en US, CA, MX, BR, AU, IN y JP, y opcional en el resto, incluida la mayor parte de América Latina. billingAddress se deriva de ella. Guardar cualquier dirección borra billingAddressNeedsReview. null borra la dirección.
billingAddressstring
La dirección de facturación como una línea de texto, hasta 500 caracteres. Se ignora cuando se envía billingAddressParts; si no, reemplaza la dirección y sus campos separados.
taxIdstring
Número de identificación fiscal, hasta 64 caracteres. Se imprime con la dirección de facturación en los PDF de factura que Pleaxy crea para las facturas entre empresas conectadas.
primaryContactNamestring
Nombre del contacto principal.
primaryContactEmailstring
Correo del contacto principal.
countriesstring[]
Reemplaza los países de la región, como códigos ISO 3166-1 alfa-2, únicos, hasta 250. Nunca cambia la moneda.
geographyPresetIdstring | null
Registra de qué preajuste (por ejemplo eu, uk, apac, global) salió la lista de países; null lo borra.
timeZonestring
Zona horaria IANA, p. ej. Europe/London. Define el "hoy" del espacio de trabajo para las fechas de pago.
listedInDirectoryboolean
Solo perfiles de proveedor (se ignora para un comprador): true te incluye en el directorio de proveedores en el que busca cualquier comprador de Pleaxy al invitar a un proveedor, solo por nombre de empresa y región, nunca por tu correo de contacto. Así, un comprador puede invitarte sin conocer tu correo; la invitación va al contacto de tu cuenta. false te saca del directorio.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Actualiza uno o más campos del perfil de organización del llamador.

Errores

400 Bad Request - Un campo no superó la validación: por ejemplo, regionName tiene más de 40 caracteres, currency no es un código ISO 4217, o a billingAddressParts le falta una parte que exige su país (como region y postalCode en una dirección de EE. UU.).
409 Conflict - currency difiere de la guardada y este espacio de trabajo de comprador ya tiene órdenes de compra o facturas registradas. No se cambia nada. Para comprar en otra moneda, agrega una región.
404 Not Found - Todavía no existe ningún perfil de organización para este espacio de trabajo y rol.
401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.

PATCH /v1/workspaces/{regionId}/profile

Solicitud

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
}

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