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.

Business capability
Supplier Management BC-510

Operations 10

GET /legal-entities/{legalEntityId}/suppliers List all suppliers (legal entity) #
POST /legal-entities/{legalEntityId}/suppliers Add a supplier (legal entity) #
GET /legal-entities/{legalEntityId}/suppliers/{supplierId} Get a supplier by ID (legal entity) #
PATCH /legal-entities/{legalEntityId}/suppliers/{supplierId} Modify a supplier (legal entity) #
PUT /legal-entities/{legalEntityId}/suppliers/{supplierId} Update a supplier (legal entity) #
GET /suppliers List all suppliers (organization) #
POST /suppliers Create a supplier (organization) #
GET /suppliers/{supplierId} Get an organization supplier by ID #
PATCH /suppliers/{supplierId} Modify a supplier (organization) #
PUT /suppliers/{supplierId} Update a supplier (organization) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/yokoy:yokoy-supplier-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yokoy-supplier-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Public API of the Yokoy Application
  title: Yokoy Supplier API
  version: 1.41.0
servers:
- description: API server scoped to organization with ID `organizationId`
  url: https://api.yokoy.ai/v1/organizations/{organizationId}
  variables:
    organizationId:
      default: AbcDeF1234
      description: Yokoy organization ID
- description: API test server scoped to organization with ID `organizationId`
  url: https://api.test.yokoy.ai/v1/organizations/{organizationId}
  variables:
    organizationId:
      default: AbcDeF1234
      description: Yokoy organization ID
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yokoy/refs/heads/main/openapi/yokoy-supplier-api-openapi.yml