Skip to content
/
Get Document from Archive

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

Cancel Invoice

Request

Accepts a JSON payload to Set Invoice as Cancel.

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/cancel \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8",
    "reason": "Payment received"
  }'

Responses

Document canceled 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."
}

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"
}

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas