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 Invoice API

In the Yokoy API, invoices can only be created or retrieved. You can only update custom information via API.To update other attributes or delete the invoice, use the Yokoy web app.

Yokoy Invoice API is one of 22 APIs that Yokoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invoice. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 8 operations across 6 paths, and defines 17 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}.

8 operations 6 paths 17 schemas 4 GET1 PATCH3 POST

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 Invoice 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 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Invoice 8

In the Yokoy API, invoices can only be created or retrieved. You can only update custom information via API. To update other attributes or delete the invoice, use the Yokoy web ap…

GET
/legal-entities/{legalEntityId}/invoices
List all invoices
listInvoices 6 params → 200400401403429500502503
POST
/legal-entities/{legalEntityId}/invoices
Create an invoice
createInvoice 3 params body → 201400401403429500502503
POST
/legal-entities/{legalEntityId}/invoices/einvoice
Upload a new e-invoice to Yokoy
uploadEinvoice 3 params body → 201400401403429500502503
POST
/legal-entities/{legalEntityId}/invoices/upload
Upload a new invoice to be processed by Yokoy AI
uploadAiInvoice 3 params body → 201400401403429500502503
GET
/legal-entities/{legalEntityId}/invoices/{invoiceId}
Get an invoice
getInvoice 4 params → 200401403404429500502503
PATCH
/legal-entities/{legalEntityId}/invoices/{invoiceId}
Update an invoice
updateInvoice 4 params body → 200400401403404429500502
GET
/legal-entities/{legalEntityId}/invoices/{invoiceId}/base64
Get the invoice PDF file (base64)
getInvoiceBase64 4 params → 200400401403429500502503
GET
/legal-entities/{legalEntityId}/invoices/{invoiceId}/presentation
Get the invoice file in PDF format
getInvoicePdf 4 params → 200400401403429500502503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Invoice (30 properties), InvoiceLineItem (25 properties), OneTimeSupplierInfo (11 properties), InvoiceBankAccount (7 properties). Each schema is shown below with its type and property counts.

UpdateInvoiceLineItem
object
1 property
EventLogEntry
object
5 properties
InvoiceBankAccount
object
Information related to the payment of the invoice.
7 properties
PaginationNextCursor
string
Cursor to be used to fetch the next set of items. It is only resulted in calls that pass countin the query parameters to retrieve paginated results. When there…
Invoice
object
30 properties 6 required
InvoiceQrInformation
object
Invoice QR information. Supports Swiss QR-bill.
5 properties
UpdateInvoice
object
Update the custom information associated with the invoice. Any attributes are added to existing attributes. To reset or delete a specific attribute, set it to…
2 properties
HttpError
object
2 properties 2 required
InvoiceBase64
object
2 properties
InvoiceLineItemTaxComponent
object
5 properties 2 required
InvoiceLineItem
object
25 properties 2 required
Country
string
PaginationItemsPerPage
number
Returns the number of items in the paginated result. This attribute is only included in paginated results with count.
OneTimeSupplierInfo
object
Information related to one-time vendor.
11 properties 6 required
DateString
string
Error
object
2 properties 2 required
DateRange
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yokoy-invoice-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 category API
Yokoy Invoice payment terms API