API
Search…
Base Sales Report

Base Sales Report schema

Simplified JSON response

1
{
2
"created": <timestamp>,
3
"from": <timestamp>,
4
"to": <timestamp>,
5
"registerName": <string>,
6
"moneyTransactionInfo": {
7
"saleCount": <integer>,
8
"saleValue": <double>,
9
"rawSaleValue": <double>,
10
"cancelCount": <integer>,
11
"cancelValue": <double>,
12
"rawCancelValue": <double>,
13
"cashAdvanceCount": <integer>,
14
"cashAdvanceValue": <double>,
15
"rawCashAdvanceValue": <double>,
16
"cashInCount": <integer>,
17
"cashInValue": <double>,
18
"rawCashInValue": <double>,
19
"cashOutCount": <integer>,
20
"cashOutValue": <double>,
21
"rawCashOutValue": <double>
22
},
23
"revenue": {
24
"totalWithVat": <double>,
25
"totalVat": <double>,
26
"totalWithoutVat": <double>,
27
"vatInfo": [ ... ],
28
"paymentTypeInfo": [ ... ]
29
},
30
"discounts": [ ... ],
31
"cashInOutTransactions": [ ... ],
32
"categorySales": [ ... ],
33
"productSales": [ ... ],
34
"tagSales": [ ... ],
35
"employeeSales": [ ... ],
36
"customerSales": [ ... ],
37
"proxySales": [ ... ],
38
"takeawaySales": [ ... ],
39
"fiscalizationSales": [ ... ],
40
"receiptInfo": [ ... ],
41
"employeePayments": [ ... ]
42
}
Copied!

Field descriptions

