Qubiqle purchaseOrders API is one of 9 APIs that Qubiqle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include purchaseOrders. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
5 operations
across 3 paths,
and defines 34 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.ottimate.com/v1, https://sandbox-api.ottimate.com/v1.
5 operations3 paths34 schemas2 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ottimate.com/v1
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Qubiqle purchaseOrders API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuth2).
OAuth2 — OAuth2 authentication flows. Auth server URLs will vary by environment
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
purchaseOrders 5
GET
/purchase-orders
Retrieve a paginated list of purchase orders
get-purchase-orders-root13 params→ 200400401
POST
/purchase-orders
Create a single purchase order
post-purchase-orders-root4 paramsbody→ 201400
GET
/purchase-orders/{id}
Retrieve a specific purchase order by ID
get-purchase-orders-id4 params→ 200404
PATCH
/purchase-orders/{id}
Update an existing purchase order
patch-purchase-orders-id4 paramsbody→ 200400404
POST
/purchase-orders/bulk
Bulk create or update purchase orders
post-purchase-orders-bulk4 paramsbody→ 202400
Schemas 34
The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are PurchaseOrderDetailPurchaseOrder (21 properties), PurchaseOrderSummary (15 properties), PurchaseOrderCreateRequest (14 properties), PurchaseOrderCreateResponse (14 properties). Each schema is shown below with its type and property counts.
PurchaseOrderCreateRequestCustomFields
object
Optional custom fields configured for this company's purchase orders
Dimension values keyed by dimension type. Each value must be a string — the ERP dimension code or ID (e.g. "DEPT-001"). Example: {"DEPARTMENT": "DEPT-001", "CL…
Dimension values keyed by type (e.g. PROJECT, CLASS). Each value is the ERP externalid of the dimension. When provided, REPLACES all existing dimensions on the…
Resolved dimensions keyed by dimension type. Each value is an object containing the dimension's id, erpdimensionid, name, and code — unlike the POST/PATCH requ…
PurchaseOrderUpdateResponseStatus
string
PurchaseOrderCreateRequestItemsItems
object
7 properties3 required
PurchaseOrderSummaryStatus
string
PurchaseOrderCreateRequestItemsItemsDimensions
object
Dimension values keyed by type (e.g. PROJECT, CLASS). Each value is the ERP externalid of the dimension. When provided, REPLACES all existing dimensions on the…
Custom fields configured for this company's purchase orders
PurchaseOrderCreateResponseItemsItemsDimensions
object
Resolved dimensions keyed by dimension type. Each value is an object containing the dimension's id, erpdimensionid, name, and code — unlike the POST/PATCH requ…
