Skip to content
/
Archive Document

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

Get Document from Archive

Request

Get Document from Archive.

Security
PublicApiKey
Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getFromArchive \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8"
  }'

Responses

Successfully retrieved invoice as binary file.

Bodyapplication/octet-stream
string(binary)

Archive Document

Request

Archive Document.

Security
PublicApiKey
Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
companyVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/archive \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8",
    "companyVatNumber": "HR12345678910"
  }'

Responses

Document archived successfully.

Bodyapplication/json
documentIdstringrequired

The unique identifier of the archived document.

Example: "6787a98e15306d37eed688a8"
statusstringrequired

Status of the archived document.

Example: "archived"
Response
application/json
{
  "documentId": "6787a98e15306d37eed688a8",
  "status": "archived"
}

Get Documents By Number

Request

Get Documents By Number with optional pagination.

Security
PublicApiKey
Query
pageNumberinteger>= 1

Page number (starting from 1)

Default 1
Example: pageNumber=1
pageSizeinteger[ 1 .. 1000 ]

Number of items per page

Default 50
Example: pageSize=200
sortBystring

Field name to sort by. Defaults to 'created' if not specified.

Example: sortBy=created
sortDirectionstring

Sorting direction. Defaults to 'desc' if not specified.

Enum"asc""desc"
Example: sortDirection=desc
Bodyapplication/jsonrequired
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"
curl -i -X POST \
  'https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getByNumber?pageNumber=1&pageSize=200&sortBy=created&sortDirection=desc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentNumber": "1_2_3",
    "companyVatNumber": "HR12345678910",
    "issueYear": "2024"
  }'

Responses

Documents retrieved successfully with pagination metadata.

Bodyapplication/json
itemsArray of objects(InvoiceDocumentIdReturnModel)required

List of documents found by document number.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
totalElementsinteger(int64)>= 0required

Total number of documents found across all pages

Example: 47
totalPagesinteger>= 0required

Total number of pages available

Example: 2
sizeinteger[ 1 .. 1000 ]required

Current page size (number of items per page)

Example: 25
numberinteger>= 1required

Current page number (1-based)

Example: 1
numberOfElementsinteger>= 0required

Number of elements in current page

Example: 25
firstbooleanrequired

Whether this is the first page

Example: true
lastbooleanrequired

Whether this is the last page

Example: false
emptybooleanrequired

Whether the page is empty

Example: false
Response
application/json
{
  "items": [
    { … }
  ],
  "totalElements": 47,
  "totalPages": 2,
  "size": 25,
  "number": 1,
  "numberOfElements": 25,
  "first": true,
  "last": false,
  "empty": false
}

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas