Skip to content
/
Get PDF Document

Omnizon Public REST API (v 2026.03.01)

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

Request

Get Document by documentId and return binary file.

Security
PublicApiKey
Headers
x-software-idstring

External software identifier to track which ERP has fetched this document.

Bodyapplication/jsonrequired
documentIdstring

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
companyVatNumberstringrequired

The VAT number of the company.

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

Responses

Successfully retrieved invoice as binary file.

Bodyapplication/octet-stream
string(binary)

Get PDF Document

Request

Get PDF attachment by documentId and return the PDF file.

Security
PublicApiKey
Headers
x-software-idstring

External software identifier to track which ERP has fetched this document.

Bodyapplication/jsonrequired
documentIdstring

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
companyVatNumberstringrequired

The VAT number of the company.

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

Responses

Successfully retrieved PDF document.

Bodyapplication/pdf
string(binary)

Acknowledge Invoice

Request

Accepts a JSON payload to Set Invoice as Acknowledge.

Security
PublicApiKey
Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
reasonstring

The reason for setting the invoice status.

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

Responses

Document acknowledged successfully.

Bodyapplication/json
statusCodeintegerrequired

Http status code of the response.

Example: 200
resultMessagestringrequired

Result message.

Example: "Company registered successfully."
Response
application/json
{
  "statusCode": 200,
  "resultMessage": "Company registered successfully."
}

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas