Pleaxy

Emita pedidos de compra, aprove e pague faturas, e configure seu espaço de trabalho.

Referência da API

Perfis da organização

O perfil empresarial e os dados de faturamento da sua empresa.

Mais sobre este recurso

O perfil empresarial de uma organização compradora ou fornecedora - dados de faturamento e contato principal.

Endpoints

Obter perfil da organização

Retorna o perfil da sua empresa.

GET/v1/workspaces/{regionId}/profile

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Retorna o perfil da organização de quem chama para este espaço de trabalho (comprador ou fornecedor, conforme a função de quem chama).

Campos da resposta

  • billingAddressstring

    O endereço de faturamento em uma linha, derivado de billingAddressParts. Em um perfil salvo antes de os endereços terem campos separados, o texto como foi digitado, e billingAddressParts fica ausente.

  • billingAddressPartsobject

    O endereço de faturamento em campos separados (veja UpdateOrgProfile).

  • billingAddressNeedsReviewboolean

    true quando um endereço antigo de uma linha não pôde ser dividido em campos com segurança e um administrador deve verificá-lo. Removido ao salvar o endereço.

  • billingAddressLegacyTextstring

    O endereço de uma linha como era antes de ser dividido em campos, mantido sem alterações.

  • listedInDirectoryboolean

    Só para perfis de fornecedor: o fornecedor optou por ser encontrado por compradores que buscam na Pleaxy (veja UpdateOrgProfile). Ausente significa não listado.

  • directoryIdstring

    Só para perfis de fornecedor: o id opaco com que os compradores convidam um fornecedor listado, definido na primeira vez em que ele é listado e mantido se for desativado e reativado. Os compradores nunca veem o seu e-mail de contato pelo diretório.

Erros

  • 404 Not Found - Ainda não existe perfil de organização para este espaço de trabalho e função.
  • 401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
  • 403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.
GET /v1/workspaces/{regionId}/profile
Requisição
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/profile" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Resposta · 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"
}

Atualizar perfil da organização

Atualiza o perfil da sua empresa.

PATCH/v1/workspaces/{regionId}/profile

Corpo

  • regionNamestring

    O nome de exibição da região, até 40 caracteres.

  • currencystring

    Código ISO 4217, sem diferenciar maiúsculas e minúsculas (armazenado em maiúsculas). A moeda de um espaço de trabalho de comprador não pode mudar depois que ele tem algum pedido de compra (fora rascunhos) ou fatura.

  • companyNamestring

    Nome jurídico ou de exibição da empresa.

  • billingEmailstring

    Endereço de e-mail para o qual faturas/recibos são enviados.

  • billingAddressPartsobject | null

    O endereço de faturamento em campos separados: line1 (obrigatório, até 200 caracteres), line2, city, region (estado, província ou condado), postalCode e country (obrigatório, ISO 3166-1 alpha-2). Quais outros campos são obrigatórios depende do país: city em todos, exceto cidades-estado como SG e HK; region em US, CA, MX, BR e AU; postalCode na maior parte da Europa e em US, CA, MX, BR, AU, IN e JP, e opcional nos demais, inclusive na maior parte da América Latina. billingAddress é derivado dele. Salvar qualquer endereço remove billingAddressNeedsReview. null limpa o endereço.

  • billingAddressstring

    O endereço de faturamento como uma linha de texto, até 500 caracteres. Ignorado quando billingAddressParts é enviado; caso contrário, substitui o endereço e seus campos separados.

  • taxIdstring

    Número de identificação fiscal, até 64 caracteres. Impresso com o endereço de faturamento nos PDFs de fatura que a Pleaxy cria para faturas entre empresas conectadas.

  • primaryContactNamestring

    Nome do contato principal.

  • primaryContactEmailstring

    E-mail do contato principal.

  • countriesstring[]

    Substitui os países da região, como códigos ISO 3166-1 alpha-2, únicos, até 250. Nunca altera a moeda.

  • geographyPresetIdstring | null

    Registra de qual predefinição (por exemplo eu, uk, apac, global) veio a lista de países; null a remove.

  • timeZonestring

    Fuso horário IANA, por exemplo Europe/London. Define o "hoje" do espaço de trabalho para datas de pagamento.

  • listedInDirectoryboolean

    Só para perfis de fornecedor (ignorado para um comprador): true inclui você no diretório de fornecedores que todo comprador na Pleaxy consulta ao convidar um fornecedor, só pelo nome da empresa e pela região - nunca pelo seu e-mail de contato. Um comprador pode então convidar você sem saber o seu e-mail; o convite vai para o contato da sua conta. false tira você do diretório.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Atualiza um ou mais campos do perfil da organização de quem chama.

Erros

  • 400 Bad Request - Um campo não passou na validação - por exemplo, regionName tem mais de 40 caracteres, currency não é um código ISO 4217, ou falta em billingAddressParts uma parte que o país exige (como region e postalCode para um endereço dos EUA).
  • 409 Conflict - currency difere da armazenada, e este espaço de trabalho de comprador já tem pedidos de compra ou faturas registrados. Nada é alterado. Para comprar em outra moeda, adicione uma região.
  • 404 Not Found - Ainda não existe perfil de organização para este espaço de trabalho e função.
  • 401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
  • 403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.
PATCH /v1/workspaces/{regionId}/profile
Requisição
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
}
Resposta · 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"
}
Fale conosco