Skip to content
/
Get Inbox Documents

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

Get Inbox Documents

Request

Get Inbox Documents.

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
companyVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
dateFromstring(date-time)

Invoices after this date will be included. Max last 60 days.

dateTostring(date-time)

Invoices before this date will be included

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

Responses

Get inbox documents.

Bodyapplication/json
itemsArray of objects(DocumentInboxEnhancedResponse)required

List of enhanced inbox documents.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
items[].​documentSenderNamestringrequired

The name of the sender of the document.

Example: "Example Sender Ltd."
items[].​documentNumberstringrequired

The document number of the invoice.

Example: "INV-2023-001"
items[].​supplierVatNumberstring

The VAT number of the document supplier (optional).

Example: "12345678901"
items[].​supplierGlnstring

The GLN (Global Location Number) of the document supplier organization (optional).

Example: "1234567890124"
items[].​customerGlnstring

The GLN (Global Location Number) of the document customer organization (optional).

Example: "1234567890125"
items[].​customerNamestring

The name of the document customer.

Example: "Example Customer Ltd."
items[].​supplierBusinessUnitstring

The business unit of the supplier organization (optional).

Example: "Sales Department"
items[].​customerBusinessUnitstring

The business unit of the customer organization (optional).

Example: "Procurement Department"
items[].​amountstring

The total amount of the document (optional).

Example: "150.75"
items[].​currencystring

The currency of the document amount (optional).

Example: "EUR"
items[].​createdstring(date-time)

The document creation timestamp.

Example: "2024-11-15T15:52:47.331Z"
items[].​modifiedstring(date-time)

The document last modification timestamp.

Example: "2024-11-17T11:26:02.850Z"
items[].​customerVatNumberstring

The VAT number of the document customer (optional).

Example: "98765432101"
items[].​documentEdiTypestring

The EDI type of the document from document data.

Example: "PLACEHOLDER"
totalElementsinteger(int64)required

Total number of inbox documents

Example: 150
totalPagesintegerrequired

Total number of pages

Example: 6
sizeinteger[ 1 .. 1000 ]required

Current page size

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": 150,
  "totalPages": 6,
  "size": 25,
  "number": 1,
  "numberOfElements": 25,
  "first": true,
  "last": false,
  "empty": false
}

Get Document Statuses

Request

Get Document Statuses By VAT Number And DateFrom/To Range.

Security
PublicApiKey
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/getStatus \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8",
    "companyVatNumber": "HR12345678910"
  }'

Responses

Successfully retrieved document statuses.

Bodyapplication/json
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
documentSenderNamestringrequired

The name of the sender of the document.

Example: "Example Sender Ltd."
documentReceiverNamestringrequired

The name of the receiver of the document.

Example: "Example Receiver Ltd."
documentSenderVatNumberstringrequired

The VAT number of the sender without country prefix.

Example: "12345678910"
documentReceiverVatNumberstringrequired

The VAT number of the receiver without country prefix.

Example: "98765432100"
documentNumberstringrequired

The document number of the invoice.

Example: "INV-2023-001"
internalStatusstringrequired

The internal status of the document.

Example: "NEW|OK|FAILED"
externalStatusstringrequired

The external status of the document.

Example: "SENT|DELIVERED|ACKNOWLEDGED"
fiscalizationDetailsobject(FiscalizationResponse)

Details from the latest fiscalization attempt (optional)

reportingDetailsobject(ReportingResponse)

Details from the latest reporting attempt (optional)

internalStatusDetailsArray of objects(InternalStatusDetail)

Lista grešaka iz logRecords gdje je eventKey='generic' i eventData počinje s 'VE-'

Response
application/json
{
  "documentId": "6787a98e15306d37eed688a8",
  "documentSenderName": "Example Sender Ltd.",
  "documentReceiverName": "Example Receiver Ltd.",
  "documentSenderVatNumber": "12345678910",
  "documentReceiverVatNumber": "98765432100",
  "documentNumber": "INV-2023-001",
  "internalStatus": "NEW|OK|FAILED",
  "externalStatus": "SENT|DELIVERED|ACKNOWLEDGED",
  "fiscalizationDetails": {
    "successful": true,
    "errorMessage": "Invalid tax rate",
    "errorCode": "TAX_RATE_ERROR",
    "shouldRetry": false,
    "timestamp": "2024-01-15T10:30:00Z",
    "fiscalizationRequestId": "FISK-2024-001234",
    "fiscalizationResponseId": "12345678-1234-1234-1234-123456789012",
    "fiscalizationType": "FISCALIZATION"
  },
  "reportingDetails": {
    "successful": true,
    "errorMessage": "Invalid reporting format",
    "errorCode": "FORMAT_ERROR",
    "shouldRetry": false,
    "timestamp": "2024-01-15T10:30:00Z",
    "reportingRequestId": "RPT-2024-001234",
    "reportingResponseId": "REF-12345678-2024",
    "fiscalizationType": "FISCALIZATION"
  },
  "internalStatusDetails": [
    { … }
  ]
}

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas