Skip to content

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/
Local development environment
http://localhost:10081/
U-DEV testing environment
https://{tenant}.u-dev.omnizon.network/api/

Register a company

Request

Accepts a JSON payload to register a company with required and optional company data.

Bodyapplication/jsonrequired
companyVatNumberstringrequired

The company's unique identifier (OIB, 11 digits).

Example: "12345678901"
companyNamestringrequired

The official name of the company.

Example: "Example Ltd."
companyAddressStreetstringrequired

Company street and street number.

Example: "Main Street 123"
companyAddressCitystringrequired

Company city.

Example: "Zagreb"
companyAddressPostalCodestringrequired

Company postal code.

Example: "10000"
companyAddressStatestringrequired

Company state.

Example: "Grad Zagreb"
companyAddressCountrystringrequired

Company country.

Example: "HR"
mpsRegisterbooleanrequired

Indicates whether MPS register required.

Example: true
emailstring

Contact email address (optional).

Example: "info@example.com"
companyWebsitestring

Website URL of the company (optional).

Example: "https://www.example.com"
ibanstring

IBAN of the company (optional).

Example: "HR1234567890123456789"
routingAddressstringrequired

Routing address for the company.

Example: "00000000000"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/organizations/register \
  -H 'Content-Type: application/json' \
  -d '{
    "companyVatNumber": "12345678901",
    "companyName": "Example Ltd.",
    "companyAddressStreet": "Main Street 123",
    "companyAddressCity": "Zagreb",
    "companyAddressPostalCode": "10000",
    "companyAddressState": "Grad Zagreb",
    "companyAddressCountry": "HR",
    "mpsRegister": true,
    "email": "info@example.com",
    "companyWebsite": "https://www.example.com",
    "iban": "HR1234567890123456789",
    "routingAddress": "00000000000"
  }'

Responses

Company registered successfully.

Bodyapplication/json
organizationIdstringrequired

Unique identifier for the organization.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "organizationId": "6787a98e15306d37eed688a8"
}

Find organization by vat number

Request

Find organization by vat number.

Bodyapplication/jsonrequired
vatNumberstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/organizations/findByVatNumber \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "string"
  }'

Responses

Company registered successfully.

Bodyapplication/json
fullNamestring
vatNumberstring
localBusinessIdstring
dunsNumberstring
glnstring
peppolIdstring
addressContactstring
addressCitystring
addressPostalCodestring
addressStatestring
addressExtraLine1string
addressExtraLine2string
addressExtraLine3string
webAddressstring
Response
application/json
{
  "fullName": "string",
  "vatNumber": "string",
  "localBusinessId": "string",
  "dunsNumber": "string",
  "gln": "string",
  "peppolId": "string",
  "addressContact": "string",
  "addressCity": "string",
  "addressPostalCode": "string",
  "addressState": "string",
  "addressExtraLine1": "string",
  "addressExtraLine2": "string",
  "addressExtraLine3": "string",
  "webAddress": "string"
}

Check AMS registration status for organization

Request

Check if an organization is registered in AMS (Asset Management System) by VAT number.

Bodyapplication/jsonrequired
vatNumberstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/organizations/amsCheck \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "string"
  }'

Responses

AMS registration status check completed successfully.

Bodyapplication/json
isAmsRegisteredbooleanrequired

Indicates whether the organization is registered in AMS (Asset Management System)

Response
application/json
{
  "isAmsRegistered": true
}

Send UBL 2.1 invoice

Request

Accepts a UBL 2.1 XML document as raw binary stream and processes it.

Headers
companyVatNumberstringrequired

VAT number of the company.

Example: HR12345678910
fiscalizationboolean

Fiscalization flag.

x-fileNamestring

Optional file name override for uploaded XML document.

x-software-idstring

External software identifier to track the originating system.

Bodyapplication/octet-streamrequired
string(binary)
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/send \
  -H 'Content-Type: application/octet-stream' \
  -H 'companyVatNumber: HR12345678910' \
  -H 'fiscalization: true' \
  -H 'x-fileName: string' \
  -H 'x-software-id: string' \
  -d '<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">...</Invoice>'

Responses

Document processed successfully.

Bodyapplication/json
documentIdstringrequired
Response
application/json
{
  "documentId": "string"
}

Get Invoice Internal Status

Request

Get Invoice Internal Status.

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/getInternalStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8"
  }'

Responses

Invoice Internal Status Returned Successfully.

Bodyapplication/json
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
statusstringrequired

Status of document.

Example: "acknowledged"
Response
application/json
{
  "documentId": "6787a98e15306d37eed688a8",
  "status": "acknowledged"
}

Get External Invoice Status

Request

