Home
eKasa Spec v1.7
Overview
Objective
The purpose of this document is to provide POS with a single API to communicate with PPEKK.
Glossary
| Term | Description |
|---|---|
| POS | Point of Sale. This is the cash register, AKA Sale system. This term may |
| refer to the hardware or the software of the POS. | |
| PPEKK | POS |
| eKasa | Point of Interaction. This is the eKasa server. |
General Requirements and Limitations
- The eKasa must be able to listen to HTTP request (i.e., the eKasa is the server).
- The POS is the client. It sends the request to the eKasa. The eKasa gets the response.
- The request/response protocol between the POS and the eKasa will be based on HTTP.
- The HTTP body will be in JSON format. This document will focus on the JSON messages that are sent in the HTTP body.
Communication PPEKK to CHDU
PPEKK and CHDU form one unit, the CHDU is connected directly to RS232 port of the printer therefore all print documents must pass through the CHDU device where they are saved. ECR/POS runs PPEKK as a system service and this service listens for HTTP requests of ECR/POS software. PPEKK then translates these requests to serial communication of CHDU.
Uploading data using GUI
On Android devices, starting with OS version 5.1, you can upload merchant data using application UI:
- Put authentication and identification data into public Download directory.
Data must be named
ekasa_auth_data.xmlandekasa_ident_data.xmlrespectively. - In eKasa GUI, tap on the "Nahrať dáta do eKasa" in the side menu and then press the "Načítať údaje" button.
- If the files were loaded, they must be unlocked by entering their password.
- If the password was correct, successful activation message appears and the eKasa is ready to be used.
Consistency check mechanism
EKasa implementation holds all data on CHDU and it performs the consistency check process during startup and while it is running. When CHDU data are inconsistent (e.g., CHDU is missing of eKasa cannot read the certificate) eKasa does not allow any clients HTTP requests.
External system interface
External systems, e.g. POS/ECR, can communicate with eKasa implementation using the same HTTP protocol.
eKasa Protocol
By default, eKasa runs on port 13083 using plain HTTP protocol.
First request
If the eKasa runs on the same device as the POS app, it is recommended to check if the eKasa server is running.
To check if the server is running, it is recommended to try opening a network socket.
Examples for Android OS:
Checking that the server is reachable:
try {
Socket socket = new Socket("127.0.0.1", 13083);
socket.close();
} catch (IOException e) {
return false; // not reachable
}
return true; // reachable
On Android API <= 22 you can check that the app itself is running:
final List<ActivityManager.RunningAppProcessInfo> procInfos =
activityManager.getRunningAppProcesses();
if (procInfos != null) {
for (final ActivityManager.RunningAppProcessInfo processInfo : procInfos) {
if (processInfo.processName.equals(eKasaPackageName)) {
return true;
}
}
}
return false;
If the app is not running, start it by sending the launch intent:
Intent startIntent =
activity.getPackageManager().getLaunchIntentForPackage(eKasaPackageName);
startIntent.putExtra("HIDE_AFTER_INIT", true);
activity.startActivity();
When the app starts, it will hide automatically. When starting the app on older devices (Android 4), the user must minimize the app by pressing the hide button.
Mandatory HTTP Request Headers
Content-Type: application/json
Content-Length: 454
Accept-Charset: utf-8
## HTTP Request Example
## Mandatory HTTP Response Headers
## HTTP Response Example
Default data type format in responses
- All
date-timeobjects use formatdd.MM.yyyy HH:mm:ssby default. - Each response contains a
resultCodeobject with the operation result. For more info see the [Result codes] section.
Result codes
The resultCode is the primary indicator of the outcome of an API call. Always
check the resultCode to determine the type and validity of the response.
Result code 0 means a successful operation, the list of possible codes is
shown below.
| Result | Result code | Result code description |
|---|---|---|
| 0 | OK | The request was successfully completed |
| 100 | PRINTER_NOT_READY | Printer is not ready to print The reason might be |
| technical failure or overheat problem | ||
| 101 | PRINT_FAILED | Printer is unable to print the given data |
| 102 | PRINTER_NOT_CONNECTED | Printer isn't connected or turned on |
| 103 | COMMUNICATION_ERROR | Cannot communicate with the printer |
| 104 | PRINTER_NOT_SET | No printer is defined |
| 105 | NO_PAPER | The printer has no paper |
| 106 | PARTIAL_PRINT | Only part of the data have been printed. Please, see |
PartialPrintInfo for the reason. Then you can continue printing from specified |
||
| offset. | ||
| 200 | CHDU_NOT_CONNECTED | CHDU has been disconnected |
| 201 | CHDU_IO_ERROR | Cannot communicate with CHDU device |
| 202 | CHDU_WRITE_LIMIT | Reached maximum written size |
| 203 | CHDU_RECORD_SIZE_LIMIT | Record exceeds max allowed size |
| 300 | BUSY | The app processes another request Try the request again later. |
| 400 | MERCHANT_WRONG_FORMAT | Merchant data contains wrongly formatted |
| identification data fields See the errorMessage field in the response |
||
| object for more info. | ||
| 401 | MERCHANT_DIFFERENT_DIC | The CHDU has been initialized with merchant with |
| different DIC | ||
| 402 | MERCHANT_CERTIFICATE_ERROR | Cannot read merchant certificate |
| 403 | MERCHANT_WRONG_PASSWORD_OR_CORRUPTED_FILE | Merchant auth data password is |
| wrong or the provided auth data are corrupted | ||
| 404 | MERCHANT_PARSE_ERROR | Cannot parse auth and identification data |
| 405 | MERCHANT_CERTIFICATE_EXPIRED | Merchant certificate is expired |
| 500 | NO_FIX_NEEDED | Last stored request is valid. |
| 501 | LAST_REQUEST_INVALID | Last stored request in CHDU is not valid. A fix is |
| required. | ||
| 502 | INCORRECT_TIME | Either the time on the device is not correctly set or the |
| document creation time is incorrect. | ||
| 503 | REQUEST_PARSE_ERROR | Cannot create the request message to SFS It usually |
| means that the data in the CHDU are corrupted. | ||
| 504 | RESPONSE_PARSE_ERROR | Cannot create the response message from SFS It |
| usually means that the data in the CHDU are corrupted. | ||
| 505 | NOTHING_TO_PRINT | When the document to print is null |
| 506 | NOT_FOUND | The requested document wasn't found |
| 507 | DOCUMENT_NOT_PRINTED | The document was successfully stored, but not printed |
| due to a printer error See the printer error code. |
||
| 508 | LAST_DOCUMENT_NOT_PRINTED | Last stored document must be printed first |
| 600 | SFS_COMMUNICATION_ERROR | Cannot communicate with the SFS |
| 601 | REQUEST_ALREADY_SENT | Returned when the document has been already sent to |
| the SFS | ||
| 602 | VERIFICATION_ERROR | Request or response data cannot be verified. |
| 700 | MALFORMED_INPUT | The request has invalid JSON structure |
| 701 | INVALID_INPUT | The request validation failed See the errorMessage field |
| in the response object for more info. | ||
| -1 | UNKNOWN_ERROR | A generic undocumented error See the errorMessage field |
| in the response object for more info. |
Servers
| Description | URL |
|---|---|
| / | / |
Cash
POST /api/cash
Cash deposit/withdraw
Description
Create cash deposit or withdraw. Cash documents are mandatory to print and must be sent to the SFS in time.
Request body
json
{
"amount": 100
}
json
{
"amount": 100,
"openDrawer": true
}
json
{
"amount": -100
}
json
{
"amount": -100,
"openDrawer": true
}
Schema of the request body
json
{
"required": [
"amount"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "External id from external software"
},
"printer": {
"$ref": "#/components/schemas/Printer"
},
"amount": {
"type": "number",
"description": "Cash in/out to/from cashier. Positive value means deposit, negative withdraw.",
"example": 100
},
"exception": {
"type": "boolean",
"description": "If set to `true`, the merchant has granted an exception from sending data from ORP to eKasa system."
},
"openDrawer": {
"type": "boolean",
"description": "If set to `true`, a cash drawer will be opened while printing"
}
}
}
Response 200 OK
json
{
"resultCode": 0,
"cash": {
"internalDocumentId": 100,
"sequenceId": 101,
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"exception": false,
"electronic": false,
"documentNumber": "202509/1",
"sendingCount": 1,
"qrCode": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB:88812345678900001:250903165601:101:10.00",
"status": {
"warning": {
"warningType": "EKASA",
"message": "Offline document",
"detail": "Document was printed as offline document and will be sent later"
}
}
}
}
json
{
"resultCode": 0,
"cash": {
"internalDocumentId": 100,
"sequenceId": 101,
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"exception": false,
"electronic": false,
"documentNumber": "202509/1",
"sendingCount": 1,
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"status": {}
}
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"cash": {
"$ref": "#/components/schemas/Cash"
},
"printResultCode": {
"type": "integer",
"description": "Result code of the print. Present if print ended up with an error.",
"format": "int32",
"nullable": true,
"example": 105
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 500 Internal Server Error
json
{
"resultCode": 508,
"error": "Last document must be printed first."
}
json
{
"resultCode": 100,
"error": "Bad request: print.PrintException: Printer not ready"
}
json
{
"resultCode": 201,
"error": "Bad request: persistence.PersistenceControllerException: CHDU IO Error"
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
CHDU
GET /api/chduinfo
Get CHDU params
Description
Get information about CHDU (parameters, space)
Response 500 Internal Server Error
Other responses
json
{
"params": {
"name": "CHDU Storage",
"version": "A123",
"sn": "string"
},
"storageInfo": {
"totalBlocks": 100000,
"writtenBlocks": 3251,
"blockSize": 500
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"params": {
"$ref": "#/components/schemas/ChduParams"
},
"storageInfo": {
"$ref": "#/components/schemas/BlockStorageInfo"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Document
POST /api/document/get
Get document
Description
Get document by Identifier
Request body
json
{
"printer": {}
}
json
{
"documentBySequenceId": {
"sequenceId": 1,
"month": 12,
"year": 2024
}
}
json
{
"documentBySequenceId": {
"sequenceId": 1,
"month": 12,
"year": 2024
},
"printer": {}
}
json
{
"documentByExternalId": {
"externalId": "ABC123"
}
}
json
{
"documentByOkp": {
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB"
}
}
json
{
"documentByPkp": {
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw=="
}
}
json
{
"documentByUUID": {
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST"
}
}
Schema of the request body
json
{
"type": "object",
"properties": {
"documentByExternalId": {
"$ref": "#/components/schemas/DocumentByExternalId"
},
"documentByInternalId": {
"$ref": "#/components/schemas/DocumentByInternalId"
},
"documentByOkp": {
"$ref": "#/components/schemas/DocumentByOkp"
},
"documentByPkp": {
"$ref": "#/components/schemas/DocumentByPkp"
},
"documentBySequenceId": {
"$ref": "#/components/schemas/DocumentBySequenceId"
},
"documentByUUID": {
"$ref": "#/components/schemas/DocumentByUUID"
},
"printer": {
"$ref": "#/components/schemas/Printer"
},
"offlineDocuments": {
"type": "boolean",
"description": "For getting all documents that are offline (still not sent to eKasa)"
}
}
}
Response 200 OK
json
{
"resultCode": 0,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"documentNumber": "202509/1"
}
}
json
{
"resultCode": 0,
"document": {
"type": "VK",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 150,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentNumber": "202509/1"
}
}
json
{
"resultCode": 506,
"error": "Document not found"
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/ResponseDocument"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"printResultCode": {
"type": "integer",
"description": "Result code of the print. Present if print ended up with an error.",
"format": "int32",
"nullable": true,
"example": 105
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 500 Internal Server Error
POST /api/document/get/offline
Get offline documents
Description
Get offline documents and print report. Deprecated - use Get offline report instead.
Request body
json
{
"offlineDocumentsFilter": {
"sequenceId": 25,
"from": "2022-04-13T15:42:05.901Z",
"to": "2022-04-13T15:42:05.901Z"
},
"printer": {
"windowSize": 2500,
"printDelay": 10000
},
"offset": 72,
"limit": 217
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"type": "object",
"properties": {
"offlineDocumentsFilter": {
"$ref": "#/components/schemas/OfflineDocumentsFilter"
},
"printer": {
"$ref": "#/components/schemas/Printer"
},
"offset": {
"minimum": 0,
"type": "integer",
"description": "How many documents to skip. Used when not all document were printed in previous request.",
"format": "int32",
"default": 0
},
"limit": {
"minimum": 1,
"type": "integer",
"description": "How many documents should be returned at most. Keep in mind, that the limit is applied before the filtration.",
"format": "int32",
"default": 10000
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"document": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": {
"id": 122,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 251,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 271,
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 56,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": null,
"locationToFix": null,
"ok": true
}
}
},
"status": null
},
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 25,
"sequenceId": 179,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "e2dc4476-211b-4a30-9c90-d32704747463",
"documentId": "04658fec-cc8e-4b2e-949b-aa6f083f6d1c",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"documents": null,
"printResultCode": 105,
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/ResponseDocument"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"printResultCode": {
"type": "integer",
"description": "Result code of the print. Present if print ended up with an error.",
"format": "int32",
"nullable": true,
"example": 105
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
POST /api/document/print
Print document which is waiting to be printed
Description
If document wasn't printed normally (while being created) due to a printer error (e.g. due to printer without paper), this method must be called to print the original receipt. Without it, eKasa won't accept any request which stores data to CHDU.
Request body
Schema of the request body
json
{
"type": "object",
"properties": {
"windowSize": {
"type": "integer",
"description": "How much data can be printed at once. Use `null` for default value. Applicable only for \"Get offline report\" request on ST POS, otherwise ignored.",
"format": "int32",
"example": 2500
},
"printDelay": {
"type": "integer",
"description": "Time in milliseconds to wait for the printer to cool down after printing certain amount of data defined in `windowSize` param. Use `null` for default value. Applicable only for \"Get offline report\" request on ST POS, otherwise ignored.",
"format": "int64",
"example": 10000,
"default": 13000
}
},
"description": "Printer on which the document should be printed. Set `null` or empty for default printer."
}
Response 200 OK
json
{
"resultCode": 0
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 404 Not Found
json
{
"resultCode": 505,
"error": "No unprinted document found."
}
json
{
"resultCode": 505,
"error": "Last document was electronic."
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
Response 500 Internal Server Error
json
{
"resultCode": 0,
"warning": "string",
"error": "string",
"ekasaStatus": {
"error": {
"errorType": "PRINT",
"errorCode": 225,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": {
"id": 210,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 162,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 82,
"status": null
}
},
"status": null
},
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 168,
"sequenceId": 57,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "c0d455b6-efa1-40ae-87c1-7ec293844be8",
"documentId": "1df82c03-128d-4e74-b829-8db6602dc7ae",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
POST /api/document/send/offline
Send offline data
Description
Request to send offline documents and locations to eKasa servers
Request body
json
{
"limit": 5
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"required": [
"limit"
],
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "How many documents and locations can be sent in this batch",
"format": "int32",
"example": 5
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"resultCode": 0,
"documents": [],
"locations": []
}
json
{
"resultCode": 0,
"documents": [
{
"type": "VK",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 150,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentNumber": "202509/1"
}
],
"locations": [
{
"internalId": 100,
"other": "Taxi SPZ AB12345",
"createDate": "03.09.2025 16:56:01",
"cashRegisterCode": "88812345678900001",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"sendingCount": 2
}
]
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"partialPrintInfo": {
"$ref": "#/components/schemas/PartialPrintInfo"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
POST /api/document/store
Store document
Description
Store new document to eKasa
Request body
json
{
"type": "PD",
"amount": 10,
"documentEntries": [
{
"price": 5,
"quantity": 2,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 10
}
}
json
{
"type": "UF",
"invoiceId": "FA123456",
"amount": 200,
"payments": {
"Hotovosť EUR": 200
}
}
json
{
"type": "PD",
"amount": 9,
"documentEntries": [
{
"price": 10,
"quantity": 1,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
},
{
"price": -1,
"quantity": 1,
"name": "Vrátené obaly",
"vatRate": "VAT_0",
"itemType": "PACKING_REFUND"
}
],
"payments": {
"Hotovosť EUR": 9
}
}
json
{
"type": "PD",
"amount": 11,
"documentEntries": [
{
"price": 10,
"quantity": 1,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
},
{
"price": 1,
"quantity": 1,
"name": "Obal",
"vatRate": "VAT_0",
"itemType": "PACKING"
}
],
"payments": {
"Hotovosť EUR": 11
}
}
json
{
"type": "PD",
"amount": 10.45,
"paragonDate": "03.09.2025 16:56:02",
"paragonNumber": 1,
"documentEntries": [
{
"price": 10.45,
"quantity": 1,
"name": "Tovar",
"vatRate": "VAT_19",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 10.45
}
}
json
{
"type": "PD",
"amount": 20,
"documentEntries": [
{
"price": 100,
"quantity": 1,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE",
"voucherNumber": "123456"
},
{
"price": -80,
"quantity": 1,
"name": "Voucher",
"vatRate": "VAT_23",
"itemType": "VOUCHER",
"voucherNumber": "123456"
}
],
"payments": {
"Hotovosť EUR": 20
}
}
json
{
"type": "PD",
"amount": 1.05,
"documentEntries": [
{
"price": 1.03,
"quantity": 1,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 1.05
}
}
json
{
"type": "PD",
"amount": 10,
"documentEntries": [
{
"price": 5,
"quantity": 2,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 10
},
"header": "Custom header text",
"footer": "Printed on Dotypay eKasa"
}
json
{
"type": "PD",
"amount": 10,
"documentEntries": [
{
"price": 5,
"quantity": 2,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 10
},
"electronicReceipt": true
}
json
{
"type": "PD",
"amount": 10,
"documentEntries": [
{
"price": 5,
"quantity": 2,
"name": "Tovar",
"vatRate": "VAT_23",
"itemType": "SALE"
}
],
"payments": {
"Hotovosť EUR": 10
},
"openDrawer": true
}
Schema of the request body
json
{
"required": [
"amount",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Document type enumeration:\n\n- `PD`: Standard (pokladnicny doklad)\n- `UF`: Invoice (uhrada faktury)\n- `ND`: Invalid document used for testing purposes (neplatny dokument)\n- `VY`: Cash withdrawal (vyber)\n- `VK`: Cash deposit (vklad)",
"enum": [
"PD",
"UF",
"ND",
"VY",
"VK"
]
},
"externalId": {
"type": "string",
"description": "Id of this document in external software. Used for search purposes.",
"example": "03/02"
},
"invoiceId": {
"type": "string",
"description": "Invoice number. Required when the document type is `UF`.",
"example": "FA00001"
},
"amount": {
"type": "number",
"description": "Amount of receipt. This **is checked** against the sum of all items"
},
"paragonDate": {
"type": "string",
"description": "Issue date of a paragon. Used for paragon registration only.",
"format": "date-time"
},
"paragonNumber": {
"type": "integer",
"description": "Paragon number. Must be filled along with paragonDate.",
"format": "int32"
},
"documentEntries": {
"type": "array",
"description": "Items sold on receipt.",
"items": {
"$ref": "#/components/schemas/DocumentReceiptItem"
}
},
"payments": {
"type": "object",
"additionalProperties": {
"type": "number",
"description": "Payment types and sums used for receipt payment. This parameter sum is **NOT checked** against receipt sum."
},
"description": "Payment types and sums used for receipt payment. This parameter sum is **NOT checked** against receipt sum."
},
"header": {
"type": "string",
"description": "Custom header to print at the top of the receipt"
},
"footer": {
"type": "string",
"description": "Custom footer to print at the bottom of the receipt"
},
"printer": {
"$ref": "#/components/schemas/Printer"
},
"electronicReceipt": {
"type": "boolean",
"description": "If the client wants an electronic receipt, set this value to `true`. Receipt will not be printed only if is online. Offline receipts will always be printed."
},
"openDrawer": {
"type": "boolean",
"description": "If set to `true`, a cash drawer will be opened while printing."
},
"exception": {
"type": "boolean",
"description": "If set to `true`, the merchant has granted an exception from sending data from ORP to eKasa system.",
"default": false
}
}
}
Response 200 OK
json
{
"resultCode": 0,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"documentNumber": "202509/1"
}
}
json
{
"resultCode": 0,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB:88812345678900001:250903165601:1:10.00",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"documentNumber": "202509/1"
}
}
json
{
"resultCode": 507,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"documentNumber": "202509/1"
},
"printResultCode": 101
}
json
{
"resultCode": 507,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB:88812345678900001:250903165601:1:10.00",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"documentNumber": "202509/1"
},
"printResultCode": 101
}
json
{
"resultCode": 0,
"document": {
"type": "PD",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 10,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentEntries": [
{
"type": "SALE",
"price": 5,
"quantity": 2,
"name": "Tovar",
"totalPrice": 10,
"vatRate": "VAT_23"
}
],
"vatRateSums": [],
"paymentTypes": {
"Hotovosť EUR": 10
},
"header": "",
"footer": "",
"exception": false,
"electronic": true,
"electronicReceipt": "PNG image of the receipt in a BASE64 format",
"documentNumber": "202509/1"
}
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/ResponseDocument"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"printResultCode": {
"type": "integer",
"description": "Result code of the print. Present if print ended up with an error.",
"format": "int32",
"nullable": true,
"example": 105
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 500 Internal Server Error
POST /api/document/update
Update stuck document data
Description
Updates the stuck document record in CHDU. The request can only contain the data that needs to be fixed, i.e., it is not necessary to send all the data of the original document. See the schema for all possible attributes which may be updated.
Request body
json
{
"fixDocument": {
"useLastMerchant": true
}
}
json
{
"fixDocument": {
"createDate": "02.09.2025 16:56:02",
"issueDate": "02.09.2025 16:56:02"
}
}
json
{
"fixDocument": {
"invoiceId": "FA123456"
}
}
json
{
"fixDocument": {
"documentEntries": [
{
"name": "Fixed item name",
"quantity": 1.05
}
]
}
}
json
{
"fixDocument": {
"documentEntries": [
{},
{
"specialRegulationChange": {
"newValue": "UD"
}
}
]
}
}
Schema of the request body
json
{
"type": "object",
"properties": {
"fixDocument": {
"$ref": "#/components/schemas/FixDocument"
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"document": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": {
"id": 23,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 136,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 199,
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 9,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": null,
"locationToFix": null,
"ok": true
}
}
},
"status": null
},
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 151,
"sequenceId": 216,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "1e49a883-87bf-49eb-ab5c-00c93ca5fc86",
"documentId": "b87b7e32-1ce1-4acb-aec3-53b904d5aa84",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"documents": null,
"printResultCode": 105,
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/ResponseDocument"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"printResultCode": {
"type": "integer",
"description": "Result code of the print. Present if print ended up with an error.",
"format": "int32",
"nullable": true,
"example": 105
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Location
GET /api/location/get
Get last location
Response 200 OK
json
{
"location": {
"internalId": 140,
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": {
"id": 170,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": null,
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": null
},
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 283,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": null,
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 173,
"sequenceId": 121,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "538c8434-24e4-499f-abee-9df82a35ac1c",
"documentId": "5b47fccd-d16f-4a3e-91f1-a087f814442e",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
},
"sendingCount": 252,
"status": null
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/Location"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 404 Not Found
json
{
"resultCode": 506,
"error": "Location not found"
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
Response 500 Internal Server Error
json
{
"resultCode": 0,
"warning": "string",
"error": "string",
"ekasaStatus": {
"error": {
"errorType": "PRINT",
"errorCode": 228,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": {
"id": 237,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 46,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 257,
"status": null
}
},
"status": null
},
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 293,
"sequenceId": 45,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "fc25c1ad-85b6-44dd-a5e5-98a279fa33ba",
"documentId": "ca612746-eb19-4e3d-bdc8-e81162e3777e",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
POST /api/location/update
Update location
Description
Update cash register location
Request body
json
{
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
json
{
"gps": {
"x": 17.112415,
"y": 48.1467828
}
}
json
{
"other": "Taxi SPZ AB12345"
}
json
{
"fixLocation": {
"createDate": "03.09.2025 16:56:02",
"gps": {
"x": 17.1427408,
"y": 48.1455817
},
"useLastMerchant": true
}
}
Schema of the request body
json
{
"type": "object",
"properties": {
"physicalAddress": {
"$ref": "#/components/schemas/PhysicalAddress"
},
"gps": {
"$ref": "#/components/schemas/Gps"
},
"other": {
"type": "string",
"description": "Other location, for example taxi licence plate"
},
"fixLocation": {
"$ref": "#/components/schemas/FixLocation"
}
},
"description": "One of the following fields must not be null: `physicalAddress`, `gps`, `other` or `fixLocation`."
}
Response 500 Internal Server Error
Other responses
json
{
"location": {
"internalId": 252,
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": {
"id": 293,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": null,
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": null
},
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 54,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": null,
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 175,
"sequenceId": 236,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "42a1c68d-284f-4dc4-a736-c37444d3ba05",
"documentId": "31ef87d9-c306-4a6c-a7de-1412d17431f6",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
},
"sendingCount": 141,
"status": null
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/Location"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Merchant
POST /api/merchant/get
Get merchant
Request body
json
{
"merchantBySequenceId": {
"id": 1
},
"merchantByCashRegisterCode": {
"cashRegisterCode": "88812345678900001"
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"type": "object",
"properties": {
"merchantBySequenceId": {
"$ref": "#/components/schemas/MerchantBySequenceId"
},
"merchantByCashRegisterCode": {
"$ref": "#/components/schemas/MerchantByCashRegisterCode"
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"merchant": {
"id": 135,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 13,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 97,
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 170,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": null,
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 223,
"sequenceId": 274,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "4f3c1f22-abe9-47f0-b14e-336de1e67074",
"documentId": "b0753f89-49f1-4344-b80e-12a239a98043",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
}
},
"status": null
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"merchant": {
"$ref": "#/components/schemas/Merchant"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
GET /api/merchant/status
Get merchant status
Description
Get merchant's certificate status:
- expiration date,
- whether or not to show a warning message.
Response 500 Internal Server Error
Other responses
json
{
"status": {
"expirationDate": "2022-04-13T15:42:05.901Z",
"status": "OK"
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/MerchantCertificateStatus"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
POST /api/image/store
Store merchant logo
Description
Store merchant image which will be printed on receipts
Request body
json
{
"imageData": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAADMSURBVFhH7ZRJDsMgDAD9id56zGP7jrwul76hkSOVUjBeMBQfOpJzCCIzWRR4LQauA8DXzILyxAr4FfECVmIKuMr3ozz9ea/EmoQ6gJNwaxKqgCQgJNyaBlvAflQSbk2DPqAh8Nw9YgqgCBHgwbd7AP+AKQHP+5ZGogp4f9UPuKkvUjIswBqRi3Fwv0QVgPREUPLuAMQS0ZK7ApBWRGtysUaOsAFIGaEdLWIAkv73irFi3lEKPXKkb9dAYgR4HmEPuS9WwOwQyhMjYCUnChgemKrC3ZUAAAAASUVORK5CYII="
}
Schema of the request body
json
{
"type": "object",
"properties": {
"imageData": {
"type": "string",
"description": "Image data. Use null remove the current image.",
"format": "BASE64"
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
POST /api/merchant/store
Store merchant
Description
Store new merchant data.
Request body
json
{
"identificationData": "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<eu:IdentityData xmlns:eu=\\\"http://financnasprava.sk/ekasa/udaje/schema/v2\\\">\\n\\t<eu:Dic>1234567890</eu:Dic>\\n\\t<eu:Ico>99999999</eu:Ico>\\n\\t<eu:CorporateBodyFullName>O.C.a.F.A. PORTABLE_DIC</eu:CorporateBodyFullName>\\n\\t<eu:OrganizationUnit>\\n\\t\\t<eu:OrganizationUnitName>nepovinný názov predajne</eu:OrganizationUnitName>\\n\\t\\t<eu:CashRegisterCode>88812345678900001</eu:CashRegisterCode>\\n\\t\\t<eu:CashRegisterType>PORTABLE</eu:CashRegisterType>\\n\\t</eu:OrganizationUnit>\\n\\t<eu:PhysicalAddress>\\n\\t\\t<eu:Country>Slovenská republika</eu:Country>\\n\\t\\t<eu:Municipality>Bratislava</eu:Municipality>\\n\\t\\t<eu:StreetName>Miletičova</eu:StreetName>\\n\\t\\t<eu:BuildingNumber>4</eu:BuildingNumber>\\n\\t\\t<eu:PropertyRegistrationNumber>22</eu:PropertyRegistrationNumber>\\n\\t\\t<eu:DeliveryAddress>\\n\\t\\t\\t<eu:PostalCode>99999</eu:PostalCode>\\n\\t\\t</eu:DeliveryAddress>\\n\\t</eu:PhysicalAddress>\\n</eu:IdentityData>",
"authenticationData": "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<eu:AuthData xmlns:eu=\\\"http://financnasprava.sk/ekasa/udaje/schema/v2\\\">\\n <eu:KeyStoreType>PKCS12</eu:KeyStoreType>\\n <eu:Data>MIITbgIBAzCCEygGCSqGSIb3DQEHAaCCExkEghMVMIITETCCBX4GCSqGSIb3DQEHAaCCBW8EggVrMIIFZzCCBWMGCyqGSIb3DQEMCgECoIIE+jCCBPYwKAYKKoZIhvcNAQwBAzAaBBR/MBZglKl5XQe7ZLoFhUEhUvMypgICBAAEggTITioyYrL8z+fZRZdQqW7v2jc/Pro8IaNclc+fzdRiHN6SWsecHT2FLtKYoAbgbPe0KakEYfj7LxloBGMUgVx7gaHghwxVkf2pwIdWgORQ5M3UMqeeMCFzV6dHOMUvoEnhejNPoUFxk/MV/RwF3V/omrYEQN5jAU/7LWWn9xvI9ANPvSRYuP6lsSUPNPsvqub0QcedbsKlxezBkAiFCBi+aAhXebmp76g1boE5ilYC6liD5bR0CeYq557Vp/2tWV9hXMTXvFDN2f24h08oNFSHus5mYWmKM5ZeOiCfzdAy9ARKzGC1sw+giYymUkgmfHwOc23XJHBn/Vk9m74J0TjE4RvbaSEV9SZBjdAwBEVzkUt8B/Q7AWwIz2fEX+yKVtByy0L4uNe29bxQ+XXw8boldoRo3PgRKgohZJuRraGMdRDGnCWUZzbJmdjrPghIJgP4qOMb7oAhHe+IkmbUjl6LrbRTYPWSiGXrazdFGr46ECvkLK3/hslfnMhVpLHHvzEQbHrkHevnpPTZJsExEwkqf3H7mE6HgqqElU5sHrrBDV/+Ef+4DeEH7RqdP9EV9Wy3mI7DO7kAg+p8hjE8DmG4vgXwhACdVn6ZVok9Zmhj4r01XqR9X7iO7MWSF8/aXJKM+DMnz4zPTBU4HJWrpiHC4wNvR94qZJhO9sObM1yyo5sRRCmDePpLmp6ndxoyOjt5TqOuuNRBRmGiNOiipGtckoV8FZXeZFu9isYiQA9U8ObI/+PJQ7oYoj6MkItC5hffOJJ2hg+X9JMeM/cRluoo3rWfGmmUKlVFQrmMrn4X9P70CvZkWIcSMcMenJqY/YIc+1uTSCbxCguCCIhw0MV8N6s6luGG/uXilY0fdtS58NkSYqsF2gJxP8AyGl7ylTWRO5uyogMdcAwXr1zhwNeacBYnFst8gb/b/nkwfmg2TXQvo5l3DUd1VeGeUanpY3tFwYb3NoOWjQPPLMSOY17mpHiRBAPSqZ0Dxdm3YvxSTZ8aly+CPH5J5/ul09ClDVAClYTJNw0dDePm/+APRulKNFyxknqsNFRhoUT0mYAD5Vv6T/koFfiRspLXZzHetKp59pMt/hifnrbR2pOEt5Na8RqZskyEN6JSvl7dlZOLb8/s7eSi4XrYM7JqBOXvNIlGJ7R1nmcQKsHEGC8N164jneFx9EtHjhQ0FBS5hO6d743HAozgiZ+WvijtIdFcjpsv/e/5K5lju89cMG6jH7MOo/fUfGqCu07NrLpZxhoUpUlX62xL1lRn4BdPpwHrMBcq5EZshFwA+VY7ilHDovC/y2rdOwPDC+WrDXTwyOI+YXNbYMMa7xoXuJexnhoMPalk5xrpCQUA4EbdW6sx3b5Rg2bZIzcsBncHhYzhLf8qPxmWC+erFnGTYI8B3OaL8yGQcrBAEvwLP1b1O7kL0c34NEjcJ7/ENwd4JVZXlDIr37qNYUYg0ERzjX18H1db5ywSCMM99cfd0UreBbfiQNH3SpeTyu0IYDi3RoyOJz+/L6lmIcPOb/OKheUCuXeMJ/0uGzQG7dqsuOqbpbOCdyfNkaJte8s/avoQklZfs1wt+5fY3TEuaIkGkiv0hz29iqLkpNwkg6aHfLB2ub/e2rFLOxuQ1pF4/EmKMVYwMQYJKoZIhvcNAQkUMSQeIgA4ADgAOAAxADIAMwA0ADUANgA3ADgAOQAwADAAMAAwADEwIQYJKoZIhvcNAQkVMRQEElRpbWUgMTU0ODkzNDU4OTE5MjCCDYsGCSqGSIb3DQEHBqCCDXwwgg14AgEAMIINcQYJKoZIhvcNAQcBMCgGCiqGSIb3DQEMAQYwGgQUEXa1MC2hctvQuNkIUGScz65lVF8CAgQAgIINOGzdDugbuy+UXtj/aSWi1qUN5xx+vZiKWyz0M7ukMeyxCHyXLDMMKGtaCWoY2fVvdUPCH7SPwhLy+uALkSDpAJC+6xL8WN+JV3QYECPOS9IhLa2HMa1mSr1Y6BfPBpW+70xdr20T+Djw2svMlrkLflxyO9JJXpCxKmIYlAEdedBYyybDViHXmjshHdTb7CVeh4rD0evZc4mrUIZG5WoXkgfRKjjS2PNYaHmfo2MXsDq287Qayu7OInW283mK9/0WI3wKoHxsncfZeUgDIbje8+IMUCnDnzw79QFzYHVsHupBfK0oG8QH6gkXKR3TgQ7U6dA0KXapN6Z3yXCFqvkucnthFaCe99EF60ve22ybuKPlpvngvDAkEY25Th/Zc5kJKbOvyft2aAfVFbSDhxbH1Y+KzR7Sgm6t2BVoNF9qcm0kyUmHExRs34COWKoVC3ETcL5DmrtZbkGHC1ciV9ipdP1BfAK1OsWK1rmdCwrK6jqwHMcJVWGTTKFyLSza2h9gaBb0sQe5+X8i5yWTYdvf3ujbC5+EawhbqeyFU30ul+R8rSbwz7PKO2HotBfI9cKy74WZ3w03Cfo1b1/t61KVr5gxtmLHvtgkDsuveodq6eAgJttNUiGlFy82qF+095hS/dmxfU7l3VcG3uclsavkW6xEMX+H/MlE1QW6ck8Y/eXIGBSDTTVi9DJDAo6Wsn8qVTXYpkVbaH4FT2wTbBJVcjw22nV+P8Itoxoguj6p7XPhb2Ie87f9QH2u4kHu3qj5RVyX5hY2XXSyNVUiQ2NrfIkS8bxWvli9d6+iGjtSXnb93EUbDj6NnH7rvFmvY+7QSnZpxgvhnWTM9SXg8nmvwi/GdQOBrRIf9g/j80c/iu/2BSuGuqae523T2xnsaPQB+nSNPe3dmnf5FagARhdHo+zxpuulk7bzliyc6twje0tkcn2FGQFk0P9ILPzAYgwy66KxONdKXJP9RN3H1g0L7Z9FV5Le09kzkAQwioDsg5VMph7QHdcyg8axzhj9QkV5dJft0uvDMJXceolCODiA6hYYvnJa/pc83WMS1HTUUhioTBo4wWALp590xh1jX67wCY5kmsbjgrBN8Hys86/YNZK+ApvafFPuTdcplbCzkoL4KzapZVMnyrXt3CihqcGdyrE3hjKMVeNXe8rk6sy2ktY3AzRQapaFkHj3zBtl6XjlYVtnngTBqyMFnkr43MiDkJ2xFekoefSYJ0Qi9+sptsvVOpHG5UxylPY5UGlTn/WXI6PWjUdBWBU7OPS38aBuBs7hCGqTLmR4q6XgL71ThlvhRCA+adq0gJAjrXfkBqBol7ohwkNNN5O3DU0OGNZnO9tZK1nafRNvoDJDiDlQj95sjK9QTIO4Qd4nzuNZQTtyM5PXgTjKfHp6JQwRJZBbb9kYRlyKvQZzQ1bA8a8R/+275dFKfxhM7desv+ooUa+SmbZtK1XESMG9uUJ/qLxUGOgGKbso4jHWw+LZaglyIc6QfbnnY90hBmInp+rJOPDovEQeLHp5ffbXZwupbIfqSv3VTRCY6U8mPA3ynF/Ienf9fP4PcTHyvgkk87Ank0fn9VpVvGfBWX7opuy9bb9Dkc9/crPPUdlHR+OMkePyp2gy8lpB6MFFbKXLEbtDNXxYfO719ojDOM4PYrplKSYh4NpdNP/HL82LTfD6EVgWInMCZ5yZSKS2lKkzVmWj8nY0b1/BFglXbunLqhblZNXgIAsKua5W5ny8ticSbeq5fkqtc2eLlu5g0bDGDK9+wc0wd3H/8Z+6DHGmGi4bnX/2wxP2a3swo2rV2ZMfQapSpfGfuY3HUqpIwBahbYKPwn2E2NOLhAYVu3W6qucXAWISMfVpj5RZ2I5WFQwVFBBl/GdlptMUTiL0LMhaDXfnyYNv4c+bmDza092LVKvieFh5/lYrNd95ogU4B6buw0m468VPiM+GJ7c/iY3B1gVYq82O0O3rYod7ctD7MwObmb0nTdo7eNsR/NHOeeWttU6ZsvFjiHO7yoNJcbrRsRTZONh3SufGgSdWUzPuR6NsptuqFomvLWHctazWUAK2iMhNt8QmY528GVVRzeYWH5AgTHF60E6CRcz6wzbHdG7AXFlVf/rR4v/l8C9zv5lV3Ss778F9mDsTzCgY6niR1OeEa97Jcxn8asgrVegtCRtdOtwDNG+8/QZmpJVx5c5orJX7ULF4sg2lLYI96RtB055OkOAqfofhApO+w+9MEfFfdZooWJxzOh/eI66x8CY0DDgFcdd7chUjRoe2Y46MdxHZnLcwCfJSZwDgQyhs33gZJI5eaVqvIW2tNj8qn11xdD+6P/BN6H2FdKbi6AXpsFAv7vyBVO6v9Y4tSYCalZxETa+J0LQiLt6H1A7rUYCco/WKLwlV/SarMfR3t8tDoUERsuho9GrDRHRwVK7zIBOKAsUOS1AEE65LZ3ed6ynM2ogOTa2rbJvmvixk9gGNc4LJmSvqHNF8GQ/XKi4iq0d6OhwFX2dYDab5nsJsR4i2AnJIr56E+bGv/RBW96DXukBpXeX4EoUl20el5fAMwKL3MGwRJWf9ZsZ7SuGByIodgch0OdAmjMhoHVQw3BkBm4ABD7guyJrU2YFxSsadpGYpzXWsZ8IWAYomAFhVTXJJlZQ7Tt2QKJZeVm1TlNDdDC5U+nVgFK2ZQUheL8satcbRrWHzvOgHzo2u6A02vkzCwrm4Ez5DAEJTqyvqjb/alT0Q7+wgMLLqL7dT2IEsHFJlXsuWDeoQO39thwSGLWdGOlY2TBpO4qcJB7OdgVKdUTRKQuOrPHqMwBW5S3bivE6UluWbJx5745zR/fjLquZCFpwrCSU1yvgqyGj6RqWCv0xl46mt0PT46FTWuDjlFl+zBrA7ScziJmHIA3JoXLHPMDMgSqHASfvDFNv0sOfwyJPFo003M6uJOEDSipVDWnMQQA4aNpxoumnYJCbciMb5t8DwoH/rCsDjiTUYP8b/Xwocs90zcRL38fl3fNtIcKt80EOtbCBI3AMMdA6GZQPDitaVJIxlEccGveu4q9xpmxXs10re7OpPAh2NAI4ezOo/etww8QVkoSmnqftRVnG9QzQ8dJIcb2FiX+P1ii1Q9aqn5uPgpg8giKSQPrYGYKEEx82jYpMFtS2z9xtDqtkt+xryF9Pp+s2M8uf/1BSQaM6FvZUq241DT4CqR8sA6bZWyO0EAGJM7QBQcXciNQihmzuXiEo5Z3hTp8+YM8y6UlNBRo/+CceUlaPvamrzLG7FQ+jZpbosDkkw3156AfswrcdF9gKHUsdfHpYVKeduLKHCqSgQfBoFJCqXuz2XTjldMmzdmideer3ZTNVMl0ayEZKbf8I8psz7081q07Jp2N3/wZeIoXkuRpmsk6mMANtOCaapfTlWXe4/Q+u06jNzpF0elG5f6YSgbmNwCaUekXLe3zRTZMBIypl0Mx9J4XAuTiVCfE4wQYJE+YFg+xpMB5eoeft8rfGT0qeSlf6JoUB/1PhjcRY0eSURX4eO1HjQ8WRpMqgty/ij5fRb3GHXZmF3oK0Hs2eOD+LhAY/77cWk08ErFIEBWOjVScBFDGDwg1uhIA152BIzD/BZ7EZvNvSQVtomt4l3ojY+4IFkz+MfXtQlbKptQOIeuFwyW+/+IIluJKPU5VKPFp+x5brqPjgWgyNgiXuykt3N943Uf02lyQUG5VLQMcBhspPXQjGm+Zp0Nk72kxG5Nd0J36BCwrhajUYTY5A32tZylfCW8wWF4Ps1lANsupyg6liWnYdyN+HpLk2bV5ZQZZMpnS235fMGmUdq1qwt2yRuBAW3OuSGsjnGVeKHePdw+Uxtyej07l2xjo7PGQ2MmQbpPMLIFgFkegyQCBYtAf3Q1S9beJIYI0Jc/3tbazo4/wFamoAGmzoECW0guSJZZiJ/qIpPM+sgJGL50lKoKdjdhhXT70WDfLGUqg4llELxIm1QbHO/CxWbpK09sU6b79uU0s5Si9vkcP+Osdpsz4+DwLZqFe5eO/S19pgdSCYwwP0v48+VAqlpN1Tr+cl8JmoK8v/kEXwA0LP0XVailozD0iFGQdsddrNO7adQq1j/jyFeUXrzxVRGdYsEz68ibN3gha1F5zywKTEpdVS0T1934knPG3gML1WjQHhC011GuZWakY5/EaJrgY6IVOSmGXlIsjeDfmPTjNMq6ZYb3QkrfHt7tlyZ5vjMw0/hbLr3fQ4E3OPy8KlJMDa8oj2h+18yn8PBuewveVhNooYUwaQmEiqNKfs7wp3sEdWWs50FZ9gv7xdtO1xIRu9kTSok7lg4n3Che9cREsJI6Yv1gyMlYygrzWxmMSaYnNkYSqqQt7lC2a4N/h6qMaJh0q4cRJ+mUHd6T0hgyQ0p/k7UOD9kP2bfyxIUX1ky6Zoc+lK67b8FsLEklHM7LPM9BeaLzXRSMWkWvnUwml+XWIgDdngSfk/AGbI6RCUODmr4MPVtLhIAsazrFrRp8cIm5tIPBDlhLtjcCFYe7nP1G/XaSp9HsjA9MCEwCQYFKw4DAhoFAAQUIRcwWzft7vcw7txJ/XfQZ+QsQa4EFIt/mfLE1RsHqwjr0LQlCxr3syVsAgIEAA==</eu:Data>\\n <eu:CertificateAlias>88812345678900001</eu:CertificateAlias>\\n</eu:AuthData>",
"keyStorePassword": "Heslo123",
"privateKeyPassword": "Heslo123"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"required": [
"authenticationData",
"identificationData",
"keyStorePassword",
"privateKeyPassword"
],
"type": "object",
"properties": {
"identificationData": {
"type": "string",
"description": "Identification data generated in clients eKasa account. XML file as string.",
"example": "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<eu:IdentityData xmlns:eu=\\\"http://financnasprava.sk/ekasa/udaje/schema/v2\\\">\\n\\t<eu:Dic>1234567890</eu:Dic>\\n\\t<eu:Ico>99999999</eu:Ico>\\n\\t<eu:CorporateBodyFullName>O.C.a.F.A. PORTABLE_DIC</eu:CorporateBodyFullName>\\n\\t<eu:OrganizationUnit>\\n\\t\\t<eu:OrganizationUnitName>nepovinný názov predajne</eu:OrganizationUnitName>\\n\\t\\t<eu:CashRegisterCode>88812345678900001</eu:CashRegisterCode>\\n\\t\\t<eu:CashRegisterType>PORTABLE</eu:CashRegisterType>\\n\\t</eu:OrganizationUnit>\\n\\t<eu:PhysicalAddress>\\n\\t\\t<eu:Country>Slovenská republika</eu:Country>\\n\\t\\t<eu:Municipality>Bratislava</eu:Municipality>\\n\\t\\t<eu:StreetName>Miletičova</eu:StreetName>\\n\\t\\t<eu:BuildingNumber>4</eu:BuildingNumber>\\n\\t\\t<eu:PropertyRegistrationNumber>22</eu:PropertyRegistrationNumber>\\n\\t\\t<eu:DeliveryAddress>\\n\\t\\t\\t<eu:PostalCode>99999</eu:PostalCode>\\n\\t\\t</eu:DeliveryAddress>\\n\\t</eu:PhysicalAddress>\\n</eu:IdentityData>"
},
"authenticationData": {
"type": "string",
"description": "Authentication data generated in clients eKasa account. XML file as string.",
"example": "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<eu:AuthData xmlns:eu=\\\"http://financnasprava.sk/ekasa/udaje/schema/v2\\\">\\n <eu:KeyStoreType>PKCS12</eu:KeyStoreType>\\n <eu:Data>MIITbgIBAzCCEygGCSqGSIb3DQEHAaCCExkEghMVMIITETCCBX4GCSqGSIb3DQEHAaCCBW8EggVrMIIFZzCCBWMGCyqGSIb3DQEMCgECoIIE+jCCBPYwKAYKKoZIhvcNAQwBAzAaBBR/MBZglKl5XQe7ZLoFhUEhUvMypgICBAAEggTITioyYrL8z+fZRZdQqW7v2jc/Pro8IaNclc+fzdRiHN6SWsecHT2FLtKYoAbgbPe0KakEYfj7LxloBGMUgVx7gaHghwxVkf2pwIdWgORQ5M3UMqeeMCFzV6dHOMUvoEnhejNPoUFxk/MV/RwF3V/omrYEQN5jAU/7LWWn9xvI9ANPvSRYuP6lsSUPNPsvqub0QcedbsKlxezBkAiFCBi+aAhXebmp76g1boE5ilYC6liD5bR0CeYq557Vp/2tWV9hXMTXvFDN2f24h08oNFSHus5mYWmKM5ZeOiCfzdAy9ARKzGC1sw+giYymUkgmfHwOc23XJHBn/Vk9m74J0TjE4RvbaSEV9SZBjdAwBEVzkUt8B/Q7AWwIz2fEX+yKVtByy0L4uNe29bxQ+XXw8boldoRo3PgRKgohZJuRraGMdRDGnCWUZzbJmdjrPghIJgP4qOMb7oAhHe+IkmbUjl6LrbRTYPWSiGXrazdFGr46ECvkLK3/hslfnMhVpLHHvzEQbHrkHevnpPTZJsExEwkqf3H7mE6HgqqElU5sHrrBDV/+Ef+4DeEH7RqdP9EV9Wy3mI7DO7kAg+p8hjE8DmG4vgXwhACdVn6ZVok9Zmhj4r01XqR9X7iO7MWSF8/aXJKM+DMnz4zPTBU4HJWrpiHC4wNvR94qZJhO9sObM1yyo5sRRCmDePpLmp6ndxoyOjt5TqOuuNRBRmGiNOiipGtckoV8FZXeZFu9isYiQA9U8ObI/+PJQ7oYoj6MkItC5hffOJJ2hg+X9JMeM/cRluoo3rWfGmmUKlVFQrmMrn4X9P70CvZkWIcSMcMenJqY/YIc+1uTSCbxCguCCIhw0MV8N6s6luGG/uXilY0fdtS58NkSYqsF2gJxP8AyGl7ylTWRO5uyogMdcAwXr1zhwNeacBYnFst8gb/b/nkwfmg2TXQvo5l3DUd1VeGeUanpY3tFwYb3NoOWjQPPLMSOY17mpHiRBAPSqZ0Dxdm3YvxSTZ8aly+CPH5J5/ul09ClDVAClYTJNw0dDePm/+APRulKNFyxknqsNFRhoUT0mYAD5Vv6T/koFfiRspLXZzHetKp59pMt/hifnrbR2pOEt5Na8RqZskyEN6JSvl7dlZOLb8/s7eSi4XrYM7JqBOXvNIlGJ7R1nmcQKsHEGC8N164jneFx9EtHjhQ0FBS5hO6d743HAozgiZ+WvijtIdFcjpsv/e/5K5lju89cMG6jH7MOo/fUfGqCu07NrLpZxhoUpUlX62xL1lRn4BdPpwHrMBcq5EZshFwA+VY7ilHDovC/y2rdOwPDC+WrDXTwyOI+YXNbYMMa7xoXuJexnhoMPalk5xrpCQUA4EbdW6sx3b5Rg2bZIzcsBncHhYzhLf8qPxmWC+erFnGTYI8B3OaL8yGQcrBAEvwLP1b1O7kL0c34NEjcJ7/ENwd4JVZXlDIr37qNYUYg0ERzjX18H1db5ywSCMM99cfd0UreBbfiQNH3SpeTyu0IYDi3RoyOJz+/L6lmIcPOb/OKheUCuXeMJ/0uGzQG7dqsuOqbpbOCdyfNkaJte8s/avoQklZfs1wt+5fY3TEuaIkGkiv0hz29iqLkpNwkg6aHfLB2ub/e2rFLOxuQ1pF4/EmKMVYwMQYJKoZIhvcNAQkUMSQeIgA4ADgAOAAxADIAMwA0ADUANgA3ADgAOQAwADAAMAAwADEwIQYJKoZIhvcNAQkVMRQEElRpbWUgMTU0ODkzNDU4OTE5MjCCDYsGCSqGSIb3DQEHBqCCDXwwgg14AgEAMIINcQYJKoZIhvcNAQcBMCgGCiqGSIb3DQEMAQYwGgQUEXa1MC2hctvQuNkIUGScz65lVF8CAgQAgIINOGzdDugbuy+UXtj/aSWi1qUN5xx+vZiKWyz0M7ukMeyxCHyXLDMMKGtaCWoY2fVvdUPCH7SPwhLy+uALkSDpAJC+6xL8WN+JV3QYECPOS9IhLa2HMa1mSr1Y6BfPBpW+70xdr20T+Djw2svMlrkLflxyO9JJXpCxKmIYlAEdedBYyybDViHXmjshHdTb7CVeh4rD0evZc4mrUIZG5WoXkgfRKjjS2PNYaHmfo2MXsDq287Qayu7OInW283mK9/0WI3wKoHxsncfZeUgDIbje8+IMUCnDnzw79QFzYHVsHupBfK0oG8QH6gkXKR3TgQ7U6dA0KXapN6Z3yXCFqvkucnthFaCe99EF60ve22ybuKPlpvngvDAkEY25Th/Zc5kJKbOvyft2aAfVFbSDhxbH1Y+KzR7Sgm6t2BVoNF9qcm0kyUmHExRs34COWKoVC3ETcL5DmrtZbkGHC1ciV9ipdP1BfAK1OsWK1rmdCwrK6jqwHMcJVWGTTKFyLSza2h9gaBb0sQe5+X8i5yWTYdvf3ujbC5+EawhbqeyFU30ul+R8rSbwz7PKO2HotBfI9cKy74WZ3w03Cfo1b1/t61KVr5gxtmLHvtgkDsuveodq6eAgJttNUiGlFy82qF+095hS/dmxfU7l3VcG3uclsavkW6xEMX+H/MlE1QW6ck8Y/eXIGBSDTTVi9DJDAo6Wsn8qVTXYpkVbaH4FT2wTbBJVcjw22nV+P8Itoxoguj6p7XPhb2Ie87f9QH2u4kHu3qj5RVyX5hY2XXSyNVUiQ2NrfIkS8bxWvli9d6+iGjtSXnb93EUbDj6NnH7rvFmvY+7QSnZpxgvhnWTM9SXg8nmvwi/GdQOBrRIf9g/j80c/iu/2BSuGuqae523T2xnsaPQB+nSNPe3dmnf5FagARhdHo+zxpuulk7bzliyc6twje0tkcn2FGQFk0P9ILPzAYgwy66KxONdKXJP9RN3H1g0L7Z9FV5Le09kzkAQwioDsg5VMph7QHdcyg8axzhj9QkV5dJft0uvDMJXceolCODiA6hYYvnJa/pc83WMS1HTUUhioTBo4wWALp590xh1jX67wCY5kmsbjgrBN8Hys86/YNZK+ApvafFPuTdcplbCzkoL4KzapZVMnyrXt3CihqcGdyrE3hjKMVeNXe8rk6sy2ktY3AzRQapaFkHj3zBtl6XjlYVtnngTBqyMFnkr43MiDkJ2xFekoefSYJ0Qi9+sptsvVOpHG5UxylPY5UGlTn/WXI6PWjUdBWBU7OPS38aBuBs7hCGqTLmR4q6XgL71ThlvhRCA+adq0gJAjrXfkBqBol7ohwkNNN5O3DU0OGNZnO9tZK1nafRNvoDJDiDlQj95sjK9QTIO4Qd4nzuNZQTtyM5PXgTjKfHp6JQwRJZBbb9kYRlyKvQZzQ1bA8a8R/+275dFKfxhM7desv+ooUa+SmbZtK1XESMG9uUJ/qLxUGOgGKbso4jHWw+LZaglyIc6QfbnnY90hBmInp+rJOPDovEQeLHp5ffbXZwupbIfqSv3VTRCY6U8mPA3ynF/Ienf9fP4PcTHyvgkk87Ank0fn9VpVvGfBWX7opuy9bb9Dkc9/crPPUdlHR+OMkePyp2gy8lpB6MFFbKXLEbtDNXxYfO719ojDOM4PYrplKSYh4NpdNP/HL82LTfD6EVgWInMCZ5yZSKS2lKkzVmWj8nY0b1/BFglXbunLqhblZNXgIAsKua5W5ny8ticSbeq5fkqtc2eLlu5g0bDGDK9+wc0wd3H/8Z+6DHGmGi4bnX/2wxP2a3swo2rV2ZMfQapSpfGfuY3HUqpIwBahbYKPwn2E2NOLhAYVu3W6qucXAWISMfVpj5RZ2I5WFQwVFBBl/GdlptMUTiL0LMhaDXfnyYNv4c+bmDza092LVKvieFh5/lYrNd95ogU4B6buw0m468VPiM+GJ7c/iY3B1gVYq82O0O3rYod7ctD7MwObmb0nTdo7eNsR/NHOeeWttU6ZsvFjiHO7yoNJcbrRsRTZONh3SufGgSdWUzPuR6NsptuqFomvLWHctazWUAK2iMhNt8QmY528GVVRzeYWH5AgTHF60E6CRcz6wzbHdG7AXFlVf/rR4v/l8C9zv5lV3Ss778F9mDsTzCgY6niR1OeEa97Jcxn8asgrVegtCRtdOtwDNG+8/QZmpJVx5c5orJX7ULF4sg2lLYI96RtB055OkOAqfofhApO+w+9MEfFfdZooWJxzOh/eI66x8CY0DDgFcdd7chUjRoe2Y46MdxHZnLcwCfJSZwDgQyhs33gZJI5eaVqvIW2tNj8qn11xdD+6P/BN6H2FdKbi6AXpsFAv7vyBVO6v9Y4tSYCalZxETa+J0LQiLt6H1A7rUYCco/WKLwlV/SarMfR3t8tDoUERsuho9GrDRHRwVK7zIBOKAsUOS1AEE65LZ3ed6ynM2ogOTa2rbJvmvixk9gGNc4LJmSvqHNF8GQ/XKi4iq0d6OhwFX2dYDab5nsJsR4i2AnJIr56E+bGv/RBW96DXukBpXeX4EoUl20el5fAMwKL3MGwRJWf9ZsZ7SuGByIodgch0OdAmjMhoHVQw3BkBm4ABD7guyJrU2YFxSsadpGYpzXWsZ8IWAYomAFhVTXJJlZQ7Tt2QKJZeVm1TlNDdDC5U+nVgFK2ZQUheL8satcbRrWHzvOgHzo2u6A02vkzCwrm4Ez5DAEJTqyvqjb/alT0Q7+wgMLLqL7dT2IEsHFJlXsuWDeoQO39thwSGLWdGOlY2TBpO4qcJB7OdgVKdUTRKQuOrPHqMwBW5S3bivE6UluWbJx5745zR/fjLquZCFpwrCSU1yvgqyGj6RqWCv0xl46mt0PT46FTWuDjlFl+zBrA7ScziJmHIA3JoXLHPMDMgSqHASfvDFNv0sOfwyJPFo003M6uJOEDSipVDWnMQQA4aNpxoumnYJCbciMb5t8DwoH/rCsDjiTUYP8b/Xwocs90zcRL38fl3fNtIcKt80EOtbCBI3AMMdA6GZQPDitaVJIxlEccGveu4q9xpmxXs10re7OpPAh2NAI4ezOo/etww8QVkoSmnqftRVnG9QzQ8dJIcb2FiX+P1ii1Q9aqn5uPgpg8giKSQPrYGYKEEx82jYpMFtS2z9xtDqtkt+xryF9Pp+s2M8uf/1BSQaM6FvZUq241DT4CqR8sA6bZWyO0EAGJM7QBQcXciNQihmzuXiEo5Z3hTp8+YM8y6UlNBRo/+CceUlaPvamrzLG7FQ+jZpbosDkkw3156AfswrcdF9gKHUsdfHpYVKeduLKHCqSgQfBoFJCqXuz2XTjldMmzdmideer3ZTNVMl0ayEZKbf8I8psz7081q07Jp2N3/wZeIoXkuRpmsk6mMANtOCaapfTlWXe4/Q+u06jNzpF0elG5f6YSgbmNwCaUekXLe3zRTZMBIypl0Mx9J4XAuTiVCfE4wQYJE+YFg+xpMB5eoeft8rfGT0qeSlf6JoUB/1PhjcRY0eSURX4eO1HjQ8WRpMqgty/ij5fRb3GHXZmF3oK0Hs2eOD+LhAY/77cWk08ErFIEBWOjVScBFDGDwg1uhIA152BIzD/BZ7EZvNvSQVtomt4l3ojY+4IFkz+MfXtQlbKptQOIeuFwyW+/+IIluJKPU5VKPFp+x5brqPjgWgyNgiXuykt3N943Uf02lyQUG5VLQMcBhspPXQjGm+Zp0Nk72kxG5Nd0J36BCwrhajUYTY5A32tZylfCW8wWF4Ps1lANsupyg6liWnYdyN+HpLk2bV5ZQZZMpnS235fMGmUdq1qwt2yRuBAW3OuSGsjnGVeKHePdw+Uxtyej07l2xjo7PGQ2MmQbpPMLIFgFkegyQCBYtAf3Q1S9beJIYI0Jc/3tbazo4/wFamoAGmzoECW0guSJZZiJ/qIpPM+sgJGL50lKoKdjdhhXT70WDfLGUqg4llELxIm1QbHO/CxWbpK09sU6b79uU0s5Si9vkcP+Osdpsz4+DwLZqFe5eO/S19pgdSCYwwP0v48+VAqlpN1Tr+cl8JmoK8v/kEXwA0LP0XVailozD0iFGQdsddrNO7adQq1j/jyFeUXrzxVRGdYsEz68ibN3gha1F5zywKTEpdVS0T1934knPG3gML1WjQHhC011GuZWakY5/EaJrgY6IVOSmGXlIsjeDfmPTjNMq6ZYb3QkrfHt7tlyZ5vjMw0/hbLr3fQ4E3OPy8KlJMDa8oj2h+18yn8PBuewveVhNooYUwaQmEiqNKfs7wp3sEdWWs50FZ9gv7xdtO1xIRu9kTSok7lg4n3Che9cREsJI6Yv1gyMlYygrzWxmMSaYnNkYSqqQt7lC2a4N/h6qMaJh0q4cRJ+mUHd6T0hgyQ0p/k7UOD9kP2bfyxIUX1ky6Zoc+lK67b8FsLEklHM7LPM9BeaLzXRSMWkWvnUwml+XWIgDdngSfk/AGbI6RCUODmr4MPVtLhIAsazrFrRp8cIm5tIPBDlhLtjcCFYe7nP1G/XaSp9HsjA9MCEwCQYFKw4DAhoFAAQUIRcwWzft7vcw7txJ/XfQZ+QsQa4EFIt/mfLE1RsHqwjr0LQlCxr3syVsAgIEAA==</eu:Data>\\n <eu:CertificateAlias>88812345678900001</eu:CertificateAlias>\\n</eu:AuthData>"
},
"keyStorePassword": {
"type": "string",
"description": "Password for keystore",
"example": "Heslo123"
},
"privateKeyPassword": {
"type": "string",
"description": "Password for private key",
"example": "Heslo123"
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"merchant": {
"id": 108,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 220,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 64,
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 116,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": {
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": null,
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 91,
"sequenceId": 208,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "224e49c8-394f-406d-8d1a-39a055bdbe6f",
"documentId": "80f270ae-2228-4ef0-9457-b260378010e8",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
},
"locationToFix": null,
"ok": true
}
}
},
"status": null
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"merchant": {
"$ref": "#/components/schemas/Merchant"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Report
GET /api/report/offline/oldest
Get oldest offline record
Description
Get oldest offline document or location
Response 500 Internal Server Error
Other responses
json
{
"documents": [
{
"type": "PD",
"externalId": "string",
"invoiceId": "string",
"merchant": {
"id": 95,
"corporateFullName": "string",
"ico": "string",
"dic": "string",
"icDph": "string",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Miletičova",
"buildingNumber": "4",
"propertyRegistrationNumber": "22",
"postalCode": "99999"
},
"organizationUnit": {
"name": "nepovinný názov predajne",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "PORTABLE",
"location": {
"internalId": 26,
"physicalAddress": null,
"gps": "Taxi SPZ ABC1234",
"other": "string",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"cashRegisterCode": "string",
"merchant": null,
"sendingCount": 232,
"status": {
"error": {
"errorType": "PRINT",
"errorCode": 170,
"message": "string",
"detail": "string"
},
"warning": {
"warningType": "PRINT",
"message": "string",
"detail": "string"
},
"documentToFix": null,
"locationToFix": null,
"ok": true
}
}
},
"status": null
},
"cashRegisterCode": "88812345678900001",
"amount": 236.23,
"issueDate": "2022-04-13T15:42:05.901Z",
"createDate": "2022-04-13T15:42:05.901Z",
"processDate": "2022-04-13T15:42:05.901Z",
"customer": {
"id": "string",
"customerIdType": "ICO",
"status": null
},
"paragonId": 25,
"sequenceId": 126,
"uuid": "O-544C525A6D5B47198C525A6D5BC",
"pkp": "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d",
"okp": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777",
"qrCode": "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23",
"documentEntries": [
{
"id": "63db38d1-fad2-4922-a9e0-6ecf1097f628",
"documentId": "2b6dcf6d-5fca-4125-8afb-52e64685f794",
"externalId": "string",
"referenceDocumentId": "string",
"type": "SALE",
"price": 10.12,
"quantity": 10.12,
"name": "string",
"totalPrice": 10.12,
"vatRate": "23%",
"seller": {
"id": "string",
"sellerIdType": "DIC"
},
"specialRegulation": "PDP",
"voucherNumber": "string",
"voucherRef": "string"
}
],
"vatRateSums": [
{
"title": "VAT_20",
"base": 100,
"vat": 20,
"sum": 120
}
],
"paymentTypes": {},
"header": "Header text",
"footer": "Footer text",
"exception": true,
"electronic": true,
"electronicReceipt": "string",
"documentNumber": "string",
"packingSum": 10.12,
"status": null
}
],
"locations": null,
"partialPrintInfo": {
"printedItemCount": 32,
"totalItemCount": 100,
"printerErrorResultCode": 105,
"printerErrorMessage": "No paper."
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"partialPrintInfo": {
"$ref": "#/components/schemas/PartialPrintInfo"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
POST /api/report/offline
Get offline report
Description
Get offline documents and locations report
Request body
json
{
"printer": {
"windowSize": 2500,
"printDelay": 5000
}
}
json
{
"limit": 10
}
json
{
"offlineDocumentsFilter": {
"sequenceId": 13,
"from": "27.08.2025 16:56:02",
"to": "03.09.2025 16:56:02"
}
}
json
{
"printer": {},
"offset": 70
}
Schema of the request body
json
{
"type": "object",
"properties": {
"offlineDocumentsFilter": {
"$ref": "#/components/schemas/OfflineDocumentsFilter"
},
"printer": {
"$ref": "#/components/schemas/Printer"
},
"offset": {
"minimum": 0,
"type": "integer",
"description": "How many documents to skip. Used when not all document were printed in previous request.",
"format": "int32",
"default": 0
},
"limit": {
"minimum": 1,
"type": "integer",
"description": "How many documents should be returned at most. Keep in mind, that the limit is applied before the filtration.",
"format": "int32",
"default": 10000
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"resultCode": 0,
"documents": [],
"locations": []
}
json
{
"resultCode": 0,
"documents": [
{
"type": "VK",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"cashRegisterCode": "88812345678900001",
"amount": 150,
"issueDate": "03.09.2025 16:56:01",
"createDate": "03.09.2025 16:56:01",
"processDate": "03.09.2025 16:56:01",
"sequenceId": 1,
"uuid": "O-A1B2C3D4E5F6000000123456789-TEST",
"pkp": "EjRWeJASNFra0KvN7xI0VniQq83vEjRWetrTRWeJEjRWeJEjRWetrQAGeJEjRWeJEjRWeAAARWSJcSNFZ4kSNFZ4kSNFZ4kVNFl4EjRWSJeqqqu7vMzN3d7v//EjRWeJEjRWeJEjRWeYC62u387yLtVfTvXvQV/q9Rrxpe8SxVAAVFRK2tpUQUFRUVUQgIgI4UUVEV8V8YVaVVtLVLQbW1RbFbFbuxvu8V7xXhX+FQUFUUUQVRBQWXl0kEAAAAAABUFFFRUSUhAAAAEjRWeJEjRWeJEjRWeJEjRlqJEjRWeJEjRdrYkSNFZ4kSNFZ4kSNK2trSNFZ5gSNFatraNFZw==",
"okp": "ABCDEFAB-12345678-12345678-12345678-ABCDEFAB",
"qrCode": "O-A1B2C3D4E5F6000000123456789-TEST",
"documentNumber": "202509/1"
}
],
"locations": [
{
"internalId": 100,
"other": "Taxi SPZ AB12345",
"createDate": "03.09.2025 16:56:01",
"cashRegisterCode": "88812345678900001",
"merchant": {
"id": 12,
"corporateFullName": "Company s.r.o.",
"ico": "123456789",
"dic": "SK123456789",
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
},
"organizationUnit": {
"name": "Optional organization unit name",
"cashRegisterCode": "88812345678900001",
"cashRegisterType": "STANDARD",
"location": {
"physicalAddress": {
"country": "Slovenská Republika",
"municipality": "Bratislava",
"street": "Heydukova",
"buildingNumber": "2155",
"propertyRegistrationNumber": "6",
"postalCode": "81108"
}
}
}
},
"sendingCount": 2
}
]
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseDocument"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"partialPrintInfo": {
"$ref": "#/components/schemas/PartialPrintInfo"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Printer
GET /api/printer
Get printer params
Description
Get printer parameters
Response 500 Internal Server Error
Other responses
json
{
"params": {
"numberOfCharsInRow": 48
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"params": {
"$ref": "#/components/schemas/ConnectedPrinterParams"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Settings
GET /api/settings/get
Get settings
Description
Retrieve app settings.
Response 500 Internal Server Error
Other responses
json
{
"appSettings": {
"connectTimeout": 4,
"readTimeout": 4,
"startingBlock": 71
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"appSettings": {
"$ref": "#/components/schemas/AppSettings"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
PUT /api/settings/store
Save settings
Description
Save app settings to persistent storage.
Request body
json
{
"appSettings": {
"connectTimeout": 4,
"readTimeout": 4,
"startingBlock": 38
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"type": "object",
"properties": {
"appSettings": {
"$ref": "#/components/schemas/AppSettings"
}
}
}
Response 500 Internal Server Error
Other responses
Status
GET /api/status/get
Get app status
Description
Retrieve current app status to check whether some action need to be done before storing any other data.
Response 500 Internal Server Error
Other responses
json
{
"appStatus": "OK",
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"appStatus": {
"type": "string",
"enum": [
"OK",
"DOCUMENT_STUCK",
"DOCUMENT_NOT_PRINTED"
]
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Version
GET /api/version
Get version
Description
Get information about the API and app version
Response 500 Internal Server Error
Other responses
json
{
"version": {
"appName": "eKasa",
"appVersion": "v1.2.30",
"apiVersion": "1.0.0"
},
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"version": {
"$ref": "#/components/schemas/VersionData"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Drawer
POST /api/drawer/open
Open cash drawer
Description
Request to generate a drawer pulse (only if printer allows it)
Request body
json
{
"printer": {
"windowSize": 2500,
"printDelay": 10000
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
json
{
"type": "object",
"properties": {
"printer": {
"$ref": "#/components/schemas/Printer"
}
}
}
Response 500 Internal Server Error
Other responses
json
{
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Image
POST /api/image/preview
Preview merchant logo
Description
Preview merchant image which might be printed on receipts
Request body
json
{
"imageData": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAADMSURBVFhH7ZRJDsMgDAD9id56zGP7jrwul76hkSOVUjBeMBQfOpJzCCIzWRR4LQauA8DXzILyxAr4FfECVmIKuMr3ozz9ea/EmoQ6gJNwaxKqgCQgJNyaBlvAflQSbk2DPqAh8Nw9YgqgCBHgwbd7AP+AKQHP+5ZGogp4f9UPuKkvUjIswBqRi3Fwv0QVgPREUPLuAMQS0ZK7ApBWRGtysUaOsAFIGaEdLWIAkv73irFi3lEKPXKkb9dAYgR4HmEPuS9WwOwQyhMjYCUnChgemKrC3ZUAAAAASUVORK5CYII=",
"fitOnReceipt": true,
"format": "BOTH"
}
json
{
"imageData": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAADMSURBVFhH7ZRJDsMgDAD9id56zGP7jrwul76hkSOVUjBeMBQfOpJzCCIzWRR4LQauA8DXzILyxAr4FfECVmIKuMr3ozz9ea/EmoQ6gJNwaxKqgCQgJNyaBlvAflQSbk2DPqAh8Nw9YgqgCBHgwbd7AP+AKQHP+5ZGogp4f9UPuKkvUjIswBqRi3Fwv0QVgPREUPLuAMQS0ZK7ApBWRGtysUaOsAFIGaEdLWIAkv73irFi3lEKPXKkb9dAYgR4HmEPuS9WwOwQyhMjYCUnChgemKrC3ZUAAAAASUVORK5CYII=",
"format": "PRINT"
}
json
{
"imageData": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAADMSURBVFhH7ZRJDsMgDAD9id56zGP7jrwul76hkSOVUjBeMBQfOpJzCCIzWRR4LQauA8DXzILyxAr4FfECVmIKuMr3ozz9ea/EmoQ6gJNwaxKqgCQgJNyaBlvAflQSbk2DPqAh8Nw9YgqgCBHgwbd7AP+AKQHP+5ZGogp4f9UPuKkvUjIswBqRi3Fwv0QVgPREUPLuAMQS0ZK7ApBWRGtysUaOsAFIGaEdLWIAkv73irFi3lEKPXKkb9dAYgR4HmEPuS9WwOwQyhMjYCUnChgemKrC3ZUAAAAASUVORK5CYII=",
"format": "ELECTRONIC"
}
Schema of the request body
json
{
"type": "object",
"properties": {
"imageData": {
"type": "string",
"description": "Image data. Use null remove the current image.",
"format": "BASE64"
},
"fitOnReceipt": {
"type": "boolean",
"description": "If set to true, the preview will be generated with the receipt with, so the user can see how the image will look on the paper or electronic receipt.",
"format": "boolean",
"default": false
},
"format": {
"type": "string",
"description": "Defines which previews should be generated. PRINT, ELECTRONIC, or BOTH.",
"format": "enumeration",
"default": "PRINT",
"enum": [
"PRINT",
"ELECTRONIC",
"BOTH"
]
}
}
}
Response 200 OK
json
{
"resultCode": 0,
"printedLogoData": "iVBORw0KGgoAAAANSUhEUgAAAkAAAAAgAQAAAADSivroAAAAr0lEQVR4XtXVsQkCURBF0QXNtYMtYUvY0jRbMDE0HKzEErQFQTDdcBVxzN9/wQ0+HzzhC24402UlnQ6lKfOuW6llKDJfupVahhgSeh51MUjoGroYJDRtdDFI6DToYpBQ9LoYJHQZdTFIKHa6GCSE/Glo0cEAoTnfOhkkND50MkBoiZtOBgh9hoNOBgh9t2edDBDK9UoXg4T2tc7I3OtikBDSMhS13lHUClV72dVCzA8CJOQrFK5viQAAAABJRU5ErkJggg==",
"electronicLogoData": "iVBORw0KGgoAAAANSUhEUgAAAYwAAAB2CAYAAADbR6SBAAACJklEQVR4Xu3aMU7DMABA0VyCjZHDcg5Ox8IZglIVGkKEPh7j9yQPseXN7VfcLisABMtxAgDOCAYAiWAAkAgGAIlgAJAIBgCJYACQCAYAiWAAkAgGAIlgAJAIBgCJYACQCAYAiWAAkAgGAIlgAJAIBgCJYACQCAYAiWAAkAgGAIlgAJAIBgCJYACQCAYAiWAAkAgGAIlgAJAIBlNaluU2/mNkD1yJ08+URr/4R/fBFTj9ACSCAXf7t4fb9dPb+24VEAxYfwfi+AwIBtwcf5s4PgOCAUAkGAAkgsHUtqunj+eX4/S3be2vdZiJYDC1LRivy9NpFL5isa0DggE/orEf25xYwINgwHr/G+3JAB58IgBIBIMpjb49jO6DK3D6mdLIldPIHrgSpx+ARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOARDAASAQDgEQwAEgEA4BEMABIBAOA5BNo+/1j8WR0rQAAAABJRU5ErkJggg=="
}
json
{
"resultCode": 0,
"printedLogoData": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQAAAABbAUdZAAAAZ0lEQVR4XmP4DwQM7f//P4QQ8////wkhwBL/n/cDifPzgUQ7P5CYrg8k5ssDif32IFb9f6g6JOLHf4YP/38BCfsn/xl+zL/wn+GPftd/hn8CC4GyLMxAogFk1AeQKXBtCHsRbgFJAADtbmwzR1+DpwAAAABJRU5ErkJggg=="
}
json
{
"resultCode": 0,
"electronicLogoData": "iVBORw0KGgoAAAANSUhEUgAAAEwAAABhCAYAAAB8pUfDAAABVklEQVR4Xu3XQUrEMABA0V7CnUsP6zk8nRvPoGRgpBQZ+KWYDLwHWTQhpPNpFrN9k2zHCR4TLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLJoWbNu22yjO7LnatNPP/vCz+64y9/QntFSw/ddzu34fn7vVNSwT7Bjo+LyKpYI9el7Fmm+1MMGi6cHG1ft6fTtO/xprj9b/2xLB3reXP6PcY431VUwPNuyj7ceYWynWsESw4f635zhWs94bLW5asLNfz9l9V5l2+pkrd2bP1eae/oQEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIsEiwSLBIt+AJ6PUHe3MoB1AAAAAElFTkSuQmCC"
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"printedLogoData": {
"type": "string"
},
"electronicLogoData": {
"type": "string"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 500 Internal Server Error
json
{
"resultCode": 701,
"error": "java.lang.IllegalArgumentException: Unsupported format"
}
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"error": {
"type": "string",
"description": "More detailed text description of the error. Do not use this field to retrieve the API call result, use the `resultCode` instead. This field has an informative character and its main purpose is to better identify the error reason. This field should be logged."
},
"ekasaStatus": {
"$ref": "#/components/schemas/EkasaStatus"
}
}
}
POST /api/print
Print string
Description
Print custom string data. These data will be stored in the CHDU memory.
Request body
json
{
"printData": "Print data"
}
json
{
"printData": " Daily statement \n--------------------------------\n \nTotal sales: 37\nTotal item count: 70\nTotal cost: 468.50 EUR\n--------------------------------"
}
Schema of the request body
json
{
"required": [
"printData"
],
"type": "object",
"properties": {
"printData": {
"type": "string",
"description": "Raw data in string for printing",
"example": "Daily statement."
},
"printer": {
"$ref": "#/components/schemas/Printer"
}
}
}
Response 200 OK
json
{
"meta": {
"resultCode": 0,
"warning": "string"
},
"rawData": "string",
"warning": "string",
"resultCode": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
json
{
"required": [
"resultCode"
],
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
},
"rawData": {
"type": "string"
},
"warning": {
"type": "string",
"description": "Filled only if any warning"
},
"resultCode": {
"type": "integer",
"description": "Request result code. `0` = OK; `-1` = Unknown error; for values greater than zero see result code list.",
"format": "int32",
"example": 0
}
}
}
Response 500 Internal Server Error
Schemas
AppSettings
| Name | Type |
|---|---|
connectTimeout |
integer(int32)| null |
readTimeout |
integer(int32)| null |
startingBlock |
integer(int32) |
BlockStorageInfo
| Name | Type |
|---|---|
blockSize |
integer(int64) |
totalBlocks |
integer(int64) |
writtenBlocks |
integer(int64) |
Cash
| Name | Type |
|---|---|
amount |
number |
cashRegisterCode |
string |
createDate |
string(date-time) |
documentNumber |
string |
documentType |
string |
electronic |
boolean |
exception |
boolean |
internalDocumentId |
integer(int32) |
issueDate |
string(date-time) |
merchant |
Merchant |
okp |
string |
pkp |
string |
processDate |
string(date-time) |
qrCode |
string |
sequenceId |
integer(int32) |
status |
EkasaStatus |
uuid |
string |
CashRequest
| Name | Type |
|---|---|
amount |
number |
exception |
boolean |
externalId |
string |
openDrawer |
boolean |
printer |
Printer |
CashResponse
| Name | Type |
|---|---|
cash |
Cash |
printResultCode |
integer(int32)| null |
resultCode |
integer(int32) |
warning |
string |
CertificateStatusResponse
| Name | Type |
|---|---|
resultCode |
integer(int32) |
status |
MerchantCertificateStatus |
warning |
string |
ChduInfoResponse
| Name | Type |
|---|---|
params |
ChduParams |
resultCode |
integer(int32) |
storageInfo |
BlockStorageInfo |
warning |
string |
ChduParams
| Name | Type |
|---|---|
name |
string |
sn |
string |
version |
string |
ConnectedPrinterParams
| Name | Type |
|---|---|
numberOfCharsInRow |
integer(int32) |
Customer
| Name | Type |
|---|---|
customerIdType |
string |
id |
string |
status |
EkasaStatus |
DocumentByExternalId
| Name | Type |
|---|---|
externalId |
string |
DocumentByInternalId
| Name | Type |
|---|---|
internalId |
integer(int32) |
DocumentByOkp
| Name | Type |
|---|---|
okp |
string |
DocumentByPkp
| Name | Type |
|---|---|
pkp |
string |
DocumentBySequenceId
| Name | Type |
|---|---|
month |
integer(int32) |
sequenceId |
integer(int32) |
year |
integer(int32) |
DocumentByUUID
| Name | Type |
|---|---|
uuid |
string |
DocumentItem
| Name | Type |
|---|---|
documentId |
string(uuid) |
externalId |
string |
id |
string(uuid) |
name |
string |
price |
number |
quantity |
number |
referenceDocumentId |
string |
seller |
Seller |
specialRegulation |
string |
totalPrice |
number |
type |
string |
vatRate |
string |
voucherNumber |
string |
voucherRef |
string |
DocumentReceiptItem
| Name | Type |
|---|---|
externalId |
string |
itemType |
string |
name |
string |
price |
number |
quantity |
number |
referenceDocumentId |
string |
seller |
Seller |
specialRegulation |
string |
vatRate |
string |
voucherNumber |
string |
DocumentResponse
| Name | Type |
|---|---|
document |
ResponseDocument |
documents |
Array<ResponseDocument> |
printResultCode |
integer(int32)| null |
resultCode |
integer(int32) |
warning |
string |
EkasaError
| Name | Type |
|---|---|
detail |
string |
errorCode |
integer(int32) |
errorType |
string |
message |
string |
EkasaStatus
| Name | Type |
|---|---|
documentToFix |
ResponseDocument |
error |
EkasaError |
locationToFix |
Location |
ok |
boolean |
warning |
EkasaWarning |
EkasaWarning
| Name | Type |
|---|---|
detail |
string |
message |
string |
warningType |
string |
ErrorResponse
| Name | Type |
|---|---|
ekasaStatus |
EkasaStatus |
error |
string |
resultCode |
integer(int32) |
warning |
string |
FixDocument
| Name | Type |
|---|---|
createDate |
string(date-time) |
customer |
Customer |
documentEntries |
Array<FixDocumentItem> |
invoiceId |
string |
issueDate |
string(date-time) |
useLastMerchant |
boolean |
FixDocumentItem
| Name | Type |
|---|---|
name |
string |
quantity |
number |
referenceDocumentId |
string |
seller |
Seller |
specialRegulationChange |
SpecialRegulationChange |
vatRate |
string |
voucherNumber |
string |
FixLocation
| Name | Type |
|---|---|
createDate |
string(date-time) |
gps |
Gps |
other |
string |
physicalAddress |
PhysicalAddress |
useLastMerchant |
boolean |
GenericResponse
| Name | Type |
|---|---|
resultCode |
integer(int32) |
warning |
string |
GetDocumentRequest
| Name | Type |
|---|---|
documentByExternalId |
DocumentByExternalId |
documentByInternalId |
DocumentByInternalId |
documentByOkp |
DocumentByOkp |
documentByPkp |
DocumentByPkp |
documentBySequenceId |
DocumentBySequenceId |
documentByUUID |
DocumentByUUID |
offlineDocuments |
boolean |
printer |
Printer |
GetMerchantRequest
| Name | Type |
|---|---|
merchantByCashRegisterCode |
MerchantByCashRegisterCode |
merchantBySequenceId |
MerchantBySequenceId |
GetOfflineDocumentsRequest
| Name | Type |
|---|---|
limit |
integer(int32) |
offlineDocumentsFilter |
OfflineDocumentsFilter |
offset |
integer(int32) |
printer |
Printer |
Gps
| Name | Type |
|---|---|
x |
number |
y |
number |
Location
| Name | Type |
|---|---|
cashRegisterCode |
string |
createDate |
string(date-time) |
gps |
Gps |
internalId |
integer(int32) |
merchant |
Merchant |
other |
string |
physicalAddress |
PhysicalAddress |
processDate |
string(date-time) |
sendingCount |
integer(int32) |
status |
EkasaStatus |
LocationResponse
| Name | Type |
|---|---|
location |
Location |
resultCode |
integer(int32) |
warning |
string |
LogoPreviewResponse
| Name | Type |
|---|---|
electronicLogoData |
string |
printedLogoData |
string |
resultCode |
integer(int32) |
warning |
string |
Merchant
| Name | Type |
|---|---|
corporateFullName |
string |
dic |
string |
icDph |
string |
ico |
string |
id |
integer(int32) |
organizationUnit |
OrganizationUnit |
physicalAddress |
PhysicalAddress |
status |
EkasaStatus |
MerchantByCashRegisterCode
| Name | Type |
|---|---|
cashRegisterCode |
string |
MerchantBySequenceId
| Name | Type |
|---|---|
id |
integer(int32) |
MerchantCertificateStatus
| Name | Type |
|---|---|
expirationDate |
string(date-time) |
status |
string |
MerchantResponse
| Name | Type |
|---|---|
merchant |
Merchant |
resultCode |
integer(int32) |
warning |
string |
OfflineDocumentsFilter
| Name | Type |
|---|---|
from |
string(date-time) |
sequenceId |
integer(int32) |
to |
string(date-time) |
OfflineReportResponse
| Name | Type |
|---|---|
documents |
Array<ResponseDocument> |
locations |
Array<Location> |
partialPrintInfo |
PartialPrintInfo |
resultCode |
integer(int32) |
warning |
string |
OpenDrawerRequest
| Name | Type |
|---|---|
printer |
Printer |
OrganizationUnit
| Name | Type |
|---|---|
cashRegisterCode |
string |
cashRegisterType |
string |
location |
Location |
name |
string |
PartialPrintInfo
| Name | Type |
|---|---|
printedItemCount |
integer(int32) |
printerErrorMessage |
string |
printerErrorResultCode |
integer(int32) |
totalItemCount |
integer(int32) |
PhysicalAddress
| Name | Type |
|---|---|
buildingNumber |
string |
country |
string |
municipality |
string |
postalCode |
string |
propertyRegistrationNumber |
string |
street |
string |
PreviewImageRequest
| Name | Type |
|---|---|
fitOnReceipt |
boolean(boolean) |
format |
string(enumeration) |
imageData |
string(BASE64) |
Printer
| Name | Type |
|---|---|
printDelay |
integer(int64) |
windowSize |
integer(int32) |
PrinterResponse
| Name | Type |
|---|---|
params |
ConnectedPrinterParams |
resultCode |
integer(int32) |
warning |
string |
PrintStringRequest
| Name | Type |
|---|---|
printData |
string |
printer |
Printer |
RawResponse
| Name | Type |
|---|---|
meta |
ResponseMeta |
rawData |
string |
resultCode |
integer(int32) |
warning |
string |
ResponseDocument
| Name | Type |
|---|---|
amount |
number |
cashRegisterCode |
string |
createDate |
string(date-time) |
customer |
Customer |
documentEntries |
Array<DocumentItem> |
documentNumber |
string |
electronic |
boolean |
electronicReceipt |
string |
exception |
boolean |
externalId |
string |
footer |
string |
header |
string |
invoiceId |
string |
issueDate |
string(date-time) |
merchant |
Merchant |
okp |
string |
packingSum |
number |
paragonId |
integer(int32) |
paymentTypes |
|
pkp |
string |
processDate |
string(date-time) |
qrCode |
string |
sequenceId |
integer(int32) |
status |
EkasaStatus |
type |
string |
uuid |
string |
vatRateSums |
Array<VatRateSum> |
ResponseMeta
| Name | Type |
|---|---|
resultCode |
integer(int32) |
warning |
string |
Seller
| Name | Type |
|---|---|
id |
string |
sellerIdType |
string |
SendOfflineRequest
| Name | Type |
|---|---|
limit |
integer(int32) |
SettingsResponse
| Name | Type |
|---|---|
appSettings |
AppSettings |
resultCode |
integer(int32) |
warning |
string |
SpecialRegulationChange
| Name | Type |
|---|---|
newValue |
string |
StatusResponse
| Name | Type |
|---|---|
appStatus |
string |
resultCode |
integer(int32) |
warning |
string |
StoreDocumentRequest
| Name | Type |
|---|---|
amount |
number |
documentEntries |
Array<DocumentReceiptItem> |
electronicReceipt |
boolean |
exception |
boolean |
externalId |
string |
footer |
string |
header |
string |
invoiceId |
string |
openDrawer |
boolean |
paragonDate |
string(date-time) |
paragonNumber |
integer(int32) |
payments |
|
printer |
Printer |
type |
string |
StoreImageRequest
| Name | Type |
|---|---|
imageData |
string(BASE64) |
StoreMerchantRequest
| Name | Type |
|---|---|
authenticationData |
string |
identificationData |
string |
keyStorePassword |
string |
privateKeyPassword |
string |
StoreSettingsRequest
| Name | Type |
|---|---|
appSettings |
AppSettings |
UpdateDocumentRequest
| Name | Type |
|---|---|
fixDocument |
FixDocument |
UpdateLocationRequest
| Name | Type |
|---|---|
fixLocation |
FixLocation |
gps |
Gps |
other |
string |
physicalAddress |
PhysicalAddress |
VatRateSum
| Name | Type |
|---|---|
base |
number |
sum |
number |
title |
string |
vat |
number |
VersionData
| Name | Type |
|---|---|
apiVersion |
string |
appName |
string |
appVersion |
string |
VersionResponse
| Name | Type |
|---|---|
resultCode |
integer(int32) |
version |
VersionData |
warning |
string |