Skip to content
/
UserAccountRequest

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

InvoicePaidRequest

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"
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"
{
  "documentId": "6787a98e15306d37eed688a8",
  "documentNumber": "12322",
  "issueDate": "2023-10-01T12:00:00Z",
  "senderVatNumber": "12345678910",
  "receiverVatNumber": "09876543210",
  "paidDate": "2023-10-02T12:00:00Z",
  "paidAmount": "210.00",
  "paymentMethod": "T|O|Z"
}

UserAccountRequest

usernamestringrequired
lastNamestring
firstNamestring
passwordstringrequired
emailstring(email)required
organizationIdstring
vatNumberstring
{
  "username": "string",
  "lastName": "string",
  "firstName": "string",
  "password": "string",
  "email": "user@example.com",
  "organizationId": "string",
  "vatNumber": "string"
}

UserAccountResponse

userIdstringrequired

Unique identifier for the user account.

Example: "6787a98e15306d37eed688a8"
{
  "userId": "6787a98e15306d37eed688a8"
}