Skip to content
/
ArchivedDocumentResponse

Omnizon Public REST API (v1.0.0)

This is the Omnizon Platform Public REST API specification. For access and API Keys please contact your Omnizon Platform representative.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://omnizon-public-api.redocly.app/_mock/openapi
U-DEV testing environment
https://{tenant}.u-dev.omnizon.network/api

Organizations

Company registration and management operations

Operations

Documents

Invoice/document processing and status management

Operations

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas

DocumentArchiveRequest

documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
companyVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
{
  "documentId": "6787a98e15306d37eed688a8",
  "companyVatNumber": "HR12345678910"
}

ArchivedDocumentResponse

documentIdstringrequired

The unique identifier of the archived document.

Example: "6787a98e15306d37eed688a8"
statusstringrequired

Status of the archived document.

Example: "archived"
{
  "documentId": "6787a98e15306d37eed688a8",
  "status": "archived"
}

DocumentNumberRequest

documentNumberstringrequired

The number of the document.

Example: "1_2_3"
companyVatNumberstringrequired

The VAT number of the company.

Example: "HR12345678910"
issueYearstring

Issue year (4 digits, optional). If provided, filters documents created in that year.

Example: "2024"
{
  "documentNumber": "1_2_3",
  "companyVatNumber": "HR12345678910",
  "issueYear": "2024"
}