Skip to content
/
Get 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 Invoices By External Status

Request

Get Invoice By External Status.

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
Bodyapplication/jsonrequired
statusstringrequired

One of the possible statuses of the invoice document.

Example: "rejected"
companyVatNumberstringrequired

The VAT number of the company.

Example: "HR12345678910"
dateFromstring(date-time)required

Date when an invoice was paid

dateTostring(date-time)required

Date when an invoice was paid

curl -i -X POST \
  'https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getByExternalStatus?pageNumber=1&pageSize=200' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "rejected",
    "companyVatNumber": "HR12345678910",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z"
  }'

Responses

Get invoices by status.

Bodyapplication/json
itemsArray of objects(InvoiceDocumentIdReturnModel)required

List of invoice documents.

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
}

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)

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