Skip to content
/
Get Archive Usage Metrics

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

Get Monthly Usage Metrics

Request

Get usage metrics for documents sent, received and total for a specific month and year by VAT ID.

Security
PublicApiKey
Bodyapplication/jsonrequired
vatNumberstringrequired

VAT number of the organization

Example: "HR12345678901"
yearinteger[ 2020 .. 2100 ]required

Year for which usage is requested

Example: 2025
monthinteger[ 1 .. 12 ]required

Month for which usage is requested (1-12)

Example: 3
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/billing/monthly-usage \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "HR12345678901",
    "year": 2025,
    "month": 3
  }'

Responses

Successfully retrieved monthly usage metrics.

Bodyapplication/jsonArray [
metricNamestringrequired

Name of the metric

Example: "documents-out"
metricUsagestringrequired

Usage value for the metric

Example: "123"
]
Response
application/json
[
  {
    "metricName": "documents-out",
    "metricUsage": "123"
  }
]

Get Archive Usage Metrics

Request

Get total archive usage in bytes for a company by VAT ID.

Security
PublicApiKey
Bodyapplication/jsonrequired
vatNumberstringrequired

VAT number of the organization

Example: "HR12345678901"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/billing/archive-usage \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "HR12345678901"
  }'

Responses

Successfully retrieved archive usage metrics.

Bodyapplication/jsonArray [
metricNamestringrequired

Name of the metric

Example: "documents-out"
metricUsagestringrequired

Usage value for the metric

Example: "123"
]
Response
application/json
[
  {
    "metricName": "documents-out",
    "metricUsage": "123"
  }
]

ApiKeys

API key generation and management

Operations

Schemas

Schemas