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 Supplier API

Companies that supply your company with goods, services, items. The Supplier entity contains information on the name, address, and bank accounts of the supplier.Suppliers can be set up for different legal entities with default settings at each legal entity level.Suppliers must first be created for the organization at `/suppliers` with their basic definition such as name, address, tax number and bank accounts.Then they can be created legal entity-level at `/legal-entities/{entityId}/suppliers` with the organization supplier ID in `supplierId`. Without creating a legal entity supplier, the supplier does not appear in Yokoy (in **Invoice processor > Suppliers**).Legal entity suppliers can be updated/created just for certain applicable fields.To add (POST) or update (PATCH or PUT) a complete legal entity supplier record (e.g. the name of the supplier, contact or banking information), you need to add or update the organization supplier first. These changes are automatically progpaged to the legal entity suppliers (i.e. the same supplier may supply several legal entities) linked to that organization supplier. Then in a subsequent call to the legal entity supplier endpoint, you can update the legal entity supplier.**NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.It must use the following pattern: `externalId` of the organization supplier + '_' + Yokoy ID of the legal entity.

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

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

This API exposes 10 operations across 4 paths, and defines 9 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}.

10 operations 4 paths 9 schemas 4 GET2 PATCH2 POST2 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 Supplier 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 10

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

Supplier 10

Companies that supply your company with goods, services, items. The Supplier entity contains information on the name, address, and bank accounts of the supplier. Suppliers can be…

GET
/legal-entities/{legalEntityId}/suppliers
List all suppliers (legal entity)
listEntitySupplier 4 params → 200400401403429500502503
POST
/legal-entities/{legalEntityId}/suppliers
Add a supplier (legal entity)
createEntitySupplier 3 params body → 201400401403429500502503
GET
/legal-entities/{legalEntityId}/suppliers/{supplierId}
Get a supplier by ID (legal entity)
getEntitySupplier 4 params → 200401403404429500502503
PATCH
/legal-entities/{legalEntityId}/suppliers/{supplierId}
Modify a supplier (legal entity)
modifyEntitySupplier 4 params body → 200400401403404429500502
PUT
/legal-entities/{legalEntityId}/suppliers/{supplierId}
Update a supplier (legal entity)
updateEntitySupplier 4 params body → 200400401403404429500502
GET
/suppliers
List all suppliers (organization)
listOrgSuppliers 3 params → 200400401403429500502503
POST
/suppliers
Create a supplier (organization)
createOrgSupplier 2 params body → 201400401403429500502503
GET
/suppliers/{supplierId}
Get an organization supplier by ID
getOrgSupplier 3 params → 200401403404429500502503
PATCH
/suppliers/{supplierId}
Modify a supplier (organization)
modifyOrgSupplier 3 params body → 200400401403404429500502
PUT
/suppliers/{supplierId}
Update a supplier (organization)
updateOrgSupplier 3 params body → 200400401403404429500502

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are LegalEntitySupplier (18 properties), OrganizationSupplier (18 properties), InvoiceBankAccount (7 properties), SupplierAutoSubmissionSettings (5 properties). Each schema is shown below with its type and property counts.

OrganizationSupplier
object
18 properties 3 required
InvoiceBankAccount
object
Information related to the payment of the invoice.
7 properties
Supplier
HttpError
object
2 properties 2 required
SupplierContact
object
5 properties 5 required
LegalEntitySupplier
object
18 properties 4 required
SupplierAutoSubmissionDocumentSettings
object
2 properties 1 required
SupplierAutoSubmissionSettings
object
5 properties 1 required
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yokoy-supplier-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