created timestamp Report created date and time
from timestamp Report start date and time
to timestamp Report end date and time
registerName string Branch name
moneyTransactionInfo.saleCount integer Money transactions - sales count
moneyTransactionInfo.saleValue double Money transactions - sales value
moneyTransactionInfo.rawSaleValue double Money transactions - sales value in alternative currency
moneyTransactionInfo.cancelCount integer Money transactions - cancelled count
moneyTransactionInfo.cancelValue double Money transactions - cancelled value
moneyTransactionInfo.rawCancelValue double Money transactions - cancelled value in alternative currency
moneyTransactionInfo.cashAdvanceCount integer Money transactions - cash advance count
moneyTransactionInfo.cashAdvanceValue double Money transactions - cash advance value
moneyTransactionInfo.rawCashAdvanceValue double Money transactions - cash advance value in alternative currency
moneyTransactionInfo.cashInCount integer Money transactions - cash in count
moneyTransactionInfo.cashInValue double Money transactions - cash in value
moneyTransactionInfo.rawCashInValue double Money transactions - cash in value in alternative currency
moneyTransactionInfo.cashOutCount integer Money transactions - cash out count
moneyTransactionInfo.cashOutValue double Money transactions - cash out value
moneyTransactionInfo.rawCashOutValue double Money transactions - cash out value in alternative currency
revenue.totalWithVat double Revenue - total value with VAT
revenue.totalVat double Revenue - total VAT value
revenue.totalWithoutVat double Revenue - total value without VAT
revenue.vatInfo.rate double Revenue - VAT rate
revenue.vatInfo.base double Revenue - VAT base value
revenue.vatInfo.value double Revenue - VAT value
revenue.vatInfo.special double Revenue - VAT special
revenue.paymentTypeInfo.typeId integer Revenue - payment type id
revenue.paymentTypeInfo.count integer Revenue - count for the payment type
revenue.paymentTypeInfo.total double Revenue - total value for the payment type
revenue.paymentTypeInfo.rawTotal double Revenue - total value for the payment type in alternative currency
revenue.paymentTypeInfo.currency string Revenue - alternative currency for the rawTotal
discounts.employee.name string Discounts - employee name
discounts.employee.id long Discounts - employee ID
discounts.count integer Discounts - count
discounts.value double Discounts - value
discounts.valueWithoutVat double Discounts - value without VAT
cashInOutTransactions.id long Cash in/out transactions - money log ID
cashInOutTransactions.dir boolean Cash in/out transactions - always false (unused)
cashInOutTransactions.created timestamp Cash in/out transactions - money log created
cashInOutTransactions.employee.name string Cash in/out transactions - employee name
cashInOutTransactions.employee.id long Cash in/out transactions - employee ID
cashInOutTransactions.value double Cash in/out transactions - money log value
cashInOutTransactions.note string Cash in/out transactions - money log note
categorySales.value double Sales by category - value
categorySales.valueWithoutNonPurchase double Sales by category - value without non purchase
categorySales.purchaseValue double Sales by category - purchase value
categorySales.valueWithoutVAT double Sales by category - value without VAT
categorySales.valueWithoutNonPurchaseWithoutVAT double Sales by category - value without non purchase without VAT
categorySales.purchaseValueWithoutVAT double Sales by category - purchase value without VAT
categorySales.id long Sales by category - category ID
categorySales.name string Sales by category - category name
productSales.value double Sales by product - value
productSales.valueWithoutNonPurchase double Sales by product - value without non purchase
productSales.purchaseValue double Sales by product - purchase value
productSales.valueWithoutVAT double Sales by product - value without VAT
productSales.valueWithoutNonPurchaseWithoutVAT double Sales by product - value without non purchase without VAT
productSales.purchaseValueWithoutVAT double Sales by product - purchase value without VAT
productSales.id long Sales by product - product ID
productSales.name string Sales by product - product name
productSales.count integer Sales by product - items count
productSales.unit enum Sales by product - item units
productSales.categoryId long Sales by product - category ID
tagSales.value double Sales by tag - value
tagSales.valueWithoutNonPurchase double Sales by tag - value without non purchase
tagSales.purchaseValue double Sales by tag - purchase value
tagSales.valueWithoutVAT double Sales by tag - value without VAT
tagSales.valueWithoutNonPurchaseWithoutVAT double Sales by tag - value without non purchase without VAT
tagSales.purchaseValueWithoutVAT double Sales by tag - purchase value without VAT
tagSales.name string Sales by tag - tag name
employeeSales.value double Sales by employee - value
employeeSales.valueWithoutNonPurchase double Sales by employee - value without non purchase
employeeSales.purchaseValue double Sales by employee - purchase value
employeeSales.valueWithoutVAT double Sales by employee - value without VAT
employeeSales.valueWithoutNonPurchaseWithoutVAT double Sales by employee - value without non purchase without VAT
employeeSales.purchaseValueWithoutVAT double Sales by employee - purchase value without VAT
employeeSales.id long Sales by employee - employee ID
employeeSales.name string Sales by employee - employee name
customerSales.value double Sales by customer - value
customerSales.valueWithoutNonPurchase double Sales by customer - value without non purchase
customerSales.purchaseValue double Sales by customer - purchase value
customerSales.valueWithoutVAT double Sales by customer - value without VAT
customerSales.valueWithoutNonPurchaseWithoutVAT double Sales by customer - value without non purchase without VAT
customerSales.purchaseValueWithoutVAT double Sales by customer - purchase value without VAT
customerSales.id long Sales by customer - customer ID
customerSales.name string Sales by customer - customer name
proxySales.value double Sales by EET subject - value
proxySales.valueWithoutNonPurchase double Sales by EET subject - value without non purchase
proxySales.purchaseValue double Sales by EET subject - purchase value
proxySales.valueWithoutVAT double Sales by EET subject - value without VAT
proxySales.valueWithoutNonPurchaseWithoutVAT double Sales by EET subject - value without non purchase without VAT
proxySales.purchaseValueWithoutVAT double Sales by EET subject - purchase value without VAT
proxySales.id long Sales by EET subject - EET subject ID
proxySales.name string Sales by EET subject - EET subject name
takeawaySales.value double Sales by take-away/eat-in - value
takeawaySales.valueWithoutNonPurchase double Sales by take-away/eat-in - value without non purchase
takeawaySales.purchaseValue double Sales by take-away/eat-in - purchase value
takeawaySales.valueWithoutVAT double Sales by take-away/eat-in - value without VAT
takeawaySales.valueWithoutNonPurchaseWithoutVAT double Sales by take-away/eat-in - value without non purchase without VAT
takeawaySales.purchaseValueWithoutVAT double Sales by take-away/eat-in - purchase value without VAT
takeawaySales.id integer Sales by take-away/eat-in - 1 = take-away, 0 = eat-in
fiscalizationSales.value double Sales by fiscalization - value
fiscalizationSales.valueWithoutNonPurchase double Sales by fiscalization - value without non purchase
fiscalizationSales.purchaseValue double Sales by fiscalization - purchase value
fiscalizationSales.valueWithoutVAT double Sales by fiscalization - value without VAT
fiscalizationSales.valueWithoutNonPurchaseWithoutVAT double Sales by fiscalization - value without non purchase without VAT
fiscalizationSales.purchaseValueWithoutVAT double Sales by fiscalization - purchase value without VAT
fiscalizationSales.id integer Sales by fiscalization - 1 = fiscalization required, 0 = not required
receiptInfo.type string Order items - item type: "cancelled", "cancellation", "unpaid", "total"
receiptInfo.value double Order items - value of items of the given type
receiptInfo.count integer Order items - count of items of the given type
employeePayments.employeeId long Payments by employee - Employee ID
employeePayments.employeeName string Payments by employee - Employee name
employeePayments.paymentMethodId integer Payments by employee - Payment method ID
employeePayments.count integer Payments by employee - Count of payments
employeePayments.total double Payments by employee - Total value of payments
employeePayments.rawTotal double Payments by employee - Total value of payments in alternative currency
employeePayments.currency string Payments by employee - Alternative currency for the rawTotal
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/branches/:branchId/sales-report
Generate the base sales report
Last modified 5mo ago