Get External Invoice Status.

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/getExternalStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8"
  }'

Responses

Get external invoice status.

Bodyapplication/json
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
statusstringrequired

Status of document.

Example: "acknowledged"
Response
application/json
{
  "documentId": "6787a98e15306d37eed688a8",
  "status": "acknowledged"
}

Get Invoices By Internal Status

Request

Get Invoice By Status.

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/getByInternalStatus \
  -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 payload return models.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Invoices By External Status

Request

Get Invoice By External Status.

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 \
  -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 payload return models.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Document

Request

Get Document by documentId and return binary file.

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

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

Reject Invoice

Request

Accepts a JSON payload to Set Invoice as Reject.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
documentNumberstringrequired

The number of the document.

Example: "12322"
issueDatestring(date-time)required

The date when the invoice was issued.

Example: "2023-10-01T12:00:00Z"
senderVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
receiverVatNumberstringrequired

The VAT number of the receiver.

Example: "HR09876543210"
rejectionDatestring(date-time)required

The date when the invoice was rejected.

Example: "2023-10-02T12:00:00Z"
rejectionReasonstring

The reason for the rejection of the invoice.

Example: "Invoice not valid"
rejectionReasonCodestring= 1 charactersrequired

The code indicating the reason for rejection Can be N, U or O.

Example: "N|U|O"
rejectionReasonDescriptionstring<= 1000 characters

The description of the reason for rejection.

Example: "Invoice not valid"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/reject \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8",
    "documentNumber": "12322",
    "issueDate": "2023-10-01T12:00:00Z",
    "senderVatNumber": "HR12345678910",
    "receiverVatNumber": "HR09876543210",
    "rejectionDate": "2023-10-02T12:00:00Z",
    "rejectionReason": "Invoice not valid",
    "rejectionReasonCode": "N|U|O",
    "rejectionReasonDescription": "Invoice not valid"
  }'

Responses

Document mark as rejected 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."
}

Mark Invoice as Paid

Request

Accepts a JSON payload to Set Invoice as Paid.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
documentNumberstringrequired

The number of the document.

Example: "12322"
issueDatestring(date-time)required

The date when the invoice was issued.

Example: "2023-10-01T12:00:00Z"
senderVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
receiverVatNumberstringrequired

The VAT number of the receiver.

Example: "HR09876543210"
paidDatestring(date-time)required

The date when the invoice was paid.

Example: "2023-10-02T12:00:00Z"
paidAmountstringrequired

The amount that was paid for the invoice.

Example: "210.00"
paymentMethodstring

The method used for the payment.

Example: "T|O|Z"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/paid \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8",
    "documentNumber": "12322",
    "issueDate": "2023-10-01T12:00:00Z",
    "senderVatNumber": "HR12345678910",
    "receiverVatNumber": "HR09876543210",
    "paidDate": "2023-10-02T12:00:00Z",
    "paidAmount": "210.00",
    "paymentMethod": "T|O|Z"
  }'

Responses

Document mark as paid 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."
}

Cancel Invoice

Request

Accepts a JSON payload to Set Invoice as Cancel.

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

Create a new user

Request

Accepts a JSON payload to register a new user with required and optional user data.

Bodyapplication/jsonrequired
usernamestringrequired
lastNamestring
firstNamestring
passwordstringrequired
emailstring(email)required
organizationIdstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/new \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "lastName": "string",
    "firstName": "string",
    "password": "string",
    "email": "user@example.com",
    "organizationId": "string"
  }'

Responses

User created successfully.

Bodyapplication/json
userIdstringrequired

Unique identifier for the user account.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "userId": "6787a98e15306d37eed688a8"
}

Deactivate a user account

Request

Accepts a JSON payload to deactivate a user account with required and optional user data.

Bodyapplication/jsonrequired
userIdstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/deactivate \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string"
  }'

Responses

User deactivate successfully.

Bodyapplication/json
userIdstringrequired
statusstringrequired
Response
application/json
{
  "userId": "string",
  "status": "string"
}

Reactivate a user account

Request

Accepts a JSON payload to reactivate a user account with required and optional user data.

Bodyapplication/jsonrequired
userIdstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/reactivate \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string"
  }'

Responses

User reactivate successfully.

Bodyapplication/json
userIdstringrequired
statusstringrequired
Response
application/json
{
  "userId": "string",
  "status": "string"
}

Get Document from Archive

Request

Get Document from Archive.

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 'Content-Type: application/json' \
  -d '{
    "documentId": "6787a98e15306d37eed688a8"
  }'

Responses

Successfully retrieved invoice as binary file.

Bodyapplication/octet-stream
string(binary)

Archive Document

Request

Archive Document.

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

Get Documents By Number

Request

