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}.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yokoy 12
Other APIs Yokoy publishes across the network.