Yokoy Policy API
An employee policy determines the settings made available to a group of employees. A policy determines:- **categories**: the categories available to users to select.- **tags**: tags applicable to those users- **expense rules**: the expense rules used to calculate expenses for those users.- **per diems**: applicable rules per diems at a global level, irrespective of whether the conditions are met for applicability.- **mileage*: applicable rates at a global level, irrespective of the employee’s mileage counter or border crossings.You can use the API to set the categories available to users who have been assigned the policy. To set tags, expense rules, per diems and mileage rates, use the Yokoy UI.
Yokoy Policy API is one of 22 APIs that Yokoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Policy. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 5 operations across 2 paths, and defines 2 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 Policy 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.
An employee policy determines the settings made available to a group of employees. A policy determines: - categories: the categories available to users to select. - tags: tags app…
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Policy (5 properties), Error (2 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.