Get Documents By Number.

Bodyapplication/jsonrequired
documentNumberstringrequired

The number of the document.

Example: "1_2_3"
companyVatNumberstringrequired

The VAT number of the company.

Example: "HR12345678910"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getByNumber \
  -H 'Content-Type: application/json' \
  -d '{
    "documentNumber": "1_2_3",
    "companyVatNumber": "HR12345678910"
  }'

Responses

Get documents by number.

Bodyapplication/json
itemsArray of objects(InvoiceDocumentIdReturnModel)required

List of invoice payload return models.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Inbox Documents

Request

Get Inbox Documents.

Bodyapplication/jsonrequired
companyVatNumberstringrequired

The VAT number of the sender.

Example: "HR12345678910"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/inbox \
  -H 'Content-Type: application/json' \
  -d '{
    "companyVatNumber": "HR12345678910"
  }'

Responses

Get inbox documents.

Bodyapplication/json
itemsArray of objects(InvoiceDocumentIdReturnModel)required

List of invoice payload return models.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Document Statuses

Request

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

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 '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)
reportingDetailsobject(ReportingResponse)
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"
  }
}

Get Outbox Document Statuses

Request

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

Bodyapplication/jsonrequired
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/outbox/status \
  -H 'Content-Type: application/json' \
  -d '{
    "companyVatNumber": "HR12345678910",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z"
  }'

Responses

Successfully retrieved outbox document statuses.

Bodyapplication/json
itemsArray of objects(DocumentGetOutboxStatusResponse)required

List of documents inbox statuses return model.

items[].​documentIdstringrequired

The unique identifier of the invoice document.

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

The name of the receiver of the document.

Example: "Example Receiver 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[].​externalStatusstringrequired

The external status of the document.

Example: "SENT|DELIVERED|ACKNOWLEDGED"
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Inbox Document Statuses

Request

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

Bodyapplication/jsonrequired
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/inbox/status \
  -H 'Content-Type: application/json' \
  -d '{
    "companyVatNumber": "HR12345678910",
    "dateFrom": "2019-08-24T14:15:22Z",
    "dateTo": "2019-08-24T14:15:22Z"
  }'

Responses

Successfully retrieved outbox document statuses.

Bodyapplication/json
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
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
Response
application/json
{
  "items": [
    { … }
  ]
}

Get Monthly Usage Metrics

Request

Get usage metrics for documents sent, received and total for a specific month and year by VAT ID.

Bodyapplication/jsonrequired
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
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/billing/monthly-usage \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "HR12345678901",
    "year": 2025,
    "month": 3
  }'

Responses

Successfully retrieved monthly usage metrics.

Bodyapplication/jsonArray [
metricNamestringrequired

Name of the metric

Example: "documents-out"
metricUsagestringrequired

Usage value for the metric

Example: "123"
]
Response
application/json
[
  {
    "metricName": "documents-out",
    "metricUsage": "123"
  }
]

Get Archive Usage Metrics

Request

Get total archive usage in bytes for a company by VAT ID.

Bodyapplication/jsonrequired
vatNumberstringrequired

VAT number of the organization

Example: "HR12345678901"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/billing/archive-usage \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "HR12345678901"
  }'

Responses

Successfully retrieved archive usage metrics.

Bodyapplication/jsonArray [
metricNamestringrequired

Name of the metric

Example: "documents-out"
metricUsagestringrequired

Usage value for the metric

Example: "123"
]
Response
application/json
[
  {
    "metricName": "documents-out",
    "metricUsage": "123"
  }
]

Get all fiscalization statuses for a document

Request

Returns all fiscalization statuses for the specified document ID.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the document

Example: "64a1b2c3d4e5f6789012345a"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getAllFiscalizationStatuses \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "64a1b2c3d4e5f6789012345a"
  }'

Responses

Fiscalization statuses retrieved successfully.

Bodyapplication/jsonArray [
successfulboolean

Whether the fiscalization was successful

Example: true
errorMessagestring

Error message if fiscalization failed

Example: "Invalid tax rate"
errorCodestring

Error code if fiscalization failed

Example: "TAX_RATE_ERROR"
shouldRetryboolean

Whether the fiscalization should be retried

Example: false
timestampstring(date-time)

Timestamp when the fiscalization was attempted

Example: "2024-01-15T10:30:00Z"
fiscalizationRequestIdstring

Unique identifier for the fiscalization attempt

Example: "FISK-2024-001234"
fiscalizationResponseIdstring

JIR (Jedinstveni identifikator računa) number from FINA

Example: "12345678-1234-1234-1234-123456789012"
fiscalizationTypestring

Type of fiscalization process

Enum"FISCALIZATION""FISCALIZATION_REJECTION_REPORT""FISCALIZATION_PAYMENT_REPORT""FISCALIZATION_NOT_DELIVERED_REPORT"
Example: "FISCALIZATION"
]
Response
application/json
[
  {
    "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"
  }
]

