Skip to content
/
DocumentGetStatusRequest

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

DocumentGetStatusResponse

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

{
  "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": [
    { … }
  ]
}

DocumentGetStatusRequest

companyVatNumberstringrequired

The VAT number of the company.

Example: "HR12345678910"
dateFromstring(date-time)

Start date for document search (optional)

dateTostring(date-time)

End date for document search (optional)

{
  "companyVatNumber": "HR12345678910",
  "dateFrom": "2019-08-24T14:15:22Z",
  "dateTo": "2019-08-24T14:15:22Z"
}

DocumentGetOutboxStatusResponse

documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
supplierNamestring

The name of the document supplier/sender.

Example: "Supplier Company Ltd."
documentReceiverNamestringrequired

The name of the receiver of the document.

Example: "Example Receiver Ltd."
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"
supplierVatNumberstring

The VAT number of the document supplier.

Example: "12345678901"
customerVatNumberstring

The VAT number of the document customer.

Example: "98765432101"
supplierGlnstring

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

Example: "1234567890124"
customerGlnstring

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

Example: "1234567890125"
supplierBusinessUnitstring

The business unit of the supplier organization.

Example: "Sales Department"
customerBusinessUnitstring

The business unit of the customer organization.

Example: "Procurement Department"
amountstring

The total amount of the document.

Example: "150.75"
currencystring

The currency of the document amount.

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

The EDI type of the document from document data.

Example: "PLACEHOLDER"
{
  "documentId": "6787a98e15306d37eed688a8",
  "supplierName": "Supplier Company Ltd.",
  "documentReceiverName": "Example Receiver Ltd.",
  "documentNumber": "INV-2023-001",
  "internalStatus": "NEW|OK|FAILED",
  "externalStatus": "SENT|DELIVERED|ACKNOWLEDGED",
  "supplierVatNumber": "12345678901",
  "customerVatNumber": "98765432101",
  "supplierGln": "1234567890124",
  "customerGln": "1234567890125",
  "supplierBusinessUnit": "Sales Department",
  "customerBusinessUnit": "Procurement Department",
  "amount": "150.75",
  "currency": "EUR",
  "created": "2024-11-15T15:52:47.331Z",
  "modified": "2024-11-17T11:26:02.850Z",
  "documentEdiType": "PLACEHOLDER"
}