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 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}.

5 operations 2 paths 2 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 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.

Policy 5

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…

GET
/legal-entities/{legalEntityId}/policies
List all policies for a legal entity
listPolicies 4 params → 200400401403429500502503
POST
/legal-entities/{legalEntityId}/policies
Create a policy
createPolicy 3 params body → 201400401403429500502503
GET
/legal-entities/{legalEntityId}/policies/{policyId}
Get a policy by ID
getPolicy 4 params → 200401403404429500502503
PATCH
/legal-entities/{legalEntityId}/policies/{policyId}
Modify a policy
modifyPolicy 4 params body → 200400401403404429500502
PUT
/legal-entities/{legalEntityId}/policies/{policyId}
Update a policy
updatePolicy 4 params body → 200400401403404429500502

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.

Policy
object
5 properties 4 required
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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