Pleaxy

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

Referência da API

Regras de automação

Regras que aprovam automaticamente, ou sempre enviam para aprovação, os documentos correspondentes.

Mais sobre este recurso

Exceções condicionais sobre as configurações de autonomia de Liquidação, por processo (purchase_order, invoice_payment): uma regra corresponde pela conta do fornecedor (ou, para um fornecedor sem conta na Pleaxy, pelo nome) e pelo valor, e aprova automaticamente uma correspondência sem ninguém agir ou força a cadeia de aprovação completa. Uma regra de aprovação automática exige o plano Autonomous e nunca se aplica a uma fatura que a autonomia também não poderia aprovar (uma lançada por um comprador, uma em outra moeda, ou uma não conciliada com uma fatura emitida pela AWS), nem a um pedido de compra acima de um limite de gastos. As regras são avaliadas em ordem, e vale a primeira correspondência ativada.

Endpoints

Obter regras de automação

Retorna as regras de automação de um processo.

GET/v1/workspaces/{regionId}/automation-rules/{process}

Parâmetros

  • process"purchase_order" | "invoice_payment"Obrigatório

    De qual fluxo obter as regras.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Retorna as regras de automação de um processo em ordem de prioridade, ou { process, rules: [] } se nenhuma estiver configurada, e se o plano do espaço de trabalho permite que regras de aprovação automática sejam executadas.

Campos da resposta

  • autoApproveAllowedboolean

    Se o plano permite autonomia (Autonomous ou Enterprise). Quando false, regras com autoApprove true são mantidas, mas puladas quando pedidos e faturas são avaliados, para que uma regra depois delas ainda possa corresponder; fazer upgrade as faz voltar a ser executadas. Calculado a cada leitura, nunca armazenado.

Erros

  • 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}/automation-rules/{process}
Requisição
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Resposta · 200 OK
{
   "process": "purchase_order" | "invoice_payment",
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean, "createdAt": "string" }
   ],
   "autoApproveAllowed": boolean
}

Atualizar regras de automação

Substitui as regras de automação de um processo.

PATCH/v1/workspaces/{regionId}/automation-rules/{process}

Parâmetros

  • process"purchase_order" | "invoice_payment"Obrigatório

    De qual fluxo substituir as regras.

Corpo

  • rulesarrayObrigatório

    Cada uma { id?, label, conditions: { supplierWorkspaceId?, supplierContains?, maxAmount? }, autoApprove, enabled }. supplierWorkspaceId é a conta do fornecedor à qual a regra se aplica (o ID do espaço de trabalho dele, por exemplo reg_….supplier) e precisa ser um dos seus fornecedores conectados; os fornecedores são correspondidos pela conta, nunca pelo nome. supplierContains é legado e só corresponde a fornecedores sem conta na Pleaxy. autoApprove true dispensa a aprovação para uma correspondência; false força a cadeia completa.

Retorna

200 OK com o objeto mostrado na resposta.

Mais detalhes

Substitui as regras de automação de um processo, em ordem de prioridade. Uma regra que mantém o id mantém o createdAt.

Alterado em 2026-09-27, uma correção de segurança dentro da v1: só sessão conectada, para todos os processos: uma regra de aprovação automática aprova pedidos de compra ou faturas sem ninguém agir, então uma chave de API recebe 403 HUMAN_SESSION_REQUIRED, qualquer que seja a função de compras dela. A leitura das regras continua aceitando uma chave de API de comprador.

Erros

  • 400 Bad Request - AUTONOMY_PLAN_REQUIRED: uma nova regra, ou uma alteração em uma existente, define autoApprove true em um plano sem autonomia ("Auto-approve rules need the Autonomous plan - the {Plan} plan allows rules that require approval only. Upgrade to Autonomous to use auto-approve rules."). Nada é salvo. Uma regra já armazenada com autoApprove true pode ser reenviada com as condições inalteradas (o rótulo e o interruptor de ativação podem mudar), para que o resto da lista continue editável; alterar as condições dela é recusado.
  • 400 Bad Request - DUPLICATE_RULE_ID: a lista traz o mesmo id de regra mais de uma vez ("Rule '{id}' is in the list more than once. Send each rule once."). Nada é salvo.
  • 403 Forbidden - Código HUMAN_SESSION_REQUIRED. Quem chama não é uma pessoa conectada (por exemplo, uma chave de API), para qualquer processo ("Automation rules can only be changed by a signed-in person. Change them in Pleaxy."). Nada é salvo.
  • 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}/automation-rules/{process}
Requisição
curl -X PATCH "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/automation-rules/{process}" \
  -H "X-Api-Key: $PLEAXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d @body.json
body.json
{
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean }
   ]
}
Resposta · 200 OK
{
   "process": "purchase_order" | "invoice_payment",
   "rules": [
      { "id": "string", "label": "string", "conditions": { "supplierWorkspaceId": "string", "supplierContains": "string", "maxAmount": number }, "autoApprove": boolean, "enabled": boolean, "createdAt": "string" }
   ]
}
Fale conosco