ResponseDocument
Document representation in response message.
Properties
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
type |
string (PD | UF | ND | VY | VK) |
Document type enumeration: - PD: Standard (pokladnicny doklad)- UF: Invoice (uhrada faktury)- ND: Invalid document used for testing purposes (neplatny dokument)- VY: Cash withdrawal (vyber)- VK: Cash deposit (vklad) |
||
externalId |
string | External custom id | ||
invoiceId |
string | Invoice Id | ||
merchant |
Merchant | Data of the stored merchant | ||
cashRegisterCode |
string | Cash register code | "88812345678900001" |
|
amount |
number | Amount of receipt | 236.23 |
|
issueDate |
string (date-time) | Date of issuing receipt. This is NOT equal with createDate only for paragon document | ||
createDate |
string (date-time) | Date of creation in ekasa | ||
processDate |
string (date-time) | Process datetime of receipt on eKasa. Not present if offline receipt | ||
customer |
Customer | Customer id if added. | ||
paragonId |
integer (int32) | Paragon id is generated in sequence for each paragon. | ||
sequenceId |
integer (int32) | Sequence id. Restarted by every month starting of 1 in sequence | ||
uuid |
string | Receipt UUID generated by eKasa. Not present if offline receipt | "O-544C525A6D5B47198C525A6D5BC" |
|
pkp |
string | Pkp printed on receipt | "ZRvwrY1m0/lGyJaFSQd87GTXV/3+X/fRRw4j0ndyYfjJlujvWPeYXzdkBanV\\r\\n93Jz9aPlUfckYxTvJ5LRvxBlPVN947oo8QQth4UulkBtVdK++4GBk0gkPxb7\\r\\nBueGHps0liogyYexb3Yz3wa7R6IkbFAq5BLVxtO4hMNk+r4gqa9/+cvJbdvn\\r\\nGwzWzsxaHvav6dWiJXCiEcR2mA8N7RYiBN0hiCrIbKmzoi1bYrVsm7sy2ZWh\\r\\nL/Api7TupZhQCkHK+oqgAtcU4Zmw9AC1JekvSW7eIa/NKVKNdAsrMAXQ6DKF\\r\\nLw2WYq6LcramkaG3INBOEfwV5HkuondeOpKAAr1aNw\\u003d\\u003d" |
|
okp |
string | OKP printed on receipt | "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777" |
|
qrCode |
string | Qr code printed on receipt | "ED5592BF-19DB7396-19546BE7-7DC20E0A-75BB0777:88812345678900001:220212222223:11:236.23" |
|
documentEntries |
array[DocumentItem] | List of receipt items | ||
vatRateSums |
array[VatRateSum] | Vat rate sums listed on document receipt | ||
paymentTypes |
object | Payment types and sums used for receipt payment | ||
header |
string | Custom header to print at the top of the receipt | "Header text" |
|
footer |
string | Custom footer to print at the bottom of the receipt | "Footer text" |
|
exception |
boolean | If this document has exception to send offline receipts later | ||
electronic |
boolean | If receipt is going to be sent electronically | ||
electronicReceipt |
string | Electronic receipt as bitmap in BASE64 encoding | ||
documentNumber |
string | Formatted document number | ||
packingSum |
number | Sum of all packing and packing refund items, which were omitted from VAT table. Present if such items exist. | ||
status |
EkasaStatus | A status describing that the request hasn't been processed as it should be |