Yokoy Finance export API
Finance export mechanism in Yokoy. The Yokoy API exposes three different endpoints for the management of finance exports:1. `/export-tasks` to trigger an export (separate endpoints for the expense and the invoice module).This action is equivalent to clicking the "Export" button under Finance > Export within the Yokoy application.As a result of a successful export, the expenses/invoices are set to the exported state.2. `/export-tasks/{exportTaskId}` to poll the details (in particular the status) of the asynchronous export job.3. `/export-tasks/{exportTaskId}/artefacts` to fetch the artefacts for those export facilities that support this functionality.To generate the standard Yokoy export artefacts, the export facility "Yokoy Standard Export (API)" must be selected in Yokoy (Admin > Integrations).The data model of the standard export artefacts (ExpenseExportArtefact and InvoiceExportArtefact) is described in the following OpenAPI specification.
Yokoy Finance export API is one of 22 APIs that Yokoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Finance export. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 5 operations across 5 paths, and defines 5 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 Finance export 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 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Finance export mechanism in Yokoy. The Yokoy API exposes three different endpoints for the management of finance exports: 1. /export-tasks to trigger an export (separate endpoints…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ExpenseExportArtefact (5 properties), InvoiceExportArtefact (5 properties), Error (2 properties), InvoiceExportTaskInformation (1 property). 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.