Skip to content
/
DocumentInboxStatusListRe...

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

ApiKeys

API key generation and management

Operations

Schemas

Schemas

DocumentGetInboxStatusResponse

documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
documentSenderNamestringrequired

The name of the sender of the document.

Example: "Example Sender Ltd."
documentNumberstringrequired

The document number of the invoice.

Example: "INV-2023-001"
internalStatusstringrequired

The internal status of the document.

Example: "NEW|OK|FAILED"
externalStatusobject(FiscalizationResponseModel)required

Response returned by the fiscalization service.

externalStatus.​responseIdstringrequired

Identifier of the response received from the fiscalization service.

Example: "resp-879812"
externalStatus.​requestIdstringrequired

Identifier of the fiscalization request sent.

Example: "req-123456"
externalStatus.​responseDateTimestring(date-time)required

Timestamp from the fiscalization response.

Example: "2025-07-21T10:15:30Z"
externalStatus.​successfulbooleanrequired

Indicates if the fiscalization was successful.

Example: true
externalStatus.​errorCodestring

Error code returned if the fiscalization failed.

Example: "ERR_FIS_1001"
externalStatus.​errorMessagestring

Error message returned if the fiscalization failed.

Example: "Invalid taxpayer ID."
externalStatus.​invalidRecordNumberinteger(int64)

Index of the invalid record in the request.

Example: 3
externalStatus.​retryRecommendedbooleanrequired

Indicates whether a retry is recommended.

Example: false
supplierVatNumberstring

The VAT number of the document supplier (optional).

Example: "12345678901"
supplierGlnstring

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

Example: "1234567890124"
customerGlnstring

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

Example: "1234567890125"
customerNamestring

The name of the document customer.

Example: "Example Customer Ltd."
supplierBusinessUnitstring

The business unit of the supplier organization (optional).

Example: "Sales Department"
customerBusinessUnitstring

The business unit of the customer organization (optional).

Example: "Procurement Department"
amountstring

The total amount of the document (optional).

currencystring

The currency of the document amount (optional).

Example: "EUR"
createdstring(date-time)

The document creation timestamp.

Example: "2024-11-15T15:52:47.331Z"
modifiedstring(date-time)

The document last modification timestamp.

Example: "2024-11-17T11:26:02.850Z"
customerVatNumberstring

The VAT number of the document customer (optional).

Example: "98765432101"
documentEdiTypestring

The EDI type of the document from document data.

Example: "PLACEHOLDER"
{
  "documentId": "6787a98e15306d37eed688a8",
  "documentSenderName": "Example Sender Ltd.",
  "documentNumber": "INV-2023-001",
  "internalStatus": "NEW|OK|FAILED",
  "externalStatus": {
    "responseId": "resp-879812",
    "requestId": "req-123456",
    "responseDateTime": "2025-07-21T10:15:30Z",
    "successful": true,
    "errorCode": "ERR_FIS_1001",
    "errorMessage": "Invalid taxpayer ID.",
    "invalidRecordNumber": 3,
    "retryRecommended": false
  },
  "supplierVatNumber": "12345678901",
  "supplierGln": "1234567890124",
  "customerGln": "1234567890125",
  "customerName": "Example Customer Ltd.",
  "supplierBusinessUnit": "Sales Department",
  "customerBusinessUnit": "Procurement Department",
  "amount": "string",
  "currency": "EUR",
  "created": "2024-11-15T15:52:47.331Z",
  "modified": "2024-11-17T11:26:02.850Z",
  "customerVatNumber": "98765432101",
  "documentEdiType": "PLACEHOLDER"
}

DocumentInboxStatusListResponse

itemsArray of objects(DocumentGetInboxStatusResponse)required

List of documents inbox statuses return model.

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[].​internalStatusstringrequired

The internal status of the document.

Example: "NEW|OK|FAILED"
items[].​externalStatusobject(FiscalizationResponseModel)required

Response returned by the fiscalization service.

items[].​externalStatus.​responseIdstringrequired

Identifier of the response received from the fiscalization service.

Example: "resp-879812"
items[].​externalStatus.​requestIdstringrequired

Identifier of the fiscalization request sent.

Example: "req-123456"
items[].​externalStatus.​responseDateTimestring(date-time)required

Timestamp from the fiscalization response.

Example: "2025-07-21T10:15:30Z"
items[].​externalStatus.​successfulbooleanrequired

Indicates if the fiscalization was successful.

Example: true
items[].​externalStatus.​errorCodestring

Error code returned if the fiscalization failed.

Example: "ERR_FIS_1001"
items[].​externalStatus.​errorMessagestring

Error message returned if the fiscalization failed.

Example: "Invalid taxpayer ID."
items[].​externalStatus.​invalidRecordNumberinteger(int64)

Index of the invalid record in the request.

Example: 3
items[].​externalStatus.​retryRecommendedbooleanrequired

Indicates whether a retry is recommended.

Example: false
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).

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)>= 0required

Total number of inbox documents

Example: 150
totalPagesinteger>= 0required

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

MonthlyUsageRequest

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
{
  "vatNumber": "HR12345678901",
  "year": 2025,
  "month": 3
}