# Omnizon Public REST API This is the Omnizon Platform Public REST API specification. For access and API Keys please contact your Omnizon Platform representative. Version: v1.0.0 ## Servers Local development environment ``` http://localhost:10081 ``` U-DEV testing environment ``` https://{tenant}.u-dev.omnizon.network/api ``` Variables: - `tenant` Default: "hr" Enum: "hr", "de" ## Download OpenAPI description [Omnizon Public REST API](https://omnizon-public-api.redocly.app/_bundle/openapi.yaml) ## Other ### Register a company - [POST /rest/v1/organizations/register](https://omnizon-public-api.redocly.app/openapi/other/companyregister.md): Accepts a JSON payload to register a company with required and optional company data. ### Find organization by vat number - [POST /rest/v1/organizations/findByVatNumber](https://omnizon-public-api.redocly.app/openapi/other/companyfindbyvat.md): Find organization by vat number. ### Check AMS registration status for organization - [POST /rest/v1/organizations/amsCheck](https://omnizon-public-api.redocly.app/openapi/other/organizationamscheck.md): Check if an organization is registered in AMS (Asset Management System) by VAT number. ### Send UBL 2.1 invoice - [POST /rest/v1/documents/send](https://omnizon-public-api.redocly.app/openapi/other/documentsend.md): Accepts a UBL 2.1 XML document as raw binary stream and processes it. ### Get Invoice Internal Status - [POST /rest/v1/documents/getInternalStatus](https://omnizon-public-api.redocly.app/openapi/other/getinternalinvoicestatus.md): Get Invoice Internal Status. ### Get External Invoice Status - [POST /rest/v1/documents/getExternalStatus](https://omnizon-public-api.redocly.app/openapi/other/getexternalinvoicestatus.md): Get External Invoice Status. ### Get Invoices By Internal Status - [POST /rest/v1/documents/getByInternalStatus](https://omnizon-public-api.redocly.app/openapi/other/getbyinternalstatus.md): Get Invoice By Status. ### Get Invoices By External Status - [POST /rest/v1/documents/getByExternalStatus](https://omnizon-public-api.redocly.app/openapi/other/getbyexternalstatus.md): Get Invoice By External Status. ### Get Document - [POST /rest/v1/documents/get](https://omnizon-public-api.redocly.app/openapi/other/get.md): Get Document by documentId and return binary file. ### Acknowledge Invoice - [POST /rest/v1/documents/ack](https://omnizon-public-api.redocly.app/openapi/other/acknowledgeinvoice.md): Accepts a JSON payload to Set Invoice as Acknowledge. ### Reject Invoice - [POST /rest/v1/documents/reject](https://omnizon-public-api.redocly.app/openapi/other/rejectinvoice.md): Accepts a JSON payload to Set Invoice as Reject. ### Mark Invoice as Paid - [POST /rest/v1/documents/paid](https://omnizon-public-api.redocly.app/openapi/other/markpaidinvoice.md): Accepts a JSON payload to Set Invoice as Paid. ### Cancel Invoice - [POST /rest/v1/documents/cancel](https://omnizon-public-api.redocly.app/openapi/other/cancelinvoice.md): Accepts a JSON payload to Set Invoice as Cancel. ### Create a new user - [POST /rest/v1/users/new](https://omnizon-public-api.redocly.app/openapi/other/createuser.md): Accepts a JSON payload to register a new user with required and optional user data. ### Deactivate a user account - [POST /rest/v1/users/deactivate](https://omnizon-public-api.redocly.app/openapi/other/deactivateuser.md): Accepts a JSON payload to deactivate a user account with required and optional user data. ### Reactivate a user account - [POST /rest/v1/users/reactivate](https://omnizon-public-api.redocly.app/openapi/other/reactivateuser.md): Accepts a JSON payload to reactivate a user account with required and optional user data. ### Get Document from Archive - [POST /rest/v1/documents/getFromArchive](https://omnizon-public-api.redocly.app/openapi/other/getfromarchive.md): Get Document from Archive. ### Archive Document - [POST /rest/v1/documents/archive](https://omnizon-public-api.redocly.app/openapi/other/archive.md): Archive Document. ### Get Documents By Number - [POST /rest/v1/documents/getByNumber](https://omnizon-public-api.redocly.app/openapi/other/getbynumber.md): Get Documents By Number. ### Get Inbox Documents - [POST /rest/v1/documents/inbox](https://omnizon-public-api.redocly.app/openapi/other/inbox.md): Get Inbox Documents. ### Get Document Statuses - [POST /rest/v1/documents/getStatus](https://omnizon-public-api.redocly.app/openapi/other/getstatus.md): Get Document Statuses By VAT Number And DateFrom/To Range. ### Get Outbox Document Statuses - [POST /rest/v1/documents/outbox/status](https://omnizon-public-api.redocly.app/openapi/other/getoutboxstatus.md): Get Outbox Document Statuses By VAT Number And DateFrom/To Range. ### Get Inbox Document Statuses - [POST /rest/v1/documents/inbox/status](https://omnizon-public-api.redocly.app/openapi/other/getinboxstatus.md): Get Inbox Document Statuses By VAT Number And DateFrom/To Range. ### Get Monthly Usage Metrics - [POST /rest/v1/billing/monthly-usage](https://omnizon-public-api.redocly.app/openapi/other/getmonthlyusage.md): Get usage metrics for documents sent, received and total for a specific month and year by VAT ID. ### Get Archive Usage Metrics - [POST /rest/v1/billing/archive-usage](https://omnizon-public-api.redocly.app/openapi/other/getarchiveusage.md): Get total archive usage in bytes for a company by VAT ID. ### Get all fiscalization statuses for a document - [POST /rest/v1/documents/getAllFiscalizationStatuses](https://omnizon-public-api.redocly.app/openapi/other/getallfiscalizationstatuses.md): Returns all fiscalization statuses for the specified document ID. ### Get latest fiscalization status for a document - [POST /rest/v1/documents/getLatestFiscalizationStatus](https://omnizon-public-api.redocly.app/openapi/other/getlatestfiscalizationstatus.md): Returns the most recent fiscalization status for the specified document ID. ### Get all reporting statuses for a document - [POST /rest/v1/documents/getAllReportingStatuses](https://omnizon-public-api.redocly.app/openapi/other/getallreportingstatuses.md): Returns all reporting statuses for the specified document ID. ### Get latest reporting status for a document - [POST /rest/v1/documents/getLatestReportingStatus](https://omnizon-public-api.redocly.app/openapi/other/getlatestreportingstatus.md): Returns the most recent reporting status for the specified document ID. ### Generate API key for organization - [POST /rest/v1/apikeys/generate](https://omnizon-public-api.redocly.app/openapi/other/generateapikey.md): Generate a new API key for the specified organization based on VAT number