๐จ๏ธFiscals
This page provides a description of the available API routes for managing fiscal devices.
Last updated
This page provides a description of the available API routes for managing fiscal devices.
Last updated
Fiscal device refers to receipt printer that prints cash register receipts (part of ticket closing procedure).
Fiscal device is represented by Fiscal
class.
These API methods allow for the management of fiscal resources, including creation, reading, updating, and deletion.
GET
http://{server-address}/fiscals
Returns all fiscals that matches query parameters. Result is of type QueryResult<Fiscal>
.
Name | Type | Description |
---|---|---|
GET
http://{server-address}/fiscals/{name}
Result is of type Fiscal.
POST
http://{server-address}/fiscals
Creates new fiscal. Result is of type Fiscal.
Required rights
Authorized user must have FiscalCreate
right assigned.
PUT
http://{server-address}/fiscals/{name}
Creates new or updates existing fiscal. Result is of type Fiscal.
Required rights
Authorized user must have assigned FiscalCreate
or FiscalUpdate
right.
DELETE
http://{server-address}/fiscals/{name}
Required rights
Authorized user must have FiscalDelete
right assigned.
These API methods trigger specific actions on fiscal devices. However, it's important to note that depending on the type of fiscal device, some methods may not be supported. Additionally, attempting an action on a fiscal device that is marked as inactive will also result in failure. In both of these cases, making API calls will result in an HTTP status code of 403.
POST
http://{server-address}/fiscals/{name}/open_drawer
Opens cash drawer on specified device.
Required rights
Authorized user must have FiscalOpenDrawer
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/cash_transfer
This method performs a cash transfer operation on a fiscal device specified by name. It updates the latest daily sales report for the device or creates a new report if none is currently opened. The updated daily sales report is then returned in the response body.
The method accepts CashTransfer
in request body.
Required rights
Authorized user must have FiscalCashTransfer
right assigned.
POST
http://{server-address}/fiscals/{name}/print_record_copy
Prints copy of specified ticket on fiscal printer. Method accepts RecordCopyContext
in request body.
Required rights
Authorized user must have FiscalPrintRecordCopy
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_last_record_copy
Prints copy of last ticket printed on fiscal printer.
Required rights
Authorized user must have FiscalPrintRecordCopy
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_overview_sales_report
Prints overview sales report on specified fiscal printer.
The overview sales report ("Priebeลพnรก uzรกvierka", "Prehฤพadovรก uzรกvierka" or "X uzรกvierka" in Slovak) includes financial information on sales from the last daily sales report.
Required rights
Authorized user must have OverviewSalesReport
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_summary_interval_sales_report
Prints summary interval sales report on specified fiscal printer. The generated report consolidates financial information extracted from multiple daily sales reports.
The method accepts IntervalSalesReportContext
in request body.
Required rights
Authorized user must have SummaryIntervalSalesReport
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_detailed_interval_sales_report
Prints detailed interval sales report on specified fiscal printer. The generated report consolidates financial information extracted from multiple daily sales reports.
The method accepts IntervalSalesReportContext
in request body.
Required rights
Authorized user must have DetailedIntervalSalesReport
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/daily_sales_report
Performs daily sales closure and prints daily sales report on specified fiscal printer. DailySalesReport
is returned in response body. It's important to note that certain fiscal devices only support one daily sales report per day, while other types of fiscal devices allow multiple closures to be performed within the same day.
Required rights
Authorized user must have DoDailySalesReport
right assigned.
POST
http://{server-address}/fiscals/{name}/daily_sales_report_copy
Prints copy of daily sales report associated with given fiscal printer. Method accepts DailySalesReportCopyContext
in request body.
Required rights
Authorized user must have FiscalPrintDailySalesReportCopy
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/last_daily_sales_report_copy
Prints copy of last daily sales report associated with given fiscal printer.
Required rights
Authorized user must have FiscalPrintDailySalesReportCopy
right assigned.
The response body contains no content.
POST
http://{server-address}/fiscals/{name}/print_nonfiscal_record
Prints text (nonfiscal record) on selected fiscal device. Method accepts NonfiscalRecordContext
in request body.
Required rights
Authorized user must have PrintNonfiscalRecord
right assigned.
The response body contains no content.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|