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

InvoiceSetStatusRequest

documentIdstringrequired

The unique identifier of the invoice document.

Example: "6787a98e15306d37eed688a8"
reasonstring

The reason for setting the invoice status.

Example: "Payment received"
{ "documentId": "6787a98e15306d37eed688a8", "reason": "Payment received" }

InvoiceSetStatusResponse

statusCodeintegerrequired

Http status code of the response.

Example: 200
resultMessagestringrequired

Result message.

Example: "Company registered successfully."
{ "statusCode": 200, "resultMessage": "Company registered successfully." }

InvoiceRejectRequest

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: "12345678910"
receiverVatNumberstringrequired

The VAT number of the receiver.

Example: "09876543210"
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"
{ "documentId": "6787a98e15306d37eed688a8", "documentNumber": "12322", "issueDate": "2023-10-01T12:00:00Z", "senderVatNumber": "12345678910", "receiverVatNumber": "09876543210", "rejectionDate": "2023-10-02T12:00:00Z", "rejectionReason": "Invoice not valid", "rejectionReasonCode": "N|U|O", "rejectionReasonDescription": "Invoice not valid" }