Raise purchase orders, approve and pay invoices, and set up your workspace.
Endpoint search
Search the buyer API
178 endpoints across 23 resources. Search by path, method or what you want to do - paste a real URL and its ids match the path's parameters.
Try
API reference
The Pleaxy API is a REST API with JSON requests and responses. Use it to read and create purchase orders and invoices, and to follow them through approval and payment. For concepts and guides, see the documentation.
Authentication
Send one of two headers with every request:
X-Api-Key: <keyId>.<secret>- an API key, for your own systems and agents.Authorization: Bearer <accessToken>- a signed-in person's session, required for a few actions such as approving and managing API keys.
A credential works in one workspace, as a buyer or a supplier. Every path includes that workspace's id as regionId; copy it from Company profile → Workspace ID in Pleaxy.
Errors
Errors use 4xx status codes and a JSON body. Branch on code, not on the English message; messageId and params let you show the message in your own language.
Versioning
Paths start with the version, /v1. New endpoints, fields and values are added within it, so ignore fields you don't recognize and keep a default for unknown values such as statuses. Breaking changes come as a new version.
https://api.pleaxy.aicurl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"statusCode": 404,
"error": "Not Found",
"message": "Invoice INV-7F3A9C21 not found.",
"code": "string",
"messageId": "string",
"params": { ... }
}Resources
- Purchase ordersOrders a buyer places with a supplier: their lines, amounts, status and approval.15 endpoints
- Purchase requestsWhat people ask to buy, before there is an order: approval, budget check, then an order.13 endpoints
- Budget controlWhether orders and requests are checked against cost center budgets, and where each budget stands.4 endpoints
- SourcingRequests for quotes (RFQs) to several suppliers, and their answers side by side.4 endpoints
- InvoicesInvoices from suppliers to buyers, from arrival through matching, approval and payment.34 endpoints
- Credit notesCredit notes that reduce what a buyer owes, and applying them to invoices.11 endpoints
- Supplier riskWhat needs a look about each supplier: bank details, sanctions screening and missing documents.7 endpoints
- Cloud connectionsRead-only links to your cloud provider accounts' billing.8 endpoints
- AI spendAI model spend by invoicer, vendor, model and meter, set against your purchase orders.21 endpoints
- AI providersAI providers connected directly with a read-only key, and the AI invoicers you can add as suppliers.6 endpoints
- FOCUSExport your invoices as a FOCUS dataset, and read your providers' FOCUS billing data.13 endpoints
- SettlementWhen purchase orders and invoices can skip manual approval, and the workspace's plan.3 endpoints
- Approval chainsWho approves purchase orders and invoice payments.2 endpoints
- Automation rulesRules that auto-approve, or always send to approval, matching documents.2 endpoints
- ApprovalsThe purchase orders and invoices waiting on you.1 endpoint
- EmployeesThe people in a workspace.1 endpoint
- WorkspacesDashboard summaries of a buyer's or supplier's activity.1 endpoint
- Org profilesYour company's business profile and billing details.2 endpoints
- NotificationsIn-app notifications and reminder settings.6 endpoints
- API keysKeys that let your systems call the API without a person signed in.3 endpoints
- Document syncKeep your own system in step: what changed, and each document as JSON, cXML or UBL.8 endpoints
- Order fulfillmentSuppliers confirm orders and announce shipments; buyers see both on the order.6 endpoints
- WebhooksHave Pleaxy send each change to your HTTPS endpoint as it happens.7 endpoints