Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yokoy Purchase order API

Purchase orders are legal orders that companies send to their suppliers to buy items, services, products. Yokoy uses purchase orders to perform two-way and three-way matching (matching invoice line items with purchase order line items).

Yokoy Purchase order API is one of 22 APIs that Yokoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Purchase order. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.41.0.

Requests are made against 2 base URLs: https://api.yokoy.ai/v1/organizations/{organizationId}, https://api.test.yokoy.ai/v1/organizations/{organizationId}.

5 operations 2 paths 5 schemas 2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.41.0
Base URL
https://api.yokoy.ai/v1/organizations/{organizationId}
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Yokoy Purchase order API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

  • OAuth2 — Authentication to the Yokoy API relies on the standard OAuth2 client credentials flow. 1. Obtain an access token Perform a POST request to https://accounts.yok…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Purchase order 5

Purchase orders are legal orders that companies send to their suppliers to buy items, services, products. Yokoy uses purchase orders to perform two-way and three-way matching (mat…

GET
/legal-entities/{legalEntityId}/invoice-purchase-orders
List all purchase orders
listPOs 4 params → 200400401403429500502503
POST
/legal-entities/{legalEntityId}/invoice-purchase-orders
Create a purchase order
createPO 3 params body → 201400401403429500502503
GET
/legal-entities/{legalEntityId}/invoice-purchase-orders/{purchaseOrderId}
Get a purchase order by ID
getPO 4 params → 200401403404429500502503
PATCH
/legal-entities/{legalEntityId}/invoice-purchase-orders/{purchaseOrderId}
Modify a purchase order
modifyPO 4 params body → 200400401403404429500502
PUT
/legal-entities/{legalEntityId}/invoice-purchase-orders/{purchaseOrderId}
Update a purchase order
updatePO 4 params body → 200400401403404429500502

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PurchaseOrderItem (19 properties), PurchaseOrder (17 properties), HttpError (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

DateString
string
PurchaseOrderItem
object
19 properties
PurchaseOrder
object
17 properties 6 required
Error
object
2 properties 2 required
HttpError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yokoy-purchase-order-api-openapi.yml Raw ↑

Other APIs Yokoy publishes across the network.

Yokoy Card account API
Yokoy Company card API
Yokoy Cost center API
Yokoy Daily statement API
Yokoy Expense API
Yokoy Expense category API
Yokoy External invoice API
Yokoy Finance export API
Yokoy FX rates API
Yokoy Goods receipt API
Yokoy Invoice API
Yokoy Invoice category API