Get latest fiscalization status for a document

Request

Returns the most recent fiscalization status for the specified document ID.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the document

Example: "64a1b2c3d4e5f6789012345a"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getLatestFiscalizationStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "64a1b2c3d4e5f6789012345a"
  }'

Responses

Latest fiscalization status retrieved successfully.

Bodyapplication/json
successfulboolean

Whether the fiscalization was successful

Example: true
errorMessagestring

Error message if fiscalization failed

Example: "Invalid tax rate"
errorCodestring

Error code if fiscalization failed

Example: "TAX_RATE_ERROR"
shouldRetryboolean

Whether the fiscalization should be retried

Example: false
timestampstring(date-time)

Timestamp when the fiscalization was attempted

Example: "2024-01-15T10:30:00Z"
fiscalizationRequestIdstring

Unique identifier for the fiscalization attempt

Example: "FISK-2024-001234"
fiscalizationResponseIdstring

JIR (Jedinstveni identifikator računa) number from FINA

Example: "12345678-1234-1234-1234-123456789012"
fiscalizationTypestring

Type of fiscalization process

Enum"FISCALIZATION""FISCALIZATION_REJECTION_REPORT""FISCALIZATION_PAYMENT_REPORT""FISCALIZATION_NOT_DELIVERED_REPORT"
Example: "FISCALIZATION"
Response
application/json
{
  "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"
}

Get all reporting statuses for a document

Request

Returns all reporting statuses for the specified document ID.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the document

Example: "64a1b2c3d4e5f6789012345a"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getAllReportingStatuses \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "64a1b2c3d4e5f6789012345a"
  }'

Responses

Reporting statuses retrieved successfully.

Bodyapplication/jsonArray [
successfulboolean

Whether the reporting was successful

Example: true
errorMessagestring

Error message if reporting failed

Example: "Invalid reporting format"
errorCodestring

Error code if reporting failed

Example: "FORMAT_ERROR"
shouldRetryboolean

Whether the reporting should be retried

Example: false
timestampstring(date-time)

Timestamp when the reporting was attempted

Example: "2024-01-15T10:30:00Z"
reportingRequestIdstring

Unique identifier for the reporting attempt

Example: "RPT-2024-001234"
reportingResponseIdstring

Reference number from the reporting system

Example: "REF-12345678-2024"
fiscalizationTypestring

Type of fiscalization process

Enum"FISCALIZATION""FISCALIZATION_REJECTION_REPORT""FISCALIZATION_PAYMENT_REPORT""FISCALIZATION_NOT_DELIVERED_REPORT"
Example: "FISCALIZATION"
]
Response
application/json
[
  {
    "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"
  }
]

Get latest reporting status for a document

Request

Returns the most recent reporting status for the specified document ID.

Bodyapplication/jsonrequired
documentIdstringrequired

The unique identifier of the document

Example: "64a1b2c3d4e5f6789012345a"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/documents/getLatestReportingStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "documentId": "64a1b2c3d4e5f6789012345a"
  }'

Responses

Latest reporting status retrieved successfully.

Bodyapplication/json
successfulboolean

Whether the reporting was successful

Example: true
errorMessagestring

Error message if reporting failed

Example: "Invalid reporting format"
errorCodestring

Error code if reporting failed

Example: "FORMAT_ERROR"
shouldRetryboolean

Whether the reporting should be retried

Example: false
timestampstring(date-time)

Timestamp when the reporting was attempted

Example: "2024-01-15T10:30:00Z"
reportingRequestIdstring

Unique identifier for the reporting attempt

Example: "RPT-2024-001234"
reportingResponseIdstring

Reference number from the reporting system

Example: "REF-12345678-2024"
fiscalizationTypestring

Type of fiscalization process

Enum"FISCALIZATION""FISCALIZATION_REJECTION_REPORT""FISCALIZATION_PAYMENT_REPORT""FISCALIZATION_NOT_DELIVERED_REPORT"
Example: "FISCALIZATION"
Response
application/json
{
  "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"
}

Generate API key for organization

Request

Generate a new API key for the specified organization based on VAT number

Bodyapplication/jsonrequired
vatNumberstring[ 8 .. 15 ] charactersrequired

VAT number of organization for which to generate API key

Example: "12345678901"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/apikeys/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "12345678901"
  }'

Responses

API key generated successfully

Bodyapplication/json
apiKeystring

Generated API key value (encrypted)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
Response
application/json
{
